Get Started

HarborNode runs as a persistent system service. Once installed, it starts automatically on boot and exposes a local web dashboard for managing services.

This guide covers installation, verification, upgrade, and removal.

System Requirements

  • Linux-based distribution
  • systemd available
  • curl and tar installed
  • Root privileges for installation

HarborNode currently requires systemd.

Install HarborNode

Install using the official script:

curl -fsSL https://harbornode.vercel.app/install.sh | sudo bash

The installer will:

  • Detect your system architecture
  • Download the latest release from GitHub
  • Install the binary to /usr/local/bin/harbornode
  • Create /etc/harbornode/
  • Generate a default configuration
  • Create and enable a systemd service
  • Start HarborNode automatically

Default Configuration

The installer creates:

/etc/harbornode/config.toml

With the following defaults:

data_dir = "/etc/harbornode/data"
listen_port = 3080

You may edit this file at any time.

After modifying configuration, restart the service:

sudo systemctl restart harbornode

Verify Installation

Check service status:

systemctl status harbornode

If running correctly, you should see:

active (running)

View logs:

journalctl -u harbornode -f

Access the Web Dashboard

After installation, the installer prints available access URLs.

Typically:

http://<your-local-ip>:3080

If mDNS is available:

http://<hostname>.local:3080

You can also access locally:

http://localhost:3080

Hosted portal (public UI):

https://harbor-node-ports.vercel.app/

If you use the hosted portal, set its API base URL to your HarborNode backend (for example https://harbornode.onrender.com/api).

The dashboard allows you to:

  • Register services
  • Monitor runtime state
  • Restart services
  • View logs

Upgrade HarborNode

To upgrade to the latest version:

curl -fsSL https://harbornode.vercel.app/upgrade.sh | sudo bash

The upgrade script will:

  • Detect the current installed version
  • Fetch the latest release
  • Replace the binary safely
  • Restart the systemd service

Configuration and data are not modified.

Uninstall

To remove HarborNode:

sudo systemctl stop harbornode
sudo systemctl disable harbornode
sudo rm /usr/local/bin/harbornode
sudo rm -rf /etc/harbornode
sudo rm /etc/systemd/system/harbornode.service
sudo systemctl daemon-reload