fleet Documentation

Go binary-authorization & configuration-management repository by @fleetdm. AI agent rules & system prompts with 6.7k stars.

RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy fleet on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run)
docker run -d --name fleet -p 7001:7001 --restart always ${FLEET_REDIS_IMAGE:-redis:6.2}
Configured Services & Ports
โš™๏ธ redis-cluster-setup
image: ${FLEET_REDIS_IMAGE:-redis:6.2}
โš™๏ธ redis-cluster-1
image: ${FLEET_REDIS_IMAGE:-redis:6.2}
๐Ÿ”Œ Ports: 127.0.0.1:7001:7001
โš™๏ธ redis-cluster-2
image: ${FLEET_REDIS_IMAGE:-redis:6.2}
๐Ÿ”Œ Ports: 127.0.0.1:7002:7002
โš™๏ธ redis-cluster-3
image: ${FLEET_REDIS_IMAGE:-redis:6.2}
๐Ÿ”Œ Ports: 127.0.0.1:7003:7003
โš™๏ธ redis-cluster-4
image: ${FLEET_REDIS_IMAGE:-redis:6.2}
๐Ÿ”Œ Ports: 127.0.0.1:7004:7004
โš™๏ธ redis-cluster-5
image: ${FLEET_REDIS_IMAGE:-redis:6.2}
๐Ÿ”Œ Ports: 127.0.0.1:7005:7005
โš™๏ธ redis-cluster-6
image: ${FLEET_REDIS_IMAGE:-redis:6.2}
๐Ÿ”Œ Ports: 127.0.0.1:7006:7006
docker-compose.yml
yaml (docker-compose.yml)
---
version: "2"
services:
  redis-cluster-setup:
    image: ${FLEET_REDIS_IMAGE:-redis:6.2}
    command: redis-cli --cluster create 172.20.0.31:7001 172.20.0.32:7002 172.20.0.33:7003 172.20.0.34:7004 172.20.0.35:7005 172.20.0.36:7006 --cluster-yes --cluster-replicas 1
    networks:
      cluster_network:
        ipv4_address: 172.20.0.30
    depends_on:
      - redis-cluster-1
      - redis-cluster-2
      - redis-cluster-3
      - redis-cluster-4
      - redis-cluster-5
      - redis-cluster-6

  redis-cluster-1:
    image: ${FLEET_REDIS_IMAGE:-redis:6.2}
    command: redis-server /usr/local/etc/redis/redis.conf
    ports:
      - "127.0.0.1:7001:7001"
    volumes:
      - ./tools/redis-tests/redis-cluster-1.conf:/usr/local/etc/redis/redis.conf
    networks:
      cluster_network:
        ipv4_address: 172.20.0.31

  redis-cluster-2:
    image: ${FLEET_REDIS_IMAGE:-redis:6.2}
    command: redis-server /usr/local/etc/redis/redis.conf
    ports:
      - "127.0.0.1:7002:7002"
    volumes:
      - ./tools/redis-tests/redis-cluster-2.conf:/usr/local/etc/redis/redis.conf
    networks:
      cluster_network:
        ipv4_address: 172.20.0.32

  redis-cluster-3:
    image: ${FLEET_REDIS_IMAGE:-redis:6.2}
    command: redis-server /usr/local/etc/redis/redis.conf
    ports:
      - "127.0.0.1:7003:7003"
    volumes:
      - ./tools/redis-tests/redis-cluster-3.conf:/usr/local/etc/redis/redis.conf
    networks:
      cluster_network:
        ipv4_address: 172.20.0.33

  redis-cluster-4:
    image: ${FLEET_REDIS_IMAGE:-redis:6.2}
    command: redis-server /usr/local/etc/redis/redis.conf
    ports:
      - "127.0.0.1:7004:7004"
    volumes:
      - ./tools/redis-tests/redis-cluster-4.conf:/usr/local/etc/redis/redis.conf
    networks:
      cluster_network:
        ipv4_address: 172.20.0.34

  redis-cluster-5:
    image: ${FLEET_REDIS_IMAGE:-redis:6.2}
    command: redis-server /usr/local/etc/redis/redis.conf
    ports:
      - "127.0.0.1:7005:7005"
    volumes:
      - ./tools/redis-tests/redis-cluster-5.conf:/usr/local/etc/redis/redis.conf
    networks:
      cluster_network:
        ipv4_address: 172.20.0.35

  redis-cluster-6:
    image: ${FLEET_REDIS_IMAGE:-redis:6.2}
    command: redis-server /usr/local/etc/redis/redis.conf
    ports:
      - "127.0.0.1:7006:7006"
    volumes:
      - ./tools/redis-tests/redis-cluster-6.conf:/usr/local/etc/redis/redis.conf
    networks:
      cluster_network:
        ipv4_address: 172.20.0.36

