From 9b9fcd1521296816ffd24cd0699b27e6273dd711 Mon Sep 17 00:00:00 2001 From: Mike McNeil Date: Fri, 19 Mar 2021 18:46:40 -0500 Subject: [PATCH 1/3] closes #503 w/ readme updates --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b216d4896d5..4c9206ab1f8 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,32 @@ 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 + +# Edit your Docker config +# • remove "credsStore": "desktop" +# • remove the preceding comma (,) to ensure well-formed JSON +nano ~/.docker/config.json + # Run a local demo of the Fleet server 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. -#### Your first query +> **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: 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](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). From c6d346ee6cda1fd6189464ef9880e22d7164a6d0 Mon Sep 17 00:00:00 2001 From: Mike McNeil Date: Fri, 19 Mar 2021 19:06:23 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c9206ab1f8..3d6b6b69fa1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Fleet is the most widely used open source osquery manager. Deploying osquery wi # Install the Fleet command-line tool npm install -g fleetctl -# Edit your Docker config +# Edit your Docker config (Required on macOS w/ default Docker install.) # • remove "credsStore": "desktop" # • remove the preceding comma (,) to ensure well-formed JSON nano ~/.docker/config.json From dc0fde0fbe1b8face805b1778ede7f4cba4d2221 Mon Sep 17 00:00:00 2001 From: Mike McNeil Date: Fri, 19 Mar 2021 22:25:16 -0500 Subject: [PATCH 3/3] Recommend `sudo` instead See https://github.com/fleetdm/fleet/pull/505#discussion_r598053872 for more info. --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index 659c1eea2ba..37ff9d686af 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,8 @@ Fleet is the most widely used open source osquery manager. Deploying osquery wi ```bash # Install the Fleet command-line tool npm install -g fleetctl - -# Edit your Docker config (Required on macOS w/ default Docker install.) -# • remove "credsStore": "desktop" -# • remove the preceding comma (,) to ensure well-formed JSON -nano ~/.docker/config.json - # Run a local demo of the Fleet server -fleetctl preview +sudo fleetctl preview ``` A local demo copy of the Fleet server is now running at https://localhost:8412.