From 3bc043cd8cc5b6438d14eb7ad75fde32887b9a24 Mon Sep 17 00:00:00 2001 From: Katheryn Satterlee Date: Mon, 24 Oct 2022 07:46:40 -0500 Subject: [PATCH] Add endpoints for desktop and fleetctl to FAQ (#8247) * Add endpoints for desktop and fleetctl * Update docs/Deploying/FAQ.md Co-authored-by: Guillaume Ross --- docs/Deploying/FAQ.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/Deploying/FAQ.md b/docs/Deploying/FAQ.md index ac3b74444d..e52d36d54e 100644 --- a/docs/Deploying/FAQ.md +++ b/docs/Deploying/FAQ.md @@ -258,8 +258,19 @@ Check out the [documentation on running database migrations](./Upgrading-Fleet.m ## What API endpoints should I expose to the public internet? -If you would like to manage hosts that can travel outside your VPN or intranet we recommend only exposing the "/api/v1/osquery" endpoint to the public internet. +If you would like to manage hosts that can travel outside your VPN or intranet we recommend only exposing the `/api/v1/osquery` endpoint to the public internet. +If you are using Fleet Desktop and want it to work on remote devices, the bare minimum API to expose is `/api/latest/fleet/device/*/desktop`. This minimal endpoint will only provide the number of failing policies. + +For full Fleet Desktop functionality, `/api/fleet/orbit/*` and`/api/fleet/device/ping` must also be exposed. + +If you would like to use the fleetctl CLI from outside of your network, the following endpoints will also need to be exposed for `fleetctl`: + +- /api/setup +- /api/v1/setup +- /api/osquery/* +- /api/latest/fleet/* +- /api/v1/fleet/* ## What is the minimum version of MySQL required by Fleet? Fleet requires at least MySQL version 5.7.