Documentation/Connecting/Your own panel/Nodes and clients·2 / 9

Nodes and clients

A node is one command on the panel's server: it signs in to the server over SSH, puts Veli and the protocols in place and ties the node to the panel. A client is a link with a term and a number of devices, one for all the nodes.

Add a node

The node's name, its server's address and the protocols beside Veli:

On the panel's server
sudo veli nodes add de1 --ssh root@203.0.113.5 --protocols veli,reality,trojan

On the screen: The server's SSH fingerprint and a question whether to trust it — check the fingerprint against the host's panel. Then the install steps and “The node is up”. If something fails, the server stays as it was — run the command again.

A protocol's port goes after a colon: --protocols veli,trojan:2083. Hysteria2 and TUIC — on x86-64 only.

Signing in to the server

-i
The private key file. Without it the command tries the keys in ~/.ssh, then asks for a password
--password-stdin
The SSH password from the input — for scripts
--fingerprint
The server's fingerprint beforehand, SHA256:… — no question is asked
--from, --node-from
Take the built veli and node from a disk — for a server our site does not open on

From another machine

The same commands work from a laptop or a work server that has veli. The token with the all right goes in a variable, not in the command line.

On the panel's server: prints the token and the API address
sudo veli token add laptop --rights all --days 7
On the other machine: the token goes in a variable
export VELI_PANEL_TOKEN=…
The same command with the panel's API address
veli nodes add de1 --panel <API address> --ssh root@203.0.113.5 --protocols veli,reality,trojan

A batch and user-data

Servers from a file, one after another. A line: name [user@]address[:port] [protocols] [key=file] [fingerprint=SHA256:…]
sudo veli nodes add --file servers.txt
Instead of SSH it prints the text for the host's “user-data” field: the server puts Veli in place when it is created and ties itself to the panel
sudo veli nodes add de2 --protocols veli,trojan --cloud-init

The “user-data” text holds the node's token: treat it as a password and paste it only into the host's form.

The list, protocols, removal

The nodes and when each last reported
sudo veli nodes
Add a protocol to a node; --remove takes one off
sudo veli nodes protocols de1 --ssh root@203.0.113.5 --add hysteria2
Take the node off and put the server back as it was. Without --ssh it only leaves the panel; with --keep Veli stays on the server
sudo veli nodes remove de1 --ssh root@203.0.113.5

Clients

A client is a link with a term and a number of devices: one for all the panel's nodes.

A new client: prints the link and a QR code. With --speed 50 — Veli's speed, Mbit/s
sudo veli users add anna --days 30 --devices 3
The clients: devices, term, traffic
sudo veli users
The link and QR code once more
sudo veli users link anna
Extend the term
sudo veli users extend anna --days 30
Take off: the nodes cut the client off within half a minute, and the client stays in the trash for 30 days
sudo veli users remove anna

The client pastes the link into Veli (“Add” → paste) or opens it in a browser: the page tells about the other apps.

A move from another panel

The clients of Remnawave, Marzban, 3x-ui, Hiddify and of a CSV table come over with their terms, limits and devices. Without --yes the command only checks and writes nothing; “-” in place of a token or password — the command asks for it itself.

A check. Marzban — --user and --password, Hiddify — --key
sudo veli panel import remnawave https://old.example.com --token -
A check from a 3x-ui database file copied to the panel's server
sudo veli panel import 3x-ui --file x-ui.db
The move from a table: no expired clients, old links kept
sudo veli panel import csv --file clients.csv --skip-expired --redirect --yes
All clients into a table — it can be loaded back; --links adds the links (keep that file like a password)
sudo veli panel export --format csv --out clients.csv

Other flags: --rename — a taken name becomes “name-2”, --skip-disabled — no disabled clients, --devices N — places for clients with no device limit (3 by default), --redirect — old links lead to the new ones. The table's columns are shown by panel export.