Docs Get started

Install on Linux

Install the collector as a systemd service on x86-64 or ARM64 Linux.

1. Get the build and verify it

Lantern is in a private preview: the archives and their SHA-256 checksums come from the Lantern team (request a demo to get access). Use the archive for your processor (x64 for most servers and VMs, ARM64 for Raspberry Pi 4/5 and other 64-bit ARM machines), then check it:

sha256sum lantern-collector-0.2.0-preview-linux-x64.tar.gz

Compare the result with the SHA-256 you were given (also in SHA256SUMS.txt). Then unpack it:

tar xzf lantern-collector-0.2.0-preview-linux-x64.tar.gz
cd lantern

The collector is a single static binary with no dependencies.

2. Try the simulator (optional)

NETMAP_DATA=./data-demo ./netmap -collector sim -addr 127.0.0.1:8000

Open http://127.0.0.1:8000 and create the administrator. Press Ctrl+C to stop.

3. Install as a service

sudo ./install.sh

The script:

  • creates a lantern system user,
  • installs the program to /opt/lantern/netmap,
  • creates the data folder /var/lib/lantern (owner lantern, mode 0750),
  • writes the options to /etc/default/lantern and the unit to /etc/systemd/system/lantern.service,
  • enables the service, and copies the example configuration to /var/lib/lantern/snmp.json on the first install.

Fill in /var/lib/lantern/snmp.json (see Configure the collector), then start it:

sudo systemctl start lantern
journalctl -u lantern -f

By default the web UI listens on 127.0.0.1:8000, this machine only.

Make it reachable from other computers

sudo ./install.sh --addr 0.0.0.0:8443 \
  --tls-cert /etc/lantern/tls.crt --tls-key /etc/lantern/tls.key \
  --hosts lantern.yourdomain.local
Option Meaning
--addr Where the web UI listens (default 127.0.0.1:8000).
--tls-cert, --tls-key PEM certificate and key for HTTPS. The lantern user must be able to read the key: sudo chgrp lantern tls.key && sudo chmod 0640 tls.key.
--hosts DNS names people use to reach Lantern.
--ssh SSH session broker address (default 127.0.0.1:2222).

The first visit from another computer needs the setup token: sudo cat /var/lib/lantern/setup-token.txt.

The service runs with systemd sandboxing (no new privileges, read-only system, write access only to /var/lib/lantern) and only the capability to bind low ports, which syslog on UDP 514 needs.

Update or remove

  • Update: unpack the new version and run sudo ./install.sh again with the same options. Data stays.
  • Remove: sudo ./uninstall.sh removes the service and program and keeps /var/lib/lantern; add --purge to delete the data and the lantern user too.