Skip to content

Tags ​

Every page carries a few tags. Pick one to see every page that has it.

Install

  • Add a node — Add a server to the panel and install the node on it, with one command or automatically over SSH.
  • Files and ports — Where the panel and the node keep their files, which ports they use, and the environment variables you may set.
  • Get started — What you need before you begin, and the order to set up the panel, a node and your first user.
  • Install an addon — The short path to installing an addon from the directory: on the panel's server, on another server over SSH, or by a command you run.
  • Install the panel — Install the NX panel with one command or a Docker stack, and get the one-time setup link.
  • Move from another panel — Copy users, inbounds, routing and admins from another VPN panel into NX with the nx-migrate wizard.
  • Moving to NX — Nexora is now NX. Run the new install script once on the panel's server: it moves the panel, a node beside it and its database to the new names.
  • Panel and node on one server — Run a node on the panel's own server: when it is a fair trade, why it is not recommended, and how to set it up.
  • The addon directory — Browse addons.nx-panel.org from the panel and install, update and remove an addon on the panel's server, over SSH or by hand.
  • The setup wizard — Finish a new install: create the main administrator and choose the panel's address, path and HTTPS, or restore a backup.
  • Uninstall — Remove the panel or a node from a server, and what each removal keeps.
  • Update — Update the panel from its Panel update page, the installer or Docker, then update the nodes.
  • Updating from the panel — See whether a new panel or node release is out, update the panel in one click with an automatic rollback, and keep node binaries current.

Panel

  • Addresses — Choose every port, host name and path the panel answers on, what each one serves, and what answers a request none of them takes.
  • Changes without restarts — How the panel sends a node only what changed, which changes go live, when an item is rebuilt, and why a restart is the last resort.
  • Command line — Every nx-panel and nx-node command, and how to get back into a panel you are locked out of.
  • Dashboard — Read the dashboard: the counters, the panel, fleet and node tiles you pin, the node status table and the heaviest users.
  • General settings — Set the panel's timezone, rule-set and preset directories, usage graphs and audit log, and restart the panel.
  • How NX works — The architecture in one page: the panel as the control plane, nodes as the data plane, how they talk, and where addons and users fit.
  • Install the panel — Install the NX panel with one command or a Docker stack, and get the one-time setup link.
  • Moving to NX — Nexora is now NX. Run the new install script once on the panel's server: it moves the panel, a node beside it and its database to the new names.
  • Panel and node on one server — Run a node on the panel's own server: when it is a fair trade, why it is not recommended, and how to set it up.
  • The setup wizard — Finish a new install: create the main administrator and choose the panel's address, path and HTTPS, or restore a backup.
  • Update — Update the panel from its Panel update page, the installer or Docker, then update the nodes.
  • Updating from the panel — See whether a new panel or node release is out, update the panel in one click with an automatic rollback, and keep node binaries current.
  • Use the panel — Find your way around the panel: the sidebar, the command palette, themes and languages, and how list pages and dialogs behave.

Node

  • A node and its panel — How a node is trusted, kept in step and switched off; what it does when it loses its panel; and what errors and warnings on a node mean.
  • Add a node — Add a server to the panel and install the node on it, with one command or automatically over SSH.
  • Changes without restarts — How the panel sends a node only what changed, which changes go live, when an item is rebuilt, and why a restart is the last resort.
  • How NX works — The architecture in one page: the panel as the control plane, nodes as the data plane, how they talk, and where addons and users fit.
  • Inside a tunnel — What happens inside a tunnel: relay and origins, derived credentials, profiles pooled into one session pool, how users stick to an origin, and how health is judged.
  • Moving to NX — Nexora is now NX. Run the new install script once on the panel's server: it moves the panel, a node beside it and its database to the new names.
  • Nodes — Add, install, edit, watch, move and delete the servers that carry your users' traffic.
  • Panel and node on one server — Run a node on the panel's own server: when it is a fair trade, why it is not recommended, and how to set it up.
  • Templates — Bundle inbounds, outbounds, endpoints, rule sets, routing and DNS into a template, give it to nodes, and choose which users reach it.
  • The path of a packet — One user's connection through a node, stage by stage: where it lands, where the user is known, where it is limited and counted, and how it leaves.
  • Tunnels — Create a tunnel so users connect to one node and leave for the internet from others, and keep it healthy.
  • Update — Update the panel from its Panel update page, the installer or Docker, then update the nodes.

