Quick start
Install NanoPing
On Linux and macOS, install the np command with:
curl -sS https://get.nanoping.com | sh
It installs np in ~/.local/bin and links /usr/local/bin/np to it, so sudo np finds it. It asks whether to add ~/.local/bin to your PATH, and whether to remove an np an older installer left elsewhere. See Install and update for what it does and its options.
Start NanoPing
sudo np up
NanoPing needs root to create network interfaces and tune the system, so run it with sudo. On Linux it can also run as your own user. It starts in the background and prints where the dashboard is:
Started. Serving dashboard on http://127.0.0.1:8081
Activate the device
The first time a device starts, it has to be activated. NanoPing prints a link and opens it in your browser:
You need to activate this device. Go to the following link to sign in: https://user.nanoping.com/...
Sign in with your NanoPing account and the device is activated. It stays activated across restarts. Once activated, the node also joins your organization's cloud hub, so your other nodes show up in its dashboard.
Open the dashboard
Open the address from the output, http://127.0.0.1:8081 by default. The dashboard opens on the pipeline templates, the quickest way to get traffic flowing:
From here, create a pipeline from a template, or take the dashboard tour first.
Stop NanoPing
sudo np down
A node started with np up -a also stops on Ctrl+C. Press it again to stop it at once, without waiting for the pipelines to stop.
Useful options
| Command | Description |
|---|---|
np up -a | Stay attached to the terminal and print the log, instead of running in the background. |
np up --http 0.0.0.0:8081 | Serve the dashboard on another address. See HTTP before exposing it. |
np up --no-http | Run without a dashboard address of its own, managed from another node's dashboard. See Without an HTTP address. |
np up --grpc <address> | Serve the gRPC API. |
np up --rest-api <address> | Serve the REST API. |
np down --timeout 2m | Wait up to 2 minutes for the node to stop, instead of 30 seconds. |
np -c config.yaml up | Start with a config file. |
np service install | Run as a service that starts at boot. See Run as a service. |
np version | Print the version. |
np help | List all commands and options. |