fleet/README.md
noahtalerman dcbcc541a6
Move community project links into Example deployment scenario docs (#883)
- Move the community Fleet deployment tools to `docs/3-Deployment/4-Example-deployment-scenarios.md`
2021-05-27 17:14:10 -04:00

3.4 KiB

Fleet logo, landscape, dark text, transparent background

Website   News   Report a bug

Run Tests   Go Report Card   Twitter Follow

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.

Try Fleet

With Node.js and Docker installed:

# Install the Fleet command-line tool
sudo npm install -g fleetctl
# Run a local demo of the Fleet server
sudo fleetctl preview

The Fleet UI is now available at http://localhost:1337.

Your first query

Ready to run your first query? Target some of your sample hosts and try it out: Screenshot of query editor

Using real devices

For convenience, the demo includes a few simulated Linux hosts. To query a real device, install the osquery agent.

Team

Fleet is independently backed and actively maintained with the help of many amazing contributors.

🎉 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).

Documentation

Documentation for Fleet can be found here on GitHub.

Community

Chat

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

Contributing

Contributions are welcome, whether you answer questions on Slack/GitHub/StackOverflow/Twitter, improve the documentation or website, write a tutorial, give a talk, start a local osquery meetup, troubleshoot reported issues, or submit a patch. The Fleet code of conduct is on GitHub.

Banner featuring a futuristic cloud city with the Fleet logo