Skip to content

closes #503 w/ readme updates #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikermcneil merged 4 commits into from
Mar 20, 2021
Merged

closes #503 w/ readme updates #505

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b9fcd1
closes #503 w/ readme updates
mikermcneil Mar 19, 2021
c6d346e
Update README.md
mikermcneil Mar 20, 2021
aba6cac
Merge branch 'master' into mikermcneil-patch-2
mikermcneil Mar 20, 2021
dc0fde0
Recommend `sudo` instead
mikermcneil Mar 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,26 @@ Fleet is the most widely used open source osquery manager. Deploying osquery wi

## Try Fleet

#### With [Node.js](https://nodejs.org/en/download/), [Docker](https://docs.docker.com/get-docker/), and [Docker Compose](https://docs.docker.com/compose/install/) installed:
#### With [Node.js](https://nodejs.org/en/download/) and [Docker](https://docs.docker.com/get-docker/) installed:

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

A local copy of the Fleet server is now running at https://localhost:8412. The preview experience will start sample Linux hosts connected to this server.
A local demo copy of the Fleet server is now running at https://localhost:8412.

> **Seeing a warning in your browser?** You can safely skirt the browser warning ("Your connection is not private") when accessing Fleet locally over https. For example in Google Chrome, visit `chrome://flags/#allow-insecure-localhost` to enable self-signed certs on localhost. Then [refresh Fleet](https://localhost:8412) and click through this warning using the "Advanced" option.

#### Your first query
Ready to run your first query? Target some of your sample hosts and try it out:
<img width="800" alt="Screenshot of query editor" src="https://user-images.githubusercontent.com/618009/111853677-099de680-88ea-11eb-90bb-f5cd787f1f15.png"/>

#### Using real devices
For convenience, the demo includes a few simulated Linux hosts. To query a real device, [install the osquery agent](https://github.com/fleetdm/orbit).

## Team
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).

Expand Down