fleet/README.md
noahtalerman 5b67e7e551
Add a walkthrough for previewing Fleet (fleetctl preview) to top level README. (#151)
- Move the transition announcement below the banner image.
- Remove the old documentation section and add a link to the updated docs.
2020-12-29 08:59:09 -08:00

3.3 KiB

Fleet CircleCI Go Report Card

Fleet is the most widely used open source osquery manager. Deploying osquery with Fleet enables programmable live queries, streaming logs, and effective management of osquery across 50,000+ servers, containers, and laptops. It's especially useful for talking to multiple devices at the same time.

banner-fleet-cloud-city

🎉 Announcing the transition of Fleet to a new independent entity 🎉

Please check out the blog post to understand what is happening with Fleet and our commitment to improving the product. To upgrade from Fleet ≤3.2.0, just grab the latest release from this repository (it'll work out of the box).

Preview Fleet

Get the latest release of the fleetctl CLI tool

With node installed:

npm install -g fleetctl

Set up a preview deployment of the Fleet server

With docker installed:

fleetctl preview

Preview Fleet at https://localhost:8412.

Add containerized hosts to your preview deployment

The osquery directory contains a docker-compose.yml and additional configuration files to start containerized osquery agents. To start osquery, first retrieve the "Enroll Secret" from Fleet (by clicking the "Add New Host") button in the Fleet dashboard.

With your "Enroll Secret" copied:

cd fleet-preview/osquery
ENROLL_SECRET=<copy from fleet> docker-compose up

Refresh the page to see the containerized hosts populate the Fleet dashboard.

Query editor

Screenshot of query editor

Documentation

Documentation for Fleet can be found here on GitHub.

Community

Chat

Please join us in the #fleet channel on osquery Slack.

Community Projects

Below are some projects created by Fleet community members. Please submit a pull request if you'd like your project featured.