Install the Server

For a first deployment: install the server → configure an HTTPS reverse proxy → sign in → create a node and install its agent → configure notifications and backups. The server and monitored nodes may be on different machines.

The install script downloads the latest release automatically and registers a system service (systemd / OpenRC / launchd / FreeBSD rc / Windows scheduled task).

One-line Install

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/elysia62/NodeFlare/main/install.sh | sudo sh

FreeBSD:

fetch -qo - https://raw.githubusercontent.com/elysia62/NodeFlare/main/install.sh | sudo sh

Windows PowerShell (Administrator):

Invoke-WebRequest -UseBasicParsing https://raw.githubusercontent.com/elysia62/NodeFlare/main/install.ps1 -OutFile "$env:TEMP\nodeflare-install.ps1"
Unblock-File "$env:TEMP\nodeflare-install.ps1"
& "$env:TEMP\nodeflare-install.ps1"

First-time Setup

The installer asks for:

• Admin username and password (8–128 characters)
• Listen port (default 2206)
• Database URL (SQLite by default)

The server listens on 127.0.0.1:2206 by default; access it locally at http://127.0.0.1:2206/admin/login. For external access, put it behind an HTTPS reverse proxy — see Reverse Proxy.

TIP

The admin password is only needed for the initial database setup and is removed from the config file automatically afterwards.

Install Script Options

Command	Description
sudo sh install.sh	Interactive menu
sudo sh install.sh --install	Install or update
sudo sh install.sh --status	Show service status
sudo sh install.sh --restart	Restart the service
sudo sh install.sh --uninstall	Uninstall, keeping config and data
sudo sh install.sh --uninstall --purge	Uninstall and delete config and data

Windows equivalents are -Install / -Status / -Restart / -Uninstall [-Purge]. See Uninstall for the uninstall workflow.

These commands assume the script is already on disk; to pipe it directly, append flags after sh -s --, for example to check the service status:

curl -fsSL https://raw.githubusercontent.com/elysia62/NodeFlare/main/install.sh | sudo sh -s -- --status

Docker Deployment

The official gxmandppx/nodeflare image supports amd64 / arm64. This Linux deployment example stores configuration and local data in /etc/nodeflare on the host:

sudo mkdir -p /etc/nodeflare
sudo curl -fsSL https://raw.githubusercontent.com/elysia62/NodeFlare/main/docker/config.example.toml -o /etc/nodeflare/config.toml
# Edit /etc/nodeflare/config.toml and set the administrator username and password
sudo chown -R 10001:10001 /etc/nodeflare

docker run -d --name nodeflare \
  --restart unless-stopped \
  -p 2206:2206 \
  -v /etc/nodeflare:/etc/nodeflare \
  gxmandppx/nodeflare:latest

Then open http://your-server-ip:2206/admin/login; nodes and agents are configured exactly as with a script install. For external access, use an HTTPS reverse proxy — see Reverse Proxy. See Docker Deployment for Compose, updates, and uninstall.

Updating

Re-run the install script to update; config and data are preserved. Installs and updates verify the release checksum and roll back automatically on failure.

Next Steps

1. Open /admin/login through the reverse proxy and sign in with the installation account.
2. Review Login & Security, enable TOTP and choose which entry points need bot protection.
3. Create a node under Servers, use its download button to get the agent command, and run it on the monitored machine.
4. Confirm live metrics arrive, then configure traffic cycles and notification channels; test each channel.
5. Export a backup from Database and keep a copy away from the panel's machine.

For offline nodes or connection errors, check the FAQ and service logs. Loading the homepage alone does not prove WebSocket proxying works.