Rift Quick Start

🚀 Quick Start Guide: Deploying Your VeilNet Rift Node #

Prerequisites #

Before you begin, ensure you have:

Docker and Docker Compose are installed on your system.
A valid config.yaml configuration file.
A WireGuard Client software, which you can download from https://www.wireguard.com/install/

For any questions or technical support, please contact me at [email protected] or [email protected].

If you encountered an issue or bug, please report it at https://github.com/ulfaric/veilnet-rift/issues

Configure Your Rift Node #

Create and edit the config.yaml file with your network settings. Here’s an example configuration:

				
					host_interface: eth0           # The host interface to use; in a container, this should be eth0
local_username: veilnet        # Your chosen local username, this is not your veilnet account
local_password: veilnet        # Your chosen local password, this is not your veilnet account password
wireguard_config:
  external_ip: x.x.x.x         # The external IP address for the WireGuard interface
  ip: 10.0.0.1                 # The IP address of the WireGuard interface

Deploy Using Docker Compose #

Create a docker-compose.yml file with the following content:

				
					services:
  veilnet:
    image: ulfaric/veilnet-rift:beta-1.0.2  # Updated to 1.0.2 to allow local network functionality
    pull_policy: always
    volumes:
      - ./config.yaml:/veilnet/config.yaml  # Mount your config.yaml into the container
      - ./config:/veilnet/config            # Mount the directory for WireGuard config files
    restart: unless-stopped
    privileged: true                        # Required for WireGuard
    networks:
      veilnet:
        ipv4_address: 192.168.0.129         # Assign an IP address within your host subnet

networks:
  veilnet:
    driver: macvlan
    driver_opts:
      parent: ens18                         # Your host's primary network interface
      macvlan_mode: bridge
    ipam:
      config:
        - subnet: 192.168.0.0/24            # Subnet matching your host network
          gateway: 192.168.0.1              # Your host subnet default gateway

Start the VeilNet Rift Service #

Run the following command to start the service in detached mode:

				
					docker-compose up -d

Access the VeilNet Rift UI, and connect to the Rift #

Once the service is running, access the VeilNet Rift user interface:

URL: http://<ip-you-chosen>:3000 (It will be 192.168.0.129 from the above example)
Login Credentials: Use the local_username and local_password you specified in config.yaml, and <ip-you-chosen> as Host.

Through the UI, you can:

Register an Account: Create your VeilNet account and claim ownership of virtual IPs.
Manage Your Rift Node: Start or stop the rift connection, create or delete peers.

Connecting with the Rift is the same as connecting with any WireGuard Hub. Simply copy the peer config and save it as a file with the suffix “.conf”, then import it with any WireGuard client software.

Explore API Endpoints (Optional) #

For advanced users, VeilNet Rift offers a range of API endpoints for authentication, Rift management, interface configuration, and WireGuard control. Detailed API documentation is available in the repository README.

Stop the VeilNet Rift Service #

To stop the service, execute:

				
					docker-compose down