> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.proto.xyz/fleet/llms.txt.
> For full documentation content, see https://docs.proto.xyz/fleet/llms-full.txt.

# 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.

## System requirements

You need:

* **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.

### Make miners reachable

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

* **Enable host networking in Docker (simplest).** The Fleet container shares your host's network, so it can reach anything the host can reach. Recommended if you're not sure which option you need.
* **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:

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

## Miner compatibility

Fleet supports the hardware listed on the [home page](./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

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
```

When the script finishes, it prints 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](./user-guide#settings) to configure fleet-wide options such as default [Mining Pools](./user-guide#mining-pools).

## Uninstall

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
```