Install the miner

The miner is a single program, provider. There are three ways to get it:

Whichever you choose, the miner keeps its identity in ~/.urnetwork (%USERPROFILE%\.urnetwork on Windows), so you can switch later without registering again. Back that folder up first, and stop the old way's background job before starting the new one, so two copies never run at once. After installing, go back to the quick start.

The installers

Each installer puts the miner in your own user folder (no administrator rights needed), runs it in the background, keeps it up to date, and gives you one command to manage it all: urnet-tools. They live in the scripts folder of urnetwork/connect.

All three:

• download the latest release for your processor, check it against the SHA-256 GitHub lists for it (that catches a damaged download), and install only your machine's program;
• install the miner as urnetwork: type urnetwork wherever this guide says provider, including in commands the miner prints for you to copy;
• ask for your auth code if you aren't signed in yet (press Enter to do it later; --auth-code <code>, or -AuthCode on Windows, signs in without asking, but leaves the code in your shell history; URNETWORK_AUTH_CODE or the prompt don't);
• register a new device on its first start, once you've signed in;
• turn on automatic updates, every 6 hours by default;
• can be run again at any time: a second run updates in place and keeps your settings and your identity.

Linux

curl -fsSL https://raw.githubusercontent.com/urnetwork/connect/main/scripts/Provider_Install_Linux.sh | sh

Then open a new terminal, or run the export PATH=… line it prints. It runs on 64-bit and 32-bit Intel, AMD and ARM, including a Raspberry Pi 2 or newer on a 32-bit OS (not a Pi Zero or Pi 1), and needs curl or wget, and jq or python3 (most systems have one). It:

• installs urnetwork and urnet-tools into ~/.local/share/urnetwork-provider/bin and adds that folder to your PATH in ~/.bashrc (creating it if needed) and in ~/.zshrc if you have one. Pass -B to leave them alone. If a new terminal still can't find urnetwork, run the export PATH=… line the installer printed;
• runs the miner as a systemd user service, urnetwork.service, with an update timer, and turns on lingering so the service keeps running after you log out (if that needs an administrator, it prints the sudo loginctl enable-linger command to run);
• in a shell without a systemd user session (a sudo su shell, many containers, WSL), installs anyway, without a background service or automatic updates, and tells you how to run the miner in the foreground. Run urnet-tools update yourself from time to time.

--interval 6h, daily, weekly or monthly sets how often it checks for updates.

Options go after sh -s --, for example curl -fsSL … | sh -s -- --no-start. Run it with --help for all of them.

macOS

curl -fsSL https://raw.githubusercontent.com/urnetwork/connect/main/scripts/Provider_Install_macOS.sh | sh

Then open a new Terminal window. It needs macOS 12 or later and nothing else, and it works on Apple silicon and Intel Macs (from a Rosetta terminal too, it picks the native build). It:

• installs urnetwork and urnet-tools into ~/.local/share/urnetwork-provider/bin and adds that folder to your PATH in ~/.zshrc (and in ~/.bash_profile if you use bash). Pass -B to leave them alone;
• runs the miner as a launchd agent that starts when you log in and restarts the miner if it crashes. macOS may show a "Background Items Added" notification; that's expected. It's listed as urnet-tools under System Settings → General → Login Items;
• clears the download's quarantine flag for you, and refuses to run with sudo.

On macOS, --dry-run prints everything it would do without changing anything, and -y answers every question itself. The miner's log is in ~/Library/Logs/urnetwork/.

Windows

In a normal PowerShell window (not "Run as administrator"):

irm https://raw.githubusercontent.com/urnetwork/connect/main/scripts/Provider_Install_Win32.ps1 | iex

It works in Windows PowerShell 5.1 and PowerShell 7, on 64-bit Intel or AMD and on ARM64. It:

• installs urnetwork.exe, urnet-tools and the updater into %LOCALAPPDATA%\urnetwork\provider and adds that folder to your PATH. Open a new window afterwards;
• once you're signed in, asks whether to run the miner in the background, now and whenever you sign in to Windows. It runs hidden, from shortcuts in your Startup folder, so it stops when you sign out. If you sign in later, run urnet-tools auto-start on and urnet-tools start;
• installs urnet-tools.cmd beside urnet-tools.ps1. If PowerShell says "running scripts is disabled", type urnet-tools.cmd instead of urnet-tools.