Users

  • Groups and bulk operations — Label accounts with groups, change many accounts at once, create a batch from a name pattern, and export lists and configs.
  • Plans — Keep a catalogue of presets that new accounts are created from, and limit resellers to selling them.
  • Resellers — Give a reseller its own book of customers with a traffic allowance, an expiry, a user limit and the plans it may sell.
  • Shop: the customer portal — Set up Shop's web app, which is both a browser portal and a Telegram mini-app, with HTTPS and sign-in by email, SMS or the bot.
  • Traffic, quotas and limits — How traffic is collected and recorded, how quotas, expiry and reset cycles are enforced, and where the address, speed and device limits act.
  • Users — Create and manage your customers' accounts: limits, expiry, reset cycles, templates, links, devices and live connections.
  • Your first user in ten minutes — From a connected node to a customer with a working link: an inbound, a template, a user and an app.

Plans

  • NX Shop — Sell your panel's plans through a Telegram bot and a web app: install Shop, set it up, and find your way around its admin.
  • Plans — Keep a catalogue of presets that new accounts are created from, and limit resellers to selling them.

Subscriptions

  • Domain fronting — Put a CDN hostname in front of an inbound so users connect to the CDN, with a hostname per subscriber if you want one.
  • From a template to a link — How the panel builds a user's subscription: which inbounds they reach, how addresses and fronts become entries, how client TLS settings and pins are merged, and what each app is sent.
  • Subscriptions and the subscription page — Choose where subscription links point, what each entry is called, what apps are told, and what users see when they open their link in a browser.
  • Users — Create and manage your customers' accounts: limits, expiry, reset cycles, templates, links, devices and live connections.
  • Your first user in ten minutes — From a connected node to a customer with a working link: an inbound, a template, a user and an app.

Protocols

  • Endpoints — Serve WireGuard, OpenVPN and OpenConnect to your users with per-user keys and app config files, or connect a node to another network.
  • From a template to a link — How the panel builds a user's subscription: which inbounds they reach, how addresses and fronts become entries, how client TLS settings and pins are merged, and what each app is sent.
  • Hysteria2 and port hopping — Serve Hysteria2 over UDP, spread it across a range of ports, and keep per-user speed limits working.
  • Inbounds — Create the ways in that users connect to: protocol, port, transport and TLS, what goes into users' links, and how an inbound reaches nodes.
  • More protocols — The rest of what the panel serves, from AnyTLS and Mieru to SOCKS and SSH: what each is for, which apps read it, and its limits.
  • NaiveProxy — Serve NaiveProxy over HTTP/2 and TLS, and pick a certificate its clients accept.
  • One port for many inbounds — Put several inbounds behind one port with an ingress that routes by server name, ALPN or path, and choose which end does TLS.
  • OpenVPN and OpenConnect — Serve OpenVPN and OpenConnect (AnyConnect) to your users, with a sign-in per account and ready .ovpn files.
  • Protocols — Every inbound protocol the panel offers, what it runs over, whether a CDN can carry it, and which client apps read it.
  • Shadowsocks — Serve Shadowsocks with the 2022 methods and a key per user, for TCP and UDP without TLS.
  • The path of a packet — One user's connection through a node, stage by stage: where it lands, where the user is known, where it is limited and counted, and how it leaves.
  • Trojan — Serve Trojan over TLS: a password per user, any transport, and a CDN front when the transport is HTTP-shaped.
  • TUIC — Serve TUIC, a QUIC protocol over UDP with a choice of congestion control, for sing-box and Clash apps.
  • VLESS Encryption — Encrypt the VLESS stream itself with a post-quantum key exchange, so a CDN that terminates TLS sees only ciphertext.
  • VLESS with REALITY — Set up the usual first inbound: VLESS with REALITY, the target site it borrows, its keys and short IDs, and the vision flow.
  • VMess — Serve VMess for apps and users that expect it, with the same transports and TLS modes as VLESS.
  • WireGuard — Serve WireGuard to your users: a peer and an address per account, a ready .conf file, and how big the address range must be.
  • XHTTP — Use the XHTTP transport: its modes, the advanced fields every link carries, which apps read it, and running it behind a CDN.
  • Your first user in ten minutes — From a connected node to a customer with a working link: an inbound, a template, a user and an app.

