From d2f8e16d7e234aaae83d8126b345bae6c48d3408 Mon Sep 17 00:00:00 2001 From: Martin Angers Date: Tue, 5 Sep 2023 08:53:51 -0400 Subject: [PATCH] Add documentation for env var preventing orbit from deleting the script directory (#13602) --- docs/Using Fleet/fleetd.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/Using Fleet/fleetd.md b/docs/Using Fleet/fleetd.md index 04cea6f44a..8d985557f9 100644 --- a/docs/Using Fleet/fleetd.md +++ b/docs/Using Fleet/fleetd.md @@ -152,11 +152,17 @@ The following command-line flags allow you to configure an osquery installer fur | --verbose | Log detailed information when building the package (default: false) | | --help, -h | show help (default: `false`) | +In addition to the command-line flags, the following environment variables can alter the behaviour of fleetd. + +| Environment variable | Options | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| FLEET\_PREVENT\_SCRIPT\_TEMPDIR\_DELETION | If set to a non-empty value, prevents deletion of the temporary directory where the scripts being executed are stored. Those are located in the temporary directory of the system, under a sub-directory starting with `fleet-`. | + #### Fleet Desktop [Fleet Desktop](./Fleet-desktop.md) is a menu bar icon available on macOS, Windows, and Linux that gives your end users visibility into the security posture of their machine. -You can include Fleet Desktop in the orbit package by including the `--fleet-desktop`option. +You can include Fleet Desktop in the orbit package by including the `--fleet-desktop`option. #### Update channels @@ -328,7 +334,7 @@ go run github.com/fleetdm/fleet/v4/orbit/cmd/orbit \ ``` Or, using a `flagfile.txt` for osqueryd: -```sh +```sh go run github.com/fleetdm/fleet/v4/orbit/cmd/orbit \ --dev-mode \ --disable-updates \