> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nonce.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Install and update Nonce Agent

> Install Nonce Agent on a host at the site, confirm that it is online, and update it from Nonce.

Nonce Agent runs on a host at the site and connects the farm's miners to Nonce. Each farm has its own Agent.

## Before you begin

* **Role**: installing and updating an Agent requires the Admin or Manager role.
* **Host**: a 64-bit x86 (x86\_64) host running Linux with systemd and root or `sudo` access, or Windows (Beta). To size the host, see [Host requirements](#host-requirements).
* **Network**: the host needs outbound HTTPS access to `agent.nonce.app` and a stable connection to every miner on TCP ports 80, 443, and 4028.

> [!NOTE]
>
> Windows support is in beta. On Windows, run the install command in PowerShell or Command Prompt. The Windows Agent differs from the Linux Agent in three ways:
>
> * **Window**: the Agent runs in its own window. Keep the window open. To start the Agent again, open the **Nonce Agent** desktop shortcut.
> * **Startup**: the Agent doesn't start when the host boots.
> * **Updates**: the Agent can't be updated from Nonce.

## Install the Agent

1. In Nonce, open the farm's settings and select the **Agent** tab.
2. Click **Setup**. Nonce creates the Agent and opens the **Setup Agent** dialog.
3. Select **Linux** or **Windows**, then click the install command to copy it.
4. Run the command on the host.
5. In the dialog, click **Confirm**. Nonce shows `Agent installed successfully`, and the **Agent** tab shows the Agent's ID, version, and uptime next to a green status dot.

If Nonce shows `Agent not installed yet`, wait for the command to finish, then click **Confirm** again.

> [!WARNING]
>
> The install command contains the Agent's ID and key. Use it for this farm only.

## Update the Agent

The Agent doesn't update on its own.

1. In the farm's settings, open the **Agent** tab.
2. Click **Check for Updates**. The dialog shows the change log of the available version.
3. Click **Update**. The Agent downloads the new version, verifies it, and restarts.

If the dialog shows `There are currently no updates available.`, the Agent is on the latest version.

## Host requirements

| System | Requirement |
| - | - |
| Linux | A 64-bit x86 (x86\_64) distribution that uses systemd. The Agent is tested on Ubuntu 22.04 and 24.04 and on Debian 11 and 12. The installation needs root or `sudo` access. ARM hosts, such as Raspberry Pi, aren't supported. |
| Windows (Beta) | Windows 10 or 11, 64-bit. The installation doesn't need administrator rights. |

For the hardware, choose the row that matches the number of miners the Agent manages. The figures assume a 5-minute collection interval.

| Miners | Example hardware | Minimum memory | CPU | Storage |
| - | - | - | - | - |
| Up to 1,000 | — | 2 GB | Dual-core x86\_64 | 32 GB |
| Up to 10,000 | Intel Core i5 or equivalent desktop | 4 GB | 4-core mid-range CPU (with hyperthreading) | 32 GB |
| Up to 20,000 | Intel Core i7 or equivalent workstation | 8 GB | 8-core mid-range CPU (with hyperthreading) | 32 GB |
| Up to 30,000 | Intel Core i7 or equivalent workstation | 16 GB | 10-core mid-range CPU (with hyperthreading) | 32 GB |
| 50,000+ | Intel Core i9 or equivalent server | 24 GB | 12-core mid-range CPU (with hyperthreading) | 32 GB |

* **Storage**: use an SSD. The storage figures assume one, because the Agent writes miner data and logs and caches firmware packages.
* **Headroom**: add capacity when the host runs network scans and firmware updates at the same time, or runs several Agent instances.
* **Network**: Gigabit Ethernet is recommended.

## What the installer sets up

On Linux, the installer registers the Agent as a systemd service and creates a directory for its files:

| Item | Location |
| - | - |
| Service | `nonce-agent`. The service starts when the host boots and restarts if the Agent stops. |
| Configuration file | `~/.nonce-agent-default/.env` |
| Logs | `~/.nonce-agent-default/logs/`. The Agent keeps 14 days of logs. |

`~` is the home directory of the user that ran the install command.

## Next steps

* [Scan for miners](https://docs.nonce.app/user-guide/onboarding.md#step-4-scan-for-miners): add the farm's IP ranges and run the first scan
* [How Nonce Agent works](https://docs.nonce.app/user-guide/agent-scan-mechanism.md): when scans run and how often the Agent collects data
* [Troubleshoot Nonce Agent](https://docs.nonce.app/user-guide/agent-scan-troubleshooting.md): fix an offline Agent, missing miners, and non-default miner passwords


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.