Routing

  • Outbounds — Choose where traffic goes after it reaches a node: straight out, blocked, or on through another proxy, and check that a way out works.
  • Routing and DNS — Write the rules that choose an outbound for each connection, set the DNS servers nodes use, and start from or add to the preset catalogue.
  • Rule sets — Add lists of domains and address ranges for routing to match on; the panel downloads them, keeps them current and hands them to your nodes.
  • Templates — Bundle inbounds, outbounds, endpoints, rule sets, routing and DNS into a template, give it to nodes, and choose which users reach it.
  • The path of a packet — One user's connection through a node, stage by stage: where it lands, where the user is known, where it is limited and counted, and how it leaves.

TLS

  • Addresses — Choose every port, host name and path the panel answers on, what each one serves, and what answers a request none of them takes.
  • Certificates — Keep TLS certificates in the panel: self-signed, issued by ACME, or uploaded, renewed on their own and used by inbounds, the panel and addons.
  • Certificates, issued and renewed — Who issues each certificate, where it is kept, how it reaches nodes, when it renews, what happens to pins, and how the panel's own certificate is handled.
  • Hysteria2 and port hopping — Serve Hysteria2 over UDP, spread it across a range of ports, and keep per-user speed limits working.
  • Inbounds — Create the ways in that users connect to: protocol, port, transport and TLS, what goes into users' links, and how an inbound reaches nodes.
  • NaiveProxy — Serve NaiveProxy over HTTP/2 and TLS, and pick a certificate its clients accept.
  • One port for many inbounds — Put several inbounds behind one port with an ingress that routes by server name, ALPN or path, and choose which end does TLS.
  • Trojan — Serve Trojan over TLS: a password per user, any transport, and a CDN front when the transport is HTTP-shaped.
  • TUIC — Serve TUIC, a QUIC protocol over UDP with a choice of congestion control, for sing-box and Clash apps.
  • VLESS with REALITY — Set up the usual first inbound: VLESS with REALITY, the target site it borrows, its keys and short IDs, and the vision flow.

Certificates

  • Certificates — Keep TLS certificates in the panel: self-signed, issued by ACME, or uploaded, renewed on their own and used by inbounds, the panel and addons.
  • Certificates, issued and renewed — Who issues each certificate, where it is kept, how it reaches nodes, when it renews, what happens to pins, and how the panel's own certificate is handled.
  • OpenVPN and OpenConnect — Serve OpenVPN and OpenConnect (AnyConnect) to your users, with a sign-in per account and ready .ovpn files.

Tunnels

  • Inside a tunnel — What happens inside a tunnel: relay and origins, derived credentials, profiles pooled into one session pool, how users stick to an origin, and how health is judged.
  • Tunnels — Create a tunnel so users connect to one node and leave for the internet from others, and keep it healthy.

Domain fronting

  • Domain fronting — Put a CDN hostname in front of an inbound so users connect to the CDN, with a hostname per subscriber if you want one.
  • XHTTP — Use the XHTTP transport: its modes, the advanced fields every link carries, which apps read it, and running it behind a CDN.

