Device Installation

Begin with the three steps below

Overview

The NoPorts daemon (a.k.a. sshnpd) is installable as a background service in many ways. Choose the best option for your environment. The service may be installed as a systemd unit, docker container, tmux session, or as a background job using cron and nohup. The binaries can also be installed standalone so that you can install your own custom background service.

⚠️ This guide doesn't support Windows

On Windows, we strongly recommend sticking to our automated installation process on Windows. This is because properly installing NoPorts as a Windows service requires making entries in the registry. If you want to create a custom installer for your organization, please speak to us directly at [email protected].

Step 1. Download

Step 1.1. Download from GitHub

You can download a release from GitHub, or see the table below to download the latest release for your platform.

1.b. Download using curl

Architecture	Linux	macOS	Windows
x64	sshnp-linux-x64.tgz	sshnp-macos-x64.zip (intel)	sshnp-windows-x64.zip
arm64	sshnp-linux-arm64.tgz	sshnp-macos-arm64.zip (apple)
arm	sshnp-linux-arm.tgz
risc-v	sshnp-linux-riscv.tgz

Step 1.2. Download using curl

Alternatively, if you want to download from the command line, you can do so with curl.

Linux

x64:

curl -fSL https://github.com/atsign-foundation/noports/releases/latest/download/sshnp-linux-x64.tgz -o sshnp.tgz

arm64:

curl -fSL https://github.com/atsign-foundation/noports/releases/latest/download/sshnp-linux-arm64.tgz -o sshnp.tgz

arm:

curl -fSL https://github.com/atsign-foundation/noports/releases/latest/download/sshnp-linux-arm.tgz -o sshnp.tgz

risc-v:

curl -fSL https://github.com/atsign-foundation/noports/releases/latest/download/sshnp-linux-riscv.tgz -o sshnp.tgz

macOS

Step 2. Unpack the Archive

If you downloaded from GitHub, the file name may be slightly different.

Linux

tar -xf sshnp.tgz

macOS

Step 3. Install sshnpd

See the links in the table below to continue with the installation process.

Installation method	When to use this method
Systemd Unit	You are on Linux and have root access. (Recommended)
Tmux session	You have tmux installed, or can install it. (Deprecated)
Headless	If you do not have root access and cannot install tmux (Deprecated)
Standalone Binaries	You want to manually setup the background service after downloading the binaries. (roll your own)