For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
    • Installation
    • User Guide
    • Support
LogoLogo
On this page
  • System requirements
  • Make miners reachable
  • Miner compatibility
  • Install
  • First-run onboarding
  • 1. Welcome — create your admin account
  • 2. Add miners
  • 3. Finish setup in Settings
  • Uninstall

Getting Started With Proto Fleet

||View as Markdown|
Edit this page
Built with

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

Linux and macOS
Windows
  • 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 on Linux and macOS). 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 (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. 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
Windows

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

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

To pin a specific version:

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

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 to configure fleet-wide options such as default Mining Pools.

Uninstall

Linux and macOS
Windows

To remove Fleet:

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

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

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