getlantern/lantern-box repository overview

⁠Lantern Box

Lantern Box is a censorship circumvention proxy and client platform built on sing-box⁠, with additional protocols from Lantern.

See the project documentation⁠ for supported protocols, configuration examples, and deployment guidance.

⁠Image tags

• getlantern/lantern-box:latest: the latest published release image.
• getlantern/lantern-box:vX.Y.Z: a specific release.

The release image supports Linux AMD64.

⁠Run

Create a config.json using the project documentation, then mount it at /config.json. For example, for a server listening on TCP and UDP port 443:

docker run -d --name lantern-box \
  --restart unless-stopped \
  -p 443:443/tcp \
  -p 443:443/udp \
  --mount type=bind,src="$(pwd)/config.json",dst=/config.json,readonly \
  getlantern/lantern-box:latest

Adjust the published ports to match your configured listeners. Mount any certificates, keys, or other files referenced by the configuration at their configured container paths.

The default command is lantern-box run --config /config.json.

⁠Run a Lantern node

A Lantern node gets its config from Lantern instead of a config.json. Run serve --register in place of the default command:

docker run -d --name lantern-node --restart unless-stopped --network host \
  --stop-timeout 70 -v lantern-node:/var/lib/lantern-node \
  --entrypoint /usr/local/bin/lantern-box \
  getlantern/lantern-box:latest serve --register --state-dir /var/lib/lantern-node

Host networking lets the node ask your router to forward its port and be reached on it. The longer stop timeout gives it time to deregister and remove the forward when it stops, so stop it with docker stop, not docker rm -f. The volume keeps the node's identity and port. See Run a Lantern node⁠ for its options.

⁠Source

• Source code and issues⁠
• Releases⁠