networks:
  cluster_network:
    driver: bridge
    ipam:
      config:
        - subnet: 172.20.0.0/24

File: README.md

[](https://fleetdm.com)

[News](https://fleetdm.com/announcements)   ยท   [Report a bug](https://github.com/fleetdm/fleet/issues/new)   ยท   [Docs](https://fleetdm.com/docs)   ยท   [Why open source?](https://fleetdm.com/handbook/company/why-this-way#why-open-source)   ยท   [Art](https://fleetdm.com/logos)

Open-source platform for IT and security teams with thousands of computers. Designed for APIs, GitOps, webhooks, YAML, and humans.

What's it for?

Fleet gives you a single system to secure and maintain all your computing devices over the air. You can do MDM, patch stuff, deploy software, and verify anything, all from one place, across every OS your organization uses.

Fleet works directly with data and events from the native operating system, down to the bare metal. Strong diagnostics let you investigate errors on end-user devices and collect accurate audit evidence in minutes.

Get started

You can try Fleet out for yourself, or grab time with one of the maintainers to chat.

Is it any good?

Fleet is used in production by IT and security teams managing thousands of devices. Many deployments support tens of thousands of hosts, and a few large organizations manage 400,000 or more.

Supported platforms

  • Linux (all distros)
  • macOS
  • Windows
  • Chromebooks
  • iOS and Android (BYOD or corporate-owned)
  • Amazon Web Services (AWS)
  • Google Cloud (GCP)
  • Azure (Microsoft cloud)
  • Data centers
  • Containers (kube, etc)
  • Linux-based IoT devices

Infrastructure as code

Manage your fleet with GitOps, or use the GUI, REST API, webhook events, and the fleetctl command-line tool.

Linux support

First-class support for all major distros. Linux gets the same attention and visibility as macOS and Windows.

Visibility and compliance

Fleet can report on hundreds of attributes across your devices and ships with CIS benchmarks for macOS and Windows and comprehensive operating system, hardware, and software data. Check out the table reference documentation to see what's available.

Open by design

Fleet is open source and transparent about what it can and can't see. End users can verify exactly how the agent works and what data their company collects. Fleet collects only the data needed to manage and secure devices, not private activity like keystrokes, emails, or webcams.

Good neighbors

Ready-to-use, enterprise-friendly integrations exist for Snowflake, Splunk, GitHub Actions, Vanta, Elastic Jira, Zendesk, and more. Fleet also works with tools such as Munki, Chef, Puppet, Ansible, CrowdStrike, and SentinelOne.

Lighter than air

Fleet is lightweight and modular. You can use it for MDM without using it for security, and vice versa. You can turn off features you are not using.

Free as in free

The free version of Fleet will always be free. Fleet is independently backed and actively maintained with the help of many amazing contributors.

Longevity

The company behind Fleet is founded (and majority-owned) by true believers in open source. The company's business model is influenced by GitLab (NYSE: GTLB), with great investors, happy customers, and the capacity to become profitable at any time.

Fleet Device Management's company handbook is public and open source. You can read about the history of Fleet and our commitment to improving the product.

Chat

The Fleet community is full of kind and helpful people. Whether or not you are a paying customer, if you need help, just reach out.

Contributing   [](https://goreportcard.com/report/github.com/fleetdm/fleet)   [](https://bestpractices.coreinfrastructure.org/projects/5537)  

Contributions are welcome, whether you answer questions on Slack / GitHub / LinkedIn, improve the documentation or website, write a tutorial, give a talk at a conference or local meetup, give an interview on a podcast, troubleshoot reported issues, or submit a patch. The Fleet code of conduct is on GitHub.

License

The free version of Fleet is available under the MIT license. The commercial license is also designed to allow contributions to paid features for users whose employment agreements allow them to contribute to open source projects. (See LICENSE.md for details.)

Fleet is built on osquery, nanoMDM, Nudge, and swiftDialog.


File: docs/README.md

Fleet documentation

Welcome to the documentation for Fleet, the lightweight management platform for laptops and servers.

You can also read the Fleet docs over at https://fleetdm.com/docs.

[Using Fleet](./Using%20Fleet/README.md)

Resources for using the Fleet UI, fleetctl CLI, and Fleet REST API.

[Deploying](./Deploy/README.md)

Resources for installing Fleet's infrastructure dependencies, configuring Fleet, deploying osquery to hosts, and viewing example deployment scenarios.

[Contributing](./Contributing/README.md)

If you're interested in interacting with the Fleet source code, you'll find information on modifying and building the code here.


If you have any questions, please don't hesitate to File a GitHub issue or join us on Slack. You can find us in the #fleet channel.