Access

  • Addresses — Choose every port, host name and path the panel answers on, what each one serves, and what answers a request none of them takes.
  • Admins — Create and manage the operator accounts that log in to the panel: main admins, admins and resellers, the panel owner, passwords and sessions.
  • API tokens — Create API tokens for scripts, bots and addons: bound to an admin, narrowed by scopes, rate-limited, and shown only once.
  • Audit log — See who changed what in the panel and who signed in, filter the record, and decide how long it is kept.
  • Resellers — Give a reseller its own book of customers with a traffic allowance, an expiry, a user limit and the plans it may sell.
  • Roles — Use the built-in roles or make your own: a tier, the permissions kept inside it, and limits on what its accounts may hand out.
  • Security — Protect admin logins: two-factor authentication, recovery codes, signed-in sessions, login lockout and bans, trusted proxies and the allowlist.
  • Security model — How NX protects the panel, its nodes and its operators: mutual TLS and pinning, sessions, two-factor sign-in, roles, scopes and ownership, API tokens, login protection, the setup gate and the audit log.
  • Single sign-on — Add a sign-in button for Google, Microsoft, GitHub, your own identity server or any OpenID Connect or OAuth 2.0 provider, and let each account link its own identity.

Security

  • A node and its panel — How a node is trusted, kept in step and switched off; what it does when it loses its panel; and what errors and warnings on a node mean.
  • Audit log — See who changed what in the panel and who signed in, filter the record, and decide how long it is kept.
  • Security — Protect admin logins: two-factor authentication, recovery codes, signed-in sessions, login lockout and bans, trusted proxies and the allowlist.
  • Security model — How NX protects the panel, its nodes and its operators: mutual TLS and pinning, sessions, two-factor sign-in, roles, scopes and ownership, API tokens, login protection, the setup gate and the audit log.
  • Single sign-on — Add a sign-in button for Google, Microsoft, GitHub, your own identity server or any OpenID Connect or OAuth 2.0 provider, and let each account link its own identity.
  • The addon platform — How the panel registers an addon: the signed manifest, the claim code, the consent screen, grants the addon holds, health, suspend, updates and certificates.
  • The setup wizard — Finish a new install: create the main administrator and choose the panel's address, path and HTTPS, or restore a backup.

Resellers

  • Resellers — Give a reseller its own book of customers with a traffic allowance, an expiry, a user limit and the plans it may sell.
  • Shop: agents — Let customers resell through Shop: price levels, prepaid agent wallets, their statement, and how their accounts show on the panel.

Events

  • Email — Get the panel's notices by email: connect an SMTP server, confirm each address with a code, and choose what it hears.
  • Event catalogue — Every event the panel raises: its family, the scope needed to hear it, its payload fields, and the signed envelope it arrives in.
  • Telegram — Get the panel's notices in Telegram: set up the bot, pair chats and groups to accounts, choose events, and ask the bot for status.
  • The event bus — How the panel turns a change into deliveries: the outbox, one delivery per subscriber, signed envelopes, retries, and the people-facing channels.
  • The notifier — Tell every user on the panel about their account over Telegram, Bale, SMS, email or any HTTP API, and send your own messages, with the notifier addon.
  • Webhooks and events — Send the panel's events to your own programs: subscribers, signed deliveries, retries, the delivery log, and the alert thresholds.

