Thank you for your interest in Lanbassador! At this time, the only available and recommended installation method is using Docker Compose.

🐋 Deployment with Docker Compose (recommended)

Before starting, you'll need a few requirements first.

🗒️ Requirements

• A Linux box (this should work with other *NIXes, but this was only tested under Linux)
• An active internet connection (during first setup)
• Docker daemon
• Docker Compose

If you are using Debian 12 and later, you can use the following commands to install the dependencies:

# apt-get install docker.io docker-compose

💾 Obtaining the sources

Once you're ready to obtain the sources, it is recommended to create an empty directory for Lanbassador. You should use the name lanbassador, in lowercase:

$ mkdir lanbassador
$ cd lanbassador

Next, save the sample Docker Compose file from the official Lanbassador repository, and place it in the newly created directory. Alternatively, copy its contents and save it to a new file called docker-compose.yaml:

$ wget https://git.luca0n.com/luca0N/lanbassador/raw/branch/main/docker-compose.yaml

✏️ Setting the Lanbassador preferences

Now, it's time to specify which NIC Lanbassador should listen on. If you are not sure which one you should use, run the ip link command. Ethernet NICs are usually named ens followed by a number, and Wi-Fi NICs usually start with wlan and a number. In docker-compose.yaml, go to the server service, and change the LANBASSADOR_INTERFACE value to the NIC name that you would like to use, like so:

services:
  client:
    # ...

  server:
    # ...

    environment:
      LANBASSADOR_INTERFACE: ens3

    # ...

Important

Please note that the server service network must not be changed from host, otherwise, unknown hosts in the network are not going to be visible to the container.

Now, all that's left to do before starting the containers is copying the Lanbassador web client configuration file. It is available in the repository under the client/lanbassador-config.json path. This file contains instructions on how web browsers can reach the backend server to obtain real time data:

$ wget -O 'lanbassador-client.json' 'https://git.luca0n.com/luca0N/lanbassador/raw/branch/main/client/lanbassador-config.json'

Important

Unless you change the default docker-compose.yaml file, the configuration file must be named lanbassador-client.json instead of lanbassador-config.json, as shown in the example command above.

Once done, start the Docker Compose service. Note that docker-compose has changed to docker compose in newer versions of Docker Compose:

# docker-compose up

The Lanbassador interface should be available from your browser based on the docker-compose.yaml file. If you are using the default values, you should be able to access the interface on http://localhost:8085/. Well done!