> This page is for Fleet.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.proto.xyz/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.proto.xyz/_mcp/server.

# Getting Started With Proto Fleet

Proto Fleet runs on a machine you control — a laptop, desktop, or server on the same network as your miners. This guide takes you from nothing installed to a running fleet.

## Choose a deployment

#### [Standard installation](#system-requirements)

Run Fleet on one host. This is the right choice for most installations.

#### [High availability](/fleet/high-availability)

Run Fleet across three dedicated Linux hosts so another host can take over.

If Fleet cannot run on the miners' network, use a [Fleet Node](/fleet/fleet-node) to connect that network to Fleet.

## System requirements

#### Linux and macOS

* **Docker Desktop** (or Docker Engine + Docker Compose) installed and running.
* **Network reachability to your miners.** Fleet has to be able to reach the IPs or subnets it scans — how you get there is up to you.

#### Windows

* **Windows 10 (build 19041 or newer) or Windows 11**, x64.
* **Local Administrator access** — the installer self-elevates via UAC.
* **Virtualization enabled in BIOS/UEFI** (required for WSL2).
* **Network reachability to your miners.** Fleet has to be able to reach the IPs or subnets it scans — how you get there is up to you.
* Recommended: 8 GB RAM and 20 GB free on `C:`.

You don't need to install Docker, WSL, or Ubuntu yourself — the installer sets them up for you and deploys Fleet inside WSL2.

### Make miners reachable

You have two ways to give Fleet access to your miners:

* **Turn on host networking in Docker.** On Linux and macOS, this is the recommended choice if you're not sure which option you need. The Fleet container shares your host's network, so it can reach anything the host can reach.
* **Configure scan targets.** If your miners live on a subnet the Fleet host can already route to, you can skip host networking and instead tell Fleet which specific subnets or IPs to scan when you add miners.

To enable host networking in Docker Desktop (Linux and macOS):

1. Open **Docker Desktop → Settings → Resources → Network**.
2. Check **Enable host networking**.
3. Click **Apply & restart**.

On Windows, Fleet runs inside WSL2, which uses NAT'd networking by default. If automatic discovery doesn't find your miners, configure scan targets after pairing to point Fleet at specific LAN subnets or IPs.

## Miner compatibility

Fleet supports the hardware listed on the [home page](/fleet/home#supported-hardware). Make sure your miners are powered on and reachable on the same network as the machine running Fleet. If you use VLANs or managed switches, confirm that traffic between the Fleet host and your miners isn't blocked.

## Install

#### Linux and macOS

Run the install script. It downloads the latest release from GitHub and deploys the Fleet server components with Docker Compose.

```bash
bash <(curl -fsSL https://fleet.proto.xyz/install.sh)
```

To pin a specific version:

```bash
bash <(curl -fsSL https://fleet.proto.xyz/install.sh) v0.1.0
```

#### Windows

Windows is supported on x64 only. `installer.exe` relies on files packaged alongside it in the release bundle — running it on its own will fail.

1. Go to the [latest release](https://github.com/block/proto-fleet/releases/latest) and download the amd64 deployment bundle: `proto-fleet-<version>-amd64.tar.gz`.
2. Extract the archive. From PowerShell:

   ```powershell
   tar -xzf proto-fleet-<version>-amd64.tar.gz
   ```

   Or right-click the file in File Explorer and choose **Extract All**.
3. Open the extracted `deployment\install\` folder and double-click `installer.exe`.

The installer self-elevates via UAC, enables WSL2, installs an Ubuntu distro and Docker Engine inside WSL, and deploys the Fleet server components at `~/proto-fleet` inside the distro. If it has to enable Windows features for WSL, it may prompt for a reboot and then resume automatically.

When installation completes, you'll be given the Fleet URL or URLs to open in your browser. Use one of those addresses rather than assuming `http://localhost`:

* If you installed Fleet on your current machine without HTTPS, that will usually be a local `http://` address.
* If you enabled HTTPS or installed Fleet on another server, use the `https://` or LAN address printed by the installer.

## First-run onboarding

The current first-run flow is short: create your admin account, then pair miners. Fleet-wide defaults like mining pools are configured after pairing from **Settings**, not during the initial wizard.

### 1. Welcome — create your admin account

Pick a username and password for the administrator account. This is the login you'll use every time you open Fleet.

### 2. Add miners

Fleet routes you directly to miner discovery. Scan the IPs or subnets you want, select the compatible miners you found, and pair them.

### 3. Finish setup in Settings

After pairing, use [Settings](/fleet/user-guide#settings) to configure fleet-wide options such as default [Mining Pools](/fleet/user-guide#mining-pools).

## Uninstall

#### Linux and macOS

To remove Fleet:

```bash
bash <(curl -fsSL https://fleet.proto.xyz/uninstall.sh)
```

If you installed Fleet in a non-default location, pass the path:

```bash
bash <(curl -fsSL https://fleet.proto.xyz/uninstall.sh) --deployment-path /path/to/install/root
```

#### Windows

Run `uninstall.exe` from the `deployment\install\` folder of the bundle you extracted during install. If you no longer have it, re-download and extract the [latest release bundle](https://github.com/block/proto-fleet/releases/latest) and use the `uninstall.exe` inside it.