MacOS

Obtain a registration token

Please refer to the Quickstart Guide to obtain a registration token.

Download the VeilNet Conflux binary

Download the VeilNet Conflux binary from the releases page.

You can save the binary to a directory of your choice, and make it executable.

chmod +x veilnet-conflux

Install the VeilNet Conflux binary

To install the VeilNet Conflux as a system service, simply run the following command:

sudo ./veilnet-conflux register -p -t <registration_token>

Additional Configuration

There are some additional configuration options that can be passed when execute the binary.

• -g: Set the guardian url, default is https://guardian.veilnet.app. Guardian authentication server is not available for self-hosting at the moment, so you should not change this.
• -p: Enable portal mode. Without this option, the VeilNet Conflux will operate in Rift mode which forward all host traffic to the VeilNet, and does not access to the container network, host, and local network.
• --cidr: Set the CIDR of the VeilNet Conflux instance.
• --tag: Set the tag for the VeilNet Conflux instance, simply a human-readable identifier for the instance.
• --team: Set the team for the VeilNet Conflux instance, for Access Control feature.

Additional Commands

There are also additional commands that can be used to manage the VeilNet Conflux service.

• up: Start the VeilNet Conflux service with a Conflux token. This is for intergration with other programs such as our Flutter app. It will start the service but it will not persist after host reboot. Conflux token can only be obtained by direct API request to the Guardian.
• down: Stop the VeilNet Conflux service.
• start: Start the VeilNet Conflux service, if registration token is provided, it will use the registration token to register with the VeilNet.
• stop: Stop the VeilNet Conflux service. This will not unregister the service from the VeilNet.
• install: Install the VeilNet Conflux service as a system service. This will not register the service with the VeilNet.
• remove: Remove the VeilNet Conflux service from the system. This will not unregister the service from the VeilNet.
• unregister: Unregister the VeilNet Conflux service from the VeilNet. This will remove the service from the system.