The VeilNet Conflux is available for Debian-based Linux distributions, such as Ubuntu. We recommend installing VeilNet Conflux as a systemd service, which is easier to manage and automatically restarts upon failure or reboot.
Install #
VeilNet Conflux can be easily installed from a pre-compiled binary, which is available at:
- Stable
- Nightly
This pre-compiled binary also serves as a CLI tool. To install as a systemd service, simply run:
# make binary executable
chmod +x ./veilnet-conflux
# install
sudo ./veilnet-conflux install
Connect #
To connect with VeilNet, you will need a registration token, which can be acquired for free at https://auth.veilnet.app.
Then run the following command:
./veilnet-conflux register \
-t <your_registration_token> \
--cidr <a_plane_subnet_ip> \ # optional
--teams <team_list> \ # optional
--tag \ #optional
-p # optional
The register command has the following options:
- -t, –token: the only mandatory option, requires your registration token.
- –cidr: if set, the VeilNet Conflux instance will request to use the given IP address. If the IP address is used or falls outside the subnet of the VeilNet Plane, the registration will fail. Simply remove this option or try with a different IP address if an error occurs. This is similar to how you select a character name in an online game; the first instance requests the IP address will get it under Public Plane.
- –tag: Just a human-readable name for this instance, so you could remember and manage easily.
- -p, –portal: Set VeilNet Conflux instance to portal mode, which will allow access to local networks the host is on (subject to access control). If not given, VeilNet Conflux will be in rift mode and forward all traffic from the host via VeilNet. Consider portal mode is similar to split tunnel in a regular VPN, but with the functionality of a router.
The VeilNet Conflux will restart automatically upon host reboots.
Disconnect #
To disconnect from VeilNet, simply run:
./veilnet-conflux unregister
Uninstall #
To uninstall VeilNet Conflux from the host, simply run:
sudo ./veilnet-conflux remove
Update #
To update VeilNet Conflux, simply download the newest binary. Execute the “remove” command and run the “install” command via the new binary.