empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 08:55:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Corrections in configuration documentation (#829)

Browse Source
This commit is contained in:
Zach Wasserman 2021-05-21 08:41:13 -07:00 committed by GitHub
parent 6fa518a300
commit b3a2a0496d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/3-Deployment/2-Configuration.md
View File

@ -184,6 +184,7 @@ The password to use when connecting to the MySQL instance.
File path to a file that contains the password to use when connecting to the MySQL instance. File path to a file that contains the password to use when connecting to the MySQL instance.
- Default value: `""` - Default value: `""`
- Environment variable: `FLEET_MYSQL_PASSWORD_PATH`
- Config file format: - Config file format:
``` ```
@ -335,7 +336,7 @@ The database to use when connecting to the Redis instance.
redis: redis:
database: 14 database: 14
``` ```
###### `redis_duplicate_results` ###### `redis_duplicate_results`
Whether or not to duplicate Live Query results to another Redis channel named `LQDuplicate`. This is useful in a scenario that would involve shipping the Live Query results outside of Fleet, near-realtime. Whether or not to duplicate Live Query results to another Redis channel named `LQDuplicate`. This is useful in a scenario that would involve shipping the Live Query results outside of Fleet, near-realtime.
@ -470,11 +471,12 @@ The [JWT](https://jwt.io/) key to use when signing and validating session keys.
File path to a file that contains the [JWT](https://jwt.io/) key to use when signing and validating session keys. File path to a file that contains the [JWT](https://jwt.io/) key to use when signing and validating session keys.
- Default value: `""` - Default value: `""`
- Environment variable: `FLEET_AUTH_JWT_KEY_PATH`
- Config file format: - Config file format:
``` ```
auth: auth:
jwt_key_path: '/run/secrets/fleetdm-jwt-token jwt_key_path: '/run/secrets/fleetdm-jwt-token'
``` ```
##### `auth_bcrypt_cost` ##### `auth_bcrypt_cost`
@ -482,7 +484,7 @@ File path to a file that contains the [JWT](https://jwt.io/) key to use when sig
The bcrypt cost to use when hashing user passwords. The bcrypt cost to use when hashing user passwords.
- Default value: `12` - Default value: `12`
- Environment variable: `FLEET_AUTH_BCRYT_COST` - Environment variable: `FLEET_AUTH_BCRYPT_COST`
- Config file format: - Config file format:
``` ```
@ -523,7 +525,7 @@ Size of generated app tokens.
How long invite tokens should be valid for. How long invite tokens should be valid for.
- Default value: `5 days` - Default value: `5 days`
- Environment variable: `FLEET_APP_TOKEN_VALIDITY_PERIOD` - Environment variable: `FLEET_APP_INVITE_TOKEN_VALIDITY_PERIOD`
- Config file format: - Config file format:
``` ```
@ -600,7 +602,7 @@ The cooldown period for host enrollment. If a host (uniquely identified by the `
This flag can be used to control load on the database in scenarios in which many hosts are using the same identifier. Often configuring `osquery_host_identifier` to `instance` may be a better solution. This flag can be used to control load on the database in scenarios in which many hosts are using the same identifier. Often configuring `osquery_host_identifier` to `instance` may be a better solution.
- Default value: `0` (off) - Default value: `0` (off)
- Environment variable: `FLEET_ENROLL_COOLDOWN` - Environment variable: `FLEET_OSQUERY_ENROLL_COOLDOWN`
- Config file format: - Config file format:
``` ```
@ -1202,7 +1204,7 @@ The identifier of the pubsub topic that osquery status logs will be published to
This flag only has effect if `osquery_status_log_plugin` is set to `pubsub`. This flag only has effect if `osquery_status_log_plugin` is set to `pubsub`.
Add Pub/Sub attributes to messages. When enabled, the plugin parses the osquery result Add Pub/Sub attributes to messages. When enabled, the plugin parses the osquery result
messages, and adds the following Pub/Sub message attributes: messages, and adds the following Pub/Sub message attributes:
- `name` - the `name` attribute from the message body - `name` - the `name` attribute from the message body