Update README.md (#153)

* Update README.md

* Edit link to osquery directory

* Update README.md

* Update README.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
This commit is contained in:
Mike McNeil 2020-12-29 13:00:36 -06:00 committed by GitHub
parent 5b67e7e551
commit c8a7756296
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,75 +1,81 @@
# Fleet [![CircleCI](https://circleci.com/gh/fleetdm/fleet/tree/master.svg?style=svg)](https://circleci.com/gh/fleetdm/fleet/tree/master) [![Go Report Card](https://goreportcard.com/badge/github.com/fleetdm/fleet)](https://goreportcard.com/report/github.com/fleetdm/fleet) <h1><img width="200" alt="Fleet logo, landscape, dark text, transparent background" src="https://user-images.githubusercontent.com/618009/103300491-9197e280-49c4-11eb-8677-6b41027be800.png"></h1>
#### [Website](https://fleetdm.com/) &nbsp; [News](http://twitter.com/fleetctl) &nbsp; [Report a bug](https://github.com/fleetdm/fleet/issues/new)
[![CircleCI](https://circleci.com/gh/fleetdm/fleet/tree/master.svg?style=svg)](https://circleci.com/gh/fleetdm/fleet/tree/master) &nbsp; [![Go Report Card](https://goreportcard.com/badge/github.com/fleetdm/fleet)](https://goreportcard.com/report/github.com/fleetdm/fleet) &nbsp; [![Twitter Follow](https://img.shields.io/twitter/follow/fleetctl.svg?style=social&maxAge=3600)](https://twitter.com/fleetctl)
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. 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](https://user-images.githubusercontent.com/618009/98254443-eaf21100-1f41-11eb-9e2c-63a0545601f3.jpg)
:tada: Announcing the transition of Fleet to a new independent entity :tada: ## Try Fleet
Please check out [the blog post](https://medium.com/fleetdm/a-new-fleet-d4096c7de978) 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). #### With [Node.js installed](https://nodejs.org/en/download/):
```bash
## Preview Fleet # Get the Fleet command-line tool
#### Get the latest release of the fleetctl CLI tool
With [node installed](https://nodejs.org/en/download/):
```
npm install -g fleetctl npm install -g fleetctl
``` ```
#### Set up a preview deployment of the Fleet server #### With [Docker installed](https://docs.docker.com/get-docker/):
```bash
With [docker installed](https://docs.docker.com/get-docker/): # Run a local demo of the Fleet server
```
fleetctl preview fleetctl preview
``` ```
Preview Fleet at https://localhost:8412. A local copy of the Fleet server is now running at https://localhost:8412.
#### Add containerized hosts to your preview deployment #### Adding hosts
The [`osquery`](./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: Now that you've finished setting up Fleet, you will want to enroll a server, container, or laptop so you have something to run queries against.
``` shell
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 > Fleet comes with simulated hosts you can use for demo purposes. <!-- TODO: simplify this step -->
>
> First, finish setting up Fleet in the browser and retrieve your "Enroll Secret" by clicking the "Add New Host" button in the Fleet dashboard.
>
> Then after cloning this repository, `cd` into the [`osquery/`](./tools/osquery) directory:
> ```shell
> cd osquery/
> ```
>
> This directory contains configuration that can start up Docker containers running osquery agents. To start them up:
> ```shell
> ENROLL_SECRET=<paste your enroll secret here> docker-compose up
> ```
>
> Now navigate back to https://localhost:8412 or refresh to see your new hosts in Fleet!
<img alt="Screenshot of query editor" src="https://user-images.githubusercontent.com/618009/101847266-769a2700-3b18-11eb-9109-7f1320ed5c45.png"/> #### Your first query
Ready to run your first query? Target some of your sample hosts and try it out:
<img width="500" alt="Screenshot of query editor" src="https://user-images.githubusercontent.com/618009/101847266-769a2700-3b18-11eb-9109-7f1320ed5c45.png"/>
<!-- todo: update other screenshots ## Team
**Fleet Dashboard**
![Screenshot of dashboard](./assets/images/dashboard-screenshot.png)
**Live Queries** Fleet is [independently backed](https://linkedin.com/company/fleetdm) and actively maintained with the help of many amazing [contributors](https://github.com/fleetdm/fleet/graphs/contributors).
![Screenshot of live query interface](./assets/images/query-screenshot.png)
> **:tada: Announcing the transition of Fleet to a new independent entity :tada:**
>
> Please check out [the blog post](https://medium.com/fleetdm/a-new-fleet-d4096c7de978) 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).
**Scheduled Query/Pack Editor**
![Screenshot of pack editor](./assets/images/pack-screenshot.png)
-->
## Documentation ## Documentation
Documentation for Fleet can be found [here on GitHub](./docs/README.md). Documentation for Fleet can be found [here on GitHub](./docs/README.md).
<!-- TODO: "#### Contributing" as one-liner with link to best jumping off point in docs -->
<!-- TODO: "#### Production deployment" as one-liner with link to best jumping off point in docs -->
## Community ## Community
#### Chat #### Chat
Please join us in the #fleet channel on [osquery Slack](https://osquery.slack.com/join/shared_invite/zt-h29zm0gk-s2DBtGUTW4CFel0f0IjTEw#/). Please join us in the #fleet channel on [osquery Slack](https://osquery.slack.com/join/shared_invite/zt-h29zm0gk-s2DBtGUTW4CFel0f0IjTEw#/).
#### Community Projects #### Community projects
Below are some projects created by Fleet community members. Please submit a pull request if you'd like your project featured. Below are some projects created by Fleet community members. Please submit a pull request if you'd like your project featured.
- [Kolide](https://kolide.com) is a cloud-hosted, user-driven security SaaS application. To be clear: Kolide ≠ Fleet. Kolide is well-executed, a great commercial tool, and they offer a 30-day free trial. - [Kolide Cloud ("K2")](https://kolide.com) is a cloud-hosted, user-driven security SaaS application. To be clear: Kolide ≠ Fleet.
- [davidrecordon/terraform-aws-kolide-fleet](https://github.com/davidrecordon/terraform-aws-kolide-fleet) - Deploy Fleet into AWS using Terraform. - [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. - [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. - [gjyoung1974/kolide-fleet-chart](https://github.com/gjyoung1974/kolide-fleet-chart) - Kubernetes Helm chart for deploying Fleet.
<a href="https://fleetdm.com"><img alt="Banner featuring a futuristic cloud city with the Fleet logo" src="https://user-images.githubusercontent.com/618009/98254443-eaf21100-1f41-11eb-9e2c-63a0545601f3.jpg"/></a>