Docker

VeilNet can be deployed as a Docker container. To deploy VeilNet Conflux, you will need a registration token, which can be acquired for free at https://auth.veilnet.app.

Deploy with the Docker command #

docker run -d --name veilnet-conflux \
-e VEILNET_REGISTRATION_TOKEN=<your_registration_token> \
-e VEILNET_PORTAL=true \
--privileged \ # Needed for creating TUN Interface
veilnet/conflux:beta

This will deploy VeilNet Conflux as a Docker container; this instance will allow you to remotely access other containers deployed in the same container subnet. There are additional environment variables corresponding to each option for the CLI:

• VEILNET_CONFLUX_CIDR: Set the IP address for the VeilNet Conflux instance. The address must be within the VeilNet Plane subnet and must not have been used by another instance.
• VEILNET_CONFLUX_TAG: Set a memorable name for the VeilNet Conflux instance
• VEILNET_CONFLUX_TEAMS: Set teams to this VeilNet Conflux instance. This is used for access control.

To use the host network and forward the host local networks, add “–network host” to the command:

docker run -d --name veilnet-conflux \
-e VEILNET_REGISTRATION_TOKEN=<your_registration_token> \
-e VEILNET_PORTAL=true \
--privileged \ # Needed for creating TUN Interface
--network host \
veilnet/conflux:beta

This requires the host system to be a Debian-based Linux, such as Ubuntu.

Stop the VeilNet Conflux #

docker stop veilnet-conflux
docker rm veilnet-conflux

Deploy via Docker Compose #

VeilNet Conflux can also be deployed via Docker Compose.

services:
  conflux:
    image: veilnet/conflux:beta
    container_name: veilnet-conflux
    environment:
      - VEILNET_REGISTRATION_TOKEN=<your_registration_token>
      - VEILNET_PORTAL=true
    privileged: true
    network_mode: host # optional
    pull_policy: always

You can pass configuration as environment variables same as using the Docker command.

docker compose up -d # start VeilNet Conflux

docker compose down  # stop VeilNet Conflux

Use Case #

Deploying VeilNet Conflux via Docker can allow you to access the container network from any other devices connected to the same VeilNet Plane (subject to access control). When deployed with “host network” mode, it is equivalent to installing as a system service.

This allows you to securely access other containerised applications remotely for debugging or sharing the service with others (We will explain how to do so in the section on access control).