Addons

  • Addons — What an addon is, what the panel gives it, how far each one is trusted, and where to start.
  • Addons page — Register, install, update, suspend and remove addons from the panel's Addons page, and approve what each one may do.
  • Build an addon — Write your own addon with the addon kit and the template: registration by claim code, signed events, the panel API, health, install options, certificates and getting listed.
  • Install an addon — The short path to installing an addon from the directory: on the panel's server, on another server over SSH, or by a command you run.
  • NX Shop — Sell your panel's plans through a Telegram bot and a web app: install Shop, set it up, and find your way around its admin.
  • Shop: agents — Let customers resell through Shop: price levels, prepaid agent wallets, their statement, and how their accounts show on the panel.
  • Shop: backup — Back up Shop's own database, keep its key safe, move Shop to a new server, and settle accounts after a panel restore.
  • Shop: payments — Take money in Shop: card-to-card confirmed by a receipt or your bank's SMS, a generic HTTP gateway you point at your own relay, and exchange rates.
  • Shop: promotions — Discount codes, gift codes and the referral reward in Shop: what each does, its limits, and how customers use them.
  • Shop: the customer portal — Set up Shop's web app, which is both a browser portal and a Telegram mini-app, with HTTPS and sign-in by email, SMS or the bot.
  • The addon directory — Browse addons.nx-panel.org from the panel and install, update and remove an addon on the panel's server, over SSH or by hand.
  • The addon manifest — Reference for nx-addon.json: every field, the install section and its option types, requires.panel, and how manifests and releases are signed.
  • The addon platform — How the panel registers an addon: the signed manifest, the claim code, the consent screen, grants the addon holds, health, suspend, updates and certificates.
  • The notifier — Tell every user on the panel about their account over Telegram, Bale, SMS, email or any HTTP API, and send your own messages, with the notifier addon.

Migration

  • Move from another panel — Copy users, inbounds, routing and admins from another VPN panel into NX with the nx-migrate wizard.

Monitoring

  • Dashboard — Read the dashboard: the counters, the panel, fleet and node tiles you pin, the node status table and the heaviest users.
  • Monitoring and metrics — How the panel watches its nodes: the health history and uptime bar, live connections on demand, the Prometheus metrics endpoint, and alerts raised as events.
  • Nodes — Add, install, edit, watch, move and delete the servers that carry your users' traffic.
  • Traffic, quotas and limits — How traffic is collected and recorded, how quotas, expiry and reset cycles are enforced, and where the address, speed and device limits act.

Backup

  • Backup and restore — Take, schedule, encrypt and download backups of the panel's database, check an archive, restore it, and move a panel between servers or databases.
  • Backup destinations — Send a copy of every backup off the panel's server: S3-compatible storage, an SFTP server, or a Telegram chat, each with its own retention.
  • Shop: backup — Back up Shop's own database, keep its key safe, move Shop to a new server, and settle accounts after a panel restore.

Licence

  • Licence — See what your licence allows, buy, renew or move one from the License page, and know what happens at the cap and at expiry.

API

  • API reference — Every route of the panel's REST API: what it takes, what it answers, and who may call it.
  • API tokens — Create API tokens for scripts, bots and addons: bound to an admin, narrowed by scopes, rate-limited, and shown only once.
  • Build an addon — Write your own addon with the addon kit and the template: registration by claim code, signed events, the panel API, health, install options, certificates and getting listed.
  • The addon manifest — Reference for nx-addon.json: every field, the install section and its option types, requires.panel, and how manifests and releases are signed.
  • The event bus — How the panel turns a change into deliveries: the outbox, one delivery per subscriber, signed envelopes, retries, and the people-facing channels.
  • Webhooks and events — Send the panel's events to your own programs: subscribers, signed deliveries, retries, the delivery log, and the alert thresholds.

Reference

  • API reference — Every route of the panel's REST API: what it takes, what it answers, and who may call it.
  • Changelog — What changed in each release of the panel, the node and the official addons, and what to do when you update.
  • Command line — Every nx-panel and nx-node command, and how to get back into a panel you are locked out of.
  • Event catalogue — Every event the panel raises: its family, the scope needed to hear it, its payload fields, and the signed envelope it arrives in.
  • Files and ports — Where the panel and the node keep their files, which ports they use, and the environment variables you may set.
  • Glossary — The words NX uses, each in a sentence or two.
  • The addon manifest — Reference for nx-addon.json: every field, the install section and its option types, requires.panel, and how manifests and releases are signed.
  • Troubleshooting — Common problems by symptom: the panel, nodes, users who cannot connect, empty subscriptions and failing backups.

Text and images under CC BY 4.0.