Download Instructions

Lark Router has been designed to take advantage of Docker containerization. Allowing it to run wherever you install Docker.

Docker is a well maintained and documented containerization solution; many IT organizations are already running Docker. We recommend you discuss with your IT or Networking teams as there are many ways to Implement Docker. For more information visit Docker at https://www.docker.com/get-started

Once Docker is available, there are two main options for installing Lark Router:

Docker Hub

For experienced Docker users Lark Router is available on the Docker Hub, You will need your Docker Hub account to access images. The latest information is always available at https://hub.docker.com/r/skycore/larkd . There you will see recommendations and all necessary information for installing Lark Router.

Once complete you can go to the local URL and port 8000 (Http: http://127.0.0.1:8000) to login and start configuring Lark Router.

User Name: admin
Password: s3r4ts

Simplified Instructions

To simplify implementation on Linux and Windows systems we have provided the YAML files using standard values (port configurations, data storage locations, etc.) below.

Step 1:

Save the appropriate Docker-compose.yaml file to a folder on your computer (ie. larkd\)

If using Linux, save the variables file to the same folder

Step 2:

You need to accept our Terms and Conditions which can be found here: https://www.larkrouter.com/license/

  • Windows: You must edit the Docker-Compose.yaml file and change no to yes.
    • ACCEPT_EULA=no
  • Linux: You must edit the variables.env file change no to yes
    • ACCEPT_EULA=no

Step 3:

Open your shell program (ie. BASH for Linux or Powershell for Windows).

Step 4:

Change directory to where you saved your YAML file.

Step 5:

Run the command docker-compose up -d

Step 6:

To terminate Lark Router run the command docker-compose down.

Step 7:

Once complete you can go to the local URL and port 8000 (Http: http://127.0.0.1:8000) to login and start configuring Lark Router.

User Name: admin
Password: s3r4ts

We have provided a list of other useful docker commands here: Useful Docker Commands