Skip to content

Install the hub

Installing the hub is one package and one run of sudo nhub setup. When the wizard finishes, the panel is at http://<hub>:8080, where <hub> is the address of the box, and you sign in. The shape installed here is server mode, which keeps every address the box has.

Before you start

The box must meet these conditions:

  • It stays on, and it runs one of the supported systems: Debian 12 or newer, Ubuntu 24.04 or newer, Raspberry Pi OS 64-bit, Fedora 41 or newer, the RHEL 9 family, or Arch. Supported platforms has the full matrix.
  • You have root on it.
  • It has internet access, because the setup fetches packages.

The other shapes, side gateway and router, take over the box's interfaces; the Network page describes them.

Install the package

bash
sudo apt install ./neutrino-hub_0.2.0_amd64.deb
bash
sudo dnf install ./neutrino-hub-0.2.0-1.x86_64.rpm
bash
sudo dnf install -y epel-release
sudo dnf install ./neutrino-hub-0.2.0-1.x86_64.rpm
bash
sudo pacman -U neutrino-hub-0.2.0-1-x86_64.pkg.tar.zst

On ARM64 the file is neutrino-hub_0.2.0_arm64.deb or neutrino-hub-0.2.0-1.aarch64.rpm. The package includes its own Python under /opt/neutrino/python. On the RHEL family, fail2ban, arp-scan and vnstat come from EPEL.

Start the setup wizard

  1. Run sudo nhub setup. The command prints an address holding a one-time token and, where the box has a browser, opens the wizard there.
  2. Open the printed address in a browser on the same network.
  3. Select Set this box up.

The setup wizard's welcome screen

To answer in the terminal instead, press Enter at its prompt; the same screens then run in the terminal, in English.

Answer the six screens

Next moves to the following screen, Back returns to the previous one, and nothing is written until the last screen is confirmed.

  1. On Language, pick the language the panel is drawn in.
  2. On A password for the panel, a passphrase for the vault, type a Panel password and a Vault master passphrase. The password signs you in; the passphrase seals every credential the box holds, and a restore from backup requires it again. The secrets screen
  3. On What is this machine for?, pick Server. The shape screen with Server picked
  4. On Which ports?, keep Panel answers on port at 8080. In server mode every interface keeps its address, and the panel listens on every interface. The ports screen in server mode
  5. On Going out through a proxy, leave Set it up here off. You can set up a proxy later on the Proxy page. The proxy screen, skipped
  6. On Ready, read the summary and confirm it. The review screen

WARNING

The vault opens only with its passphrase. A lost passphrase means every credential and AI account is entered again after a reset.

Open the panel

The steps run on the screen, from checking packages to installing this machine's own agent, and end with This box is a gateway. The page then moves to the panel by itself; Open the panel does the same.

The done screen

  1. Open http://<hub>:8080. The sign-in page
  2. Type the panel password and select Sign in.

The last setup step installed this machine's own agent, so Devices already lists the box under Managed devices.

Managed devices with the hub's own machine

After the first sign-in

GoalPage
Change the shape to side gateway or routerNetwork
Reach the box and the LAN from outsideOverlay: NetBird or Overlay: EasyTier
Send traffic through an exit nodeProxy

Neutrino · personal developer infrastructure