Quickstart Guide

Create Your Account

First, let's create your VeilNet account.

1. Go to auth.veilnet.app and create your account via Google, Microsoft, Github, or discord.

2. You will be greeted with a central navigation page, select the top navigation tile Conflux in the right side of the page.

Generate a registration token

To join a device to VeilNet, you need to generate a registration token.

1. On the Conflux page, click the Deploy New Conflux Node button.
2. Then, select any available Plane, input a expiration time in days and give a optional tag for the token.
3. Click the Generate button to generate a registration token.

Warning: Please copy and save the registration token somewhere safe. You will not be able to access it again after you leave this page.

Warning: Community Plane applies Geo-location restriction. Your Conflux instance in Portal Mode will not be able to connect if your host is not within the same Geo-location. For example, for Community Plane "Australia", your host must be within Australia.

Note: Community Plane "Terra" does not have Geo-location restriction. We recommend you start with it.

Deploy a new Conflux Node

Simply select one of the platform/method, and click the Download Deployment Template button to download the deployment template.

For example, if you choose to use docker compose, you will download a docker compose file.

services:
  conflux:
    image: veilnet/conflux:beta
    container_name: veilnet-conflux
    environment:
      - VEILNET_REGISTRATION_TOKEN=<registration_token>
      - VEILNET_PORTAL=true # set to true for Portal mode
    privileged: true # required for creating a TUN interface
    pull_policy: always

Then, you can deploy the Conflux Node using the following command:

docker compose up -d

Important: Portal vs Rift Mode

There are two modes to run the Conflux Node: Portal and Rift.

• Portal mode allows Conflux serves as a gateway to other networks and devices, such as the host itself, container networks, local network, VPC network and the internet. It should be used on the server side. It is enabled by setting the VEILNET_PORTAL environment variable to true, or with the -p flag when running the veilnet-conflux binary.
• Rift mode allows Conflux capture all host traffic and forward it to the VeilNet, it will not forward any networks accessible from the host. It should be used on the client side. It is enabled by setting the VEILNET_PORTAL environment variable to false, or without the -p flag when running the veilnet-conflux binary.