fleetdfleetd
Guide
Design
  • English
  • 简体中文
GitHub
Guide
Design
  • English
  • 简体中文
GitHub
  • Introduction
  • Quick start
  • Server setup
  • Adding machines
  • Commands and terminal
  • Agent updates
  • Alerts
  • Configuration
  • Troubleshooting

Quick start

Try fleetd on your own computer with Docker. You need Docker with the Compose plugin.

Start the server

git clone https://github.com/weiyi0/fleetd
cd fleetd
docker compose up -d

This starts PostgreSQL and fleetd-server and publishes the admin page on port 8480.

Create an admin

docker compose run --rm fleetd admin-add admin

Enter a password of at least 12 characters. Add -totp before the username to also set up two-factor login.

Sign in

Open http://localhost:8480 and sign in. The page follows your browser language; switch between English and Chinese at the bottom of the sidebar.

Warning

Plain HTTP is only for trying fleetd on your own machine. Before using it over a network, put it behind HTTPS as described in Server setup.

Add a machine

Agents are downloaded from the server, so the server first needs a signed agent build. For a quick try without release keys, build an agent and run it by hand on a Linux machine that can reach your computer:

CGO_ENABLED=0 go build -o fleetd-agent ./agent/cmd/fleetd-agent
cat > agent.yaml <<EOF
server_url: ws://<your-computer>:8480/agent/ws
server_key: <Settings → Server → Server public key>
key_file: ./agent.key
state_dir: .
EOF
sudo ./fleetd-agent -config agent.yaml

The machine appears under Waiting for approval. Approve it and its metrics show up within a minute.

For real deployments, use the one-line installer instead.

Clean up

docker compose down -v
Edit this page on GitHub
Last Updated: 11/3/26, 11:50 AM
Contributors: weiyi
Prev
Introduction
Next
Server setup