Skip to content

SETUP.md

Latest commit

 

History

History
96 lines (64 loc) · 1.49 KB

SETUP.md

File metadata and controls

96 lines (64 loc) · 1.49 KB
Raw

Setup

Requirements

  • Go 1.22 or newer if you are building from source
  • Qt 6 WebEngine if you are building the browser frontend from browser/qt
  • IPv6 enabled on the Linux machines that will run VX6
  • firewall rules that allow the VX6 listen port

Build

The simplest build path is:

make build

That builds:

  • vx6
  • vx6-gui
  • the Go binaries in the root tree

You can also build directly with Go:

go build ./cmd/vx6
go build ./cmd/vx6-gui

Build the Qt browser frontend separately:

cmake -S browser/qt -B browser/qt/build
cmake --build browser/qt/build

Install

make install

For staged packaging:

make install DESTDIR=/tmp/vx6-install-root

First-Time Node Setup

Create a config and identity:

vx6 init --name alice --listen '[::]:4242'

Optional:

  • add --advertise if you already know the public IPv6 address
  • add --peer to seed discovery from a known node
  • add --hidden-node if you do not want to publish an endpoint record
  • add --downloads-dir if you want received files somewhere else

Run the Node

vx6 node

Check Status

vx6 status

Open the GUI

vx6-gui

The GUI opens a local browser page and calls the vx6 binary underneath.

Open the browser frontend

browser/qt/build/vx6-browser

The browser frontend uses the same vx6 backend and local control surface.

Linux-Specific Follow-Up