urnetwork.exe isn't code-signed, so SmartScreen or Defender may ask before running it. Windows options are PowerShell-style: -Tag, -AuthCode, -NoStart, -NoAutoUpdate, -AddToStartup, -NoStartup, -NonInteractive. Installing a particular version with -Tag leaves automatic updates off. They can't be passed through irm … | iex: save the script and run it, for example powershell -ExecutionPolicy Bypass -File .\Provider_Install_Win32.ps1 -NoStart, or set $env:URNETWORK_AUTH_CODE before the irm line. Get-Help .\Provider_Install_Win32.ps1 -Detailed lists them all.

Manage it with urnet-tools

urnet-tools --help lists everything for your system (on Windows: urnet-tools help). Options take --option value or --option=value; on Windows they're PowerShell-style, such as -Interval and -RemoveIdentity.

Uninstall

urnet-tools uninstall

It removes the miner, its background job and its PATH entry, and keeps your identity in ~/.urnetwork, so you can install again later as the same device. To delete the identity too, add --remove-identity (-RemoveIdentity on Windows); it asks you to type delete first. Back it up before you do: without it, the device can't be recovered.

Manual download

Every release on the build releases page has a file named urnetwork-provider-<version>.tar.gz. It's a large download (about 240 MB), because it holds one provider program for every system, at <os>/<arch>/provider (provider.exe on Windows). It also has MIPS builds for routers.

On Linux or macOS, download and install it into ~/.local/bin, choosing your folder from the table:

VERSION=<version>   # the latest tag on the releases page, without the leading v
curl -fSsL -o urnetwork-provider.tar.gz \
  "https://github.com/urnetwork/build/releases/download/v${VERSION}/urnetwork-provider-${VERSION}.tar.gz"
tar -xzf urnetwork-provider.tar.gz linux/amd64/provider            # your folder from the table
mkdir -p "$HOME/.local/bin"
install -m 755 linux/amd64/provider "$HOME/.local/bin/provider"   # your folder from the table
export PATH="$HOME/.local/bin:$PATH"
provider --version

Add the export PATH=… line to your shell's startup file (~/.bashrc on most Linux systems, ~/.zshrc on macOS) so the command is found in new terminals.

On macOS, a file downloaded with a web browser (not with curl as above) is quarantined and won't run. Remove the quarantine once:

xattr -d com.apple.quarantine "$HOME/.local/bin/provider"

On Windows, in PowerShell, put it in a folder you own, so updates can replace it:

$Version = "<version>"   # the latest tag on the releases page, without the leading v
$Arch = "amd64"          # or arm64, from the table
$Dir = "$env:LOCALAPPDATA\Programs\urnetwork"
New-Item -ItemType Directory -Force $Dir | Out-Null
$ProgressPreference = "SilentlyContinue"
Invoke-WebRequest -UseBasicParsing -OutFile "$env:TEMP\urnetwork-provider.tar.gz" "https://github.com/urnetwork/build/releases/download/v$Version/urnetwork-provider-$Version.tar.gz"
tar -xzf "$env:TEMP\urnetwork-provider.tar.gz" -C $env:TEMP "windows/$Arch/provider.exe"
Move-Item -Force "$env:TEMP\windows\$Arch\provider.exe" "$Dir\provider.exe"
& "$Dir\provider.exe" --version

Run it as & "$Dir\provider.exe", or add that folder to your PATH to type provider. provider.exe isn't code-signed, so SmartScreen or Defender may ask before running it.

Then go back to the quick start and run provider setup. Its background service also keeps a manual install up to date; see Updates.

Build from source

Use the Go version that sn/go.mod asks for (currently Go 1.27.3) and matching revisions of the sibling repositories its replace directives point to. The source folder must look like this:

urnetwork/
├── sn/                 # github.com/urfoundation/sn
├── connect/            # includes connect/sctp
├── sdk/
├── server/
├── warp/
├── proxy/
├── userwireguard/
├── glog/
├── goidenticons/
└── gvisor/             # matching generated Go source selected by the release

The local replacements are part of the build: use the matched source checkouts or source bundle for the release you are deploying. A checkout of sn alone is not enough. Get the matching generated gvisor source with that bundle; an arbitrary upstream revision is not a reproducible substitute.

From the sn folder:

mkdir -p "$HOME/.local/bin"
go build -o "$HOME/.local/bin/provider" ./cli/miner
export PATH="$HOME/.local/bin:$PATH"
provider --help

A build of your own says development build and never updates itself. Update it by building again.

A binary from your operator

You can also run a provider binary your operator builds from the same release source.