fleet/README.md

63 lines
3.2 KiB
Markdown
Raw Normal View History

# Kolide Fleet [![CircleCI](https://circleci.com/gh/kolide/fleet/tree/master.svg?style=svg)](https://circleci.com/gh/kolide/fleet/tree/master) [![Go Report Card](https://goreportcard.com/badge/github.com/kolide/fleet)](https://goreportcard.com/report/github.com/kolide/fleet)
Fleet is the most widely used open-source osquery Fleet manager. Deploying osquery with Fleet enables live queries, and effective management of osquery infrastructure.
2017-01-31 06:22:37 +00:00
2017-11-14 07:34:22 +00:00
Documentation for Fleet can be found on [GitHub](./docs/README.md).
2016-08-10 15:31:27 +00:00
**Fleet Dashboard**
![Screenshot of dashboard](./assets/images/dashboard-screenshot.png)
**Live Queries**
![Screenshot of live query interface](./assets/images/query-screenshot.png)
**Scheduled Query/Pack Editor**
![Screenshot of pack editor](./assets/images/pack-screenshot.png)
2017-01-31 06:22:37 +00:00
## Using Fleet
2017-01-31 06:22:37 +00:00
2017-11-14 07:34:22 +00:00
#### The CLI
If you're interested in learning about the `fleetctl` CLI and flexible osquery deployment file format, see the [CLI Documentation](./docs/cli/README.md).
2017-11-14 07:34:22 +00:00
#### Deploying Osquery and Fleet
Resources for deploying osquery to hosts, deploying the Fleet server, installing Fleet's infrastructure dependencies, etc. can all be found in the [Infrastructure Documentation](./docs/infrastructure/README.md).
#### Accessing The Fleet API
If you are interested in accessing the Fleet REST API in order to programmatically interact with your osquery installation, please see the [API Documentation](./docs/api/README.md).
2018-05-08 01:53:53 +00:00
#### The Web Dashboard
Information about using the Kolide web dashboard can be found in the [Dashboard Documentation](./docs/dashboard/README.md).
## Developing Fleet
2017-11-14 07:34:22 +00:00
#### Development Documentation
If you're interested in interacting with the Kolide source code, you will find information on modifying and building the code in the [Development Documentation](./docs/development/README.md).
If you have any questions, please create a [GitHub Issue](https://github.com/kolide/fleet/issues/new).
## Community
#### Chat
Please join us in the #kolide channel on [Osquery Slack](https://osquery.slack.com/join/shared_invite/zt-h29zm0gk-s2DBtGUTW4CFel0f0IjTEw#/).
#### Community Projects
Below are some projects created by Kolide community members. Please submit a pull request if you'd like your project featured.
- [davidrecordon/terraform-aws-kolide-fleet](https://github.com/davidrecordon/terraform-aws-kolide-fleet) - Deploy Fleet into AWS using Terraform.
- [deeso/fleet-deployment](https://github.com/deeso/fleet-deployment) - Install Fleet on a Ubuntu box.
- [gjyoung1974/kolide-fleet-chart](https://github.com/gjyoung1974/kolide-fleet-chart) - Kubernetes Helm chart for deploying Fleet.
2018-05-08 21:08:56 +00:00
2019-07-08 13:32:04 +00:00
## Kolide SaaS
2018-05-08 21:08:56 +00:00
Looking for the quickest way to try out osquery on your fleet? Not sure which queries to run? Don't want to manage your own data pipeline?
2019-07-08 13:32:04 +00:00
Try our [osquery SaaS platform](https://kolide.com/?utm_source=oss&utm_medium=readme&utm_campaign=fleet) providing insights, alerting, fleet management and user-driven security tools. We also support advanced aggregation of osquery results for power users. Get started with your 30-day free trial [today](https://k2.kolide.com/signup?utm_source=oss&utm_medium=readme&utm_campaign=fleet).
[![Rube](./assets/images/rube.png)](https://kolide.com/fleet)