diff --git a/README.md b/README.md index 91c0edc34e..6938409114 100644 --- a/README.md +++ b/README.md @@ -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) +

Fleet logo, landscape, dark text, transparent background

+ +#### [Website](https://fleetdm.com/)   [News](http://twitter.com/fleetctl)   [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)   [![Go Report Card](https://goreportcard.com/badge/github.com/fleetdm/fleet)](https://goreportcard.com/report/github.com/fleetdm/fleet)   [![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. -![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). - -## Preview Fleet - -#### Get the latest release of the fleetctl CLI tool - -With [node installed](https://nodejs.org/en/download/): -``` +#### With [Node.js installed](https://nodejs.org/en/download/): +```bash +# Get the Fleet command-line tool npm install -g fleetctl ``` -#### Set up a preview deployment of the Fleet server - -With [docker installed](https://docs.docker.com/get-docker/): -``` +#### With [Docker installed](https://docs.docker.com/get-docker/): +```bash +# Run a local demo of the Fleet server 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 -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. +#### Adding hosts -With your "Enroll Secret" copied: -``` shell -cd fleet-preview/osquery -ENROLL_SECRET= docker-compose up -``` -Refresh the page to see the containerized hosts populate the Fleet dashboard. +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. -## Query editor +> Fleet comes with simulated hosts you can use for demo purposes. +> +> 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= docker-compose up +> ``` +> +> Now navigate back to https://localhost:8412 or refresh to see your new hosts in Fleet! -Screenshot of query editor +#### Your first query +Ready to run your first query? Target some of your sample hosts and try it out: +Screenshot of query editor - ## Documentation Documentation for Fleet can be found [here on GitHub](./docs/README.md). + + + ## Community #### Chat 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. -- [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. - [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. +Banner featuring a futuristic cloud city with the Fleet logo