2020-12-24 22:00:22 +00:00
# Configuration
- [Configuring the Fleet binary ](#configuring-the-fleet-binary )
- [High-level configuration overview ](#high-level-configuration-overview )
- [Commands ](#commands )
- [Options ](#options )
- [Managing osquery configurations ](#managing-osquery-configurations )
- [Running with systemd ](#running-with-systemd )
- [Configuring Single Sign On ](#configuring-single-sign-on )
- [Identity Provider (IDP) Configuration ](#identity-provider-(IDP )-configuration)
- [Fleet SSO Configuration ](#fleet-sso-configuration )
- [Creating SSO Users in Fleet ](#creating-sso-users-in-fleet )
## Configuring the Fleet binary
2017-01-31 01:51:10 +00:00
2017-10-06 01:33:41 +00:00
For information on how to run the `fleet` binary, detailed usage information can be found by running `fleet --help` . This document is a more detailed version of the information presented in the help output text. If you prefer to use a CLI instead of a web browser, we hope that you like the binary interface to the Fleet application!
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
### High-level configuration overview
2017-01-31 01:51:10 +00:00
2017-09-21 22:51:26 +00:00
To get the most out of running the Fleet server, it is helpful to establish a mutual understanding of what the desired architecture looks like and what it's trying to accomplish.
2017-01-31 01:51:10 +00:00
2017-09-21 22:51:26 +00:00
Your Fleet server's two main purposes are:
2017-01-31 01:51:10 +00:00
- To serve as your [osquery TLS server ](https://osquery.readthedocs.io/en/stable/deployment/remote/ )
2020-12-10 19:26:00 +00:00
- To serve the Fleet web UI, which allows you to manage osquery configuration, query hosts, etc.
2017-01-31 01:51:10 +00:00
2017-09-21 22:51:26 +00:00
The Fleet server allows you persist configuration, manage users, etc. Thus, it needs a database. Fleet uses MySQL and requires you to supply configurations to connect to a MySQL server. Fleet also uses Redis to perform some more high-speed data access action throughout the lifecycle of the application (for example, distributed query result ingestion). Thus, Fleet also requires that you supply Redis connention configurations.
2017-01-31 01:51:10 +00:00
2017-10-30 20:11:03 +00:00
Since Fleet is a web application, when you run Fleet there are some other configurations that are worth defining, such as:
2017-01-31 01:51:10 +00:00
2017-09-21 22:51:26 +00:00
- The TLS certificates that Fleet should use to terminate TLS.
2017-01-31 01:51:10 +00:00
- The [JWT ](https://jwt.io/ ) Key which is used to sign and verify session tokens.
2017-09-21 22:51:26 +00:00
Since Fleet is an osquery TLS server, you are also able to define configurations that can customize your experience there, such as:
2017-01-31 01:51:10 +00:00
- The destination of the osquery status and result logs on the local filesystem
- Various details about the refresh/check-in intervals for your hosts
2020-12-24 22:00:22 +00:00
### Commands
2017-01-31 01:51:10 +00:00
2017-10-06 01:33:41 +00:00
The `fleet` binary contains several "commands". Similarly to how `git` has many commands (`git status`, `git commit` , etc), the `fleet` binary accepts the following commands:
2017-01-31 01:51:10 +00:00
2017-10-06 01:33:41 +00:00
- `fleet prepare db`
- `fleet serve`
- `fleet version`
- `fleet config_dump`
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
### Options
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
#### How do you specify options?
2017-01-31 01:51:10 +00:00
In order of precedence, options can be specified via:
- A configuration file (in YAML format)
- Environment variables
- Command-line flags
2021-02-11 23:36:58 +00:00
Note: We have deprecated `KOLIDE_` environment variables and will remove them in the Fleet 4.0 release. Please migrate all environment variables to `FLEET_` .
2017-09-21 22:51:26 +00:00
For example, all of the following ways of launching Fleet are equivalent:
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
##### Using only CLI flags
2017-01-31 01:51:10 +00:00
```
2020-11-12 21:50:08 +00:00
/usr/bin/fleet serve \
--mysql_address=127.0.0.1:3306 \
--mysql_database=kolide \
--mysql_username=root \
--mysql_password=toor \
--redis_address=127.0.0.1:6379 \
--server_cert=/tmp/server.cert \
--server_key=/tmp/server.key \
--logging_json \
--auth_jwt_key=changeme
2017-01-31 01:51:10 +00:00
```
2020-12-24 22:00:22 +00:00
##### Using only environment variables
2017-01-31 01:51:10 +00:00
```
2021-02-11 23:36:58 +00:00
FLEET_MYSQL_ADDRESS=127.0.0.1:3306 \
FLEET_MYSQL_DATABASE=kolide \
FLEET_MYSQL_USERNAME=root \
FLEET_MYSQL_PASSWORD=toor \
FLEET_REDIS_ADDRESS=127.0.0.1:6379 \
FLEET_SERVER_CERT=/tmp/server.cert \
FLEET_SERVER_KEY=/tmp/server.key \
FLEET_LOGGING_JSON=true \
FLEET_AUTH_JWT_KEY=changeme \
2020-11-12 21:50:08 +00:00
/usr/bin/fleet serve
2017-01-31 01:51:10 +00:00
```
2020-12-24 22:00:22 +00:00
##### Using a config file
2017-01-31 01:51:10 +00:00
```
2020-11-12 21:50:08 +00:00
echo '
2017-01-31 01:51:10 +00:00
mysql:
address: 127.0.0.1:3306
database: kolide
username: root
password: toor
redis:
address: 127.0.0.1:6379
server:
cert: /tmp/server.cert
key: /tmp/server.key
logging:
json: true
2019-01-17 19:26:44 +00:00
auth:
jwt_key: changeme
2017-01-31 01:51:10 +00:00
' > /tmp/kolide.yml
2020-11-12 21:50:08 +00:00
fleet serve --config /tmp/kolide.yml
2017-01-31 01:51:10 +00:00
```
2020-12-24 22:00:22 +00:00
#### What are the options?
2017-01-31 01:51:10 +00:00
2021-02-11 23:36:58 +00:00
Note that all option names can be converted consistently from flag name to environment variable and visa-versa. For example, the `--mysql_address` flag would be the `FLEET_MYSQL_ADDRESS` . Further, specifying the `mysql_address` option in the config would follow the pattern:
2017-01-31 01:51:10 +00:00
```
mysql:
address: 127.0.0.1:3306
```
2021-02-11 23:36:58 +00:00
Basically, just capitalize the option and prepend `FLEET_` to it in order to get the environment variable. The conversion works the same the opposite way.
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
##### MySQL
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `mysql_address`
2017-01-31 01:51:10 +00:00
2017-09-21 22:51:26 +00:00
The address of the MySQL server which Fleet should connect to. Include the hostname and port.
2017-01-31 01:51:10 +00:00
- Default value: `localhost:3306`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_ADDRESS`
2017-01-31 01:51:10 +00:00
- Config file format:
```
mysql:
address: localhost:3306
```
2020-12-24 22:00:22 +00:00
###### `mysql_database`
2017-01-31 01:51:10 +00:00
2017-09-21 22:51:26 +00:00
The name of the MySQL database which Fleet will use.
2017-01-31 01:51:10 +00:00
- Default value: `kolide`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_DATABASE`
2017-01-31 01:51:10 +00:00
- Config file format:
```
mysql:
database: kolide
```
2020-12-24 22:00:22 +00:00
###### `mysql_username`
2017-01-31 01:51:10 +00:00
The username to use when connecting to the MySQL instance.
- Default value: `kolide`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_USERNAME`
2017-01-31 01:51:10 +00:00
- Config file format:
```
mysql:
username: kolide
```
2020-12-24 22:00:22 +00:00
###### `mysql_password`
2017-01-31 01:51:10 +00:00
The password to use when connecting to the MySQL instance.
- Default value: `kolide`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_PASSWORD`
2017-01-31 01:51:10 +00:00
- Config file format:
```
mysql:
password: kolide
```
2021-01-04 15:58:43 +00:00
##### `mysql_password_path`
File path to a file that contains the password to use when connecting to the MySQL instance.
- Default value: `""`
- Config file format:
```
mysql:
password_path: '/run/secrets/fleetdm-mysql-password
```
##### `mysql_tls_ca`
2017-02-17 00:14:00 +00:00
The path to a PEM encoded certificate of MYSQL's CA for client certificate authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_TLS_CA`
2017-02-17 00:14:00 +00:00
- Config file format:
```
mysql:
2017-02-23 18:46:34 +00:00
tls_ca: /path/to/server-ca.pem
2017-02-17 00:14:00 +00:00
```
2020-12-24 22:00:22 +00:00
###### `mysql_tls_cert`
2017-02-17 00:14:00 +00:00
The path to a PEM encoded certificate use for tls authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_TLS_CERT`
2017-02-17 00:14:00 +00:00
- Config file format:
```
mysql:
2017-02-23 18:46:34 +00:00
tls_cert: /path/to/certificate.pem
2017-02-17 00:14:00 +00:00
```
2020-12-24 22:00:22 +00:00
###### `mysql_tls_key`
2017-02-17 00:14:00 +00:00
The path to a PEM encoded private key use for tls authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_TLS_KEY`
2017-02-17 00:14:00 +00:00
- Config file format:
```
mysql:
2017-02-23 18:46:34 +00:00
tls_key: /path/to/key.pem
2017-02-17 00:14:00 +00:00
```
2020-12-24 22:00:22 +00:00
###### `mysql_tls_config`
2017-02-17 00:14:00 +00:00
The tls value in a MYSQL DSN. Can be `true` ,`false`,`skip-verify` or the CN value of the certificate.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_TLS_CONFIG`
2017-02-17 00:14:00 +00:00
- Config file format:
```
mysql:
2017-02-23 18:46:34 +00:00
tls_config: true
2017-02-17 00:14:00 +00:00
```
2020-12-24 22:00:22 +00:00
###### `mysql_tls_server_name`
2017-02-17 00:14:00 +00:00
The server name or IP address used by the client certificate.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_TLS_SERVER_NAME`
2017-02-17 00:14:00 +00:00
- Config file format:
```
mysql:
servername: 127.0.0.1
```
2020-12-24 22:00:22 +00:00
###### `mysql_max_open_conns`
2018-11-01 21:43:24 +00:00
Maximum open connections to database
- Default value: 50
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_MAX_OPEN_CONNS`
2018-11-01 21:43:24 +00:00
- Config file format:
```
mysql:
max_open_conns: 50
```
2020-12-24 22:00:22 +00:00
###### `mysql_max_idle_conns`
2018-11-01 21:43:24 +00:00
Maximum idle connections to database. This value should be equal to or less than `mysql_max_open_conns`
- Default value: 50
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_MAX_IDLE_CONNS`
2018-11-01 21:43:24 +00:00
- Config file format:
```
mysql:
max_idle_conns: 50
```
2020-12-24 22:00:22 +00:00
###### `conn_max_lifetime`
2020-07-30 16:00:42 +00:00
Maximum amount of time, in seconds, a connection may be reused.
- Default value: 0 (Unlimited)
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_MYSQL_CONN_MAX_LIFETIME`
2020-07-30 16:00:42 +00:00
- Config file format:
```
mysql:
conn_max_lifetime: 50
```
2020-12-24 22:00:22 +00:00
##### Redis
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `redis_address`
2017-01-31 01:51:10 +00:00
2017-10-06 01:33:41 +00:00
The address of the Redis server which Fleet should connect to. Include the hostname and port.
2017-01-31 01:51:10 +00:00
- Default value: `localhost:6379`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_REDIS_ADDRESS`
2017-01-31 01:51:10 +00:00
- Config file format:
```
redis:
address: 127.0.0.1:7369
```
2020-12-24 22:00:22 +00:00
###### `redis_password`
2017-01-31 01:51:10 +00:00
The password to use when connecting to the Redis instance.
- Default value: `<empty>`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_REDIS_PASSWORD`
2017-01-31 01:51:10 +00:00
- Config file format:
```
redis:
password: foobar
```
2020-12-24 22:00:22 +00:00
###### `redis_database`
2020-07-30 15:57:25 +00:00
The database to use when connecting to the Redis instance.
- Default value: `0`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_REDIS_DATABASE`
2020-07-30 15:57:25 +00:00
- Config file format:
```
redis:
database: 14
```
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
##### Server
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `server_address`
2017-01-31 01:51:10 +00:00
2019-01-24 17:39:32 +00:00
The address to serve the Fleet webserver.
2017-01-31 01:51:10 +00:00
- Default value: `0.0.0.0:8080`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SERVER_ADDRESS`
2017-01-31 01:51:10 +00:00
- Config file format:
```
server:
address: 0.0.0.0:443
```
2020-12-24 22:00:22 +00:00
###### `server_cert`
2017-01-31 01:51:10 +00:00
The TLS cert to use when terminating TLS.
- Default value: `./tools/osquery/kolide.crt`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SERVER_CERT`
2017-01-31 01:51:10 +00:00
- Config file format:
```
server:
cert: /tmp/kolide.crt
```
2020-12-24 22:00:22 +00:00
###### `server_key`
2017-01-31 01:51:10 +00:00
The TLS key to use when terminating TLS.
- Default value: `./tools/osquery/kolide.key`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SERVER_KEY`
2017-01-31 01:51:10 +00:00
- Config file format:
```
server:
key: /tmp/kolide.key
```
2020-12-24 22:00:22 +00:00
###### `server_tls`
2017-01-31 01:51:10 +00:00
Whether or not the server should be served over TLS.
- Default value: `true`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SERVER_TLS`
2017-01-31 01:51:10 +00:00
- Config file format:
```
server:
tls: false
```
2020-12-24 22:00:22 +00:00
###### `server_tls_compatibility`
2019-01-07 23:03:51 +00:00
2021-01-20 16:34:14 +00:00
Configures the TLS settings for compatibility with various user agents. Options are `modern` and `intermediate` . These correspond to the compatibility levels [defined by the Mozilla OpSec team ](https://wiki.mozilla.org/index.php?title=Security/Server_Side_TLS&oldid=1229478 ) (updated July 24, 2020).
2019-01-07 23:03:51 +00:00
2021-02-03 19:48:48 +00:00
- Default value: `intermediate`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SERVER_TLS_COMPATIBILITY`
2019-01-07 23:03:51 +00:00
- Config file format:
```
server:
2021-02-03 19:48:48 +00:00
tlsprofile: intermediate
2019-01-07 23:03:51 +00:00
```
2021-02-03 19:48:48 +00:00
Please note this option has an inconsistent key name in the config file. This will be fixed in Fleet 4.0.0.
2019-01-07 23:03:51 +00:00
2020-12-24 22:00:22 +00:00
###### `server_url_prefix`
2019-10-16 23:40:45 +00:00
Sets a URL prefix to use when serving the Fleet API and frontend. Prefixes should be in the form `/apps/fleet` (no trailing slash).
Note that some other configurations may need to be changed when modifying the URL prefix. In particular, URLs that are provided to osquery via flagfile, the configuration served by Fleet, the URL prefix used by `fleetctl` , and the redirect URL set with an SSO Identity Provider.
- Default value: Empty (no prefix set)
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SERVER_URL_PREFIX`
2019-10-16 23:40:45 +00:00
- Config file format:
```
server:
url_prefix: /apps/fleet
```
2019-01-07 23:03:51 +00:00
2020-12-24 22:00:22 +00:00
##### Auth
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `auth_jwt_key`
2017-01-31 01:51:10 +00:00
2017-09-21 22:51:26 +00:00
The [JWT ](https://jwt.io/ ) key to use when signing and validating session keys. If this value is not specified the Fleet server will fail to start and a randomly generated key will be provided for use.
2017-01-31 01:51:10 +00:00
2017-04-12 22:05:56 +00:00
- Default value: None
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_AUTH_JWT_KEY`
2017-01-31 01:51:10 +00:00
- Config file format:
```
auth:
jwt_key: JVnKw7CaUdJjZwYAqDgUHVYP
```
2021-01-04 15:58:43 +00:00
##### `auth_jwt_key_path`
File path to a file that contains the [JWT ](https://jwt.io/ ) key to use when signing and validating session keys.
- Default value: `""`
- Config file format:
```
auth:
jwt_key_path: '/run/secrets/fleetdm-jwt-token
```
##### `auth_bcrypt_cost`
2017-01-31 01:51:10 +00:00
The bcrypt cost to use when hashing user passwords.
- Default value: `12`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_AUTH_BCRYT_COST`
2017-01-31 01:51:10 +00:00
- Config file format:
```
auth:
bcrypt_cost: 14
```
2020-12-24 22:00:22 +00:00
###### `auth_salt_key_size`
2017-01-31 01:51:10 +00:00
The key size of the salt which is generated when hashing user passwords.
- Default value: `24`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_AUTH_SALT_KEY_SIZE`
2017-01-31 01:51:10 +00:00
- Config file format:
```
auth:
salt_key_size: 36
```
2020-12-24 22:00:22 +00:00
##### App
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `app_token_key_size`
2017-01-31 01:51:10 +00:00
2017-01-31 05:13:08 +00:00
Size of generated app tokens.
2017-01-31 01:51:10 +00:00
- Default value: `24`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_APP_TOKEN_KEY_SIZE`
2017-01-31 01:51:10 +00:00
- Config file format:
```
app:
token_key_size: 36
```
2020-12-24 22:00:22 +00:00
###### `app_invite_token_validity_period`
2017-01-31 01:51:10 +00:00
How long invite tokens should be valid for.
- Default value: `5 days`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_APP_TOKEN_VALIDITY_PERIOD`
2017-01-31 01:51:10 +00:00
- Config file format:
```
app:
invite_token_validity_period: 1d
```
2020-12-24 22:00:22 +00:00
##### Session
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `session_key_size`
2017-01-31 01:51:10 +00:00
The size of the session key.
- Default value: `64`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SESSION_KEY_SIZE`
2017-01-31 01:51:10 +00:00
- Config file format:
```
session:
key_size: 48
```
2020-12-24 22:00:22 +00:00
###### `session_duration`
2017-01-31 01:51:10 +00:00
The amount of time that a session should last for.
- Default value: `90 days`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_SESSION_DURATION`
2017-01-31 01:51:10 +00:00
- Config file format:
```
session:
duration: 30d
```
2020-12-24 22:00:22 +00:00
##### Osquery
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `osquery_node_key_size`
2017-01-31 01:51:10 +00:00
The size of the node key which is negotiated with `osqueryd` clients.
- Default value: `24`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_NODE_KEY_SIZE`
2017-01-31 01:51:10 +00:00
- Config file format:
```
osquery:
node_key_size: 36
```
2021-03-09 02:35:17 +00:00
###### `osquery_host_identifier`
The identifier to use when determining uniqueness of hosts.
Options are `instance` (default), `uuid` , `hostname` , or `provided` .
This setting works in combination with the `--host_identifier` flag in osquery. In most deployments, using `instance` will be the best option. The flag defaults to `provided` -- preserving the existing behavior of Fleet's handling of host identifiers -- using the identifier provided by osquery. `instance` , `uuid` , and `hostname` correspond to the same meanings as for osquery's `--host_identifier` flag.
- Default value: `provided`
- Environment variable: `FLEET_OSQUERY_HOST_IDENTIFIER`
- Config file format:
```
osquery:
host_identifier: uuid
```
2019-04-08 18:47:15 +00:00
2020-12-24 22:00:22 +00:00
###### `osquery_label_update_interval`
2019-04-08 18:47:15 +00:00
The interval at which Fleet will ask osquery agents to update their results for label queries.
2020-03-02 19:08:08 +00:00
Setting this to a higher value can reduce baseline load on the Fleet server in larger deployments.
2019-04-08 18:47:15 +00:00
- Default value: `1h`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_LABEL_UPDATE_INTERVAL`
2019-04-08 18:47:15 +00:00
- Config file format:
```
osquery:
2020-03-02 19:08:08 +00:00
label_update_interval: 30m
```
2020-12-24 22:00:22 +00:00
###### `osquery_detail_update_interval`
2020-03-02 19:08:08 +00:00
The interval at which Fleet will ask osquery agents to update host details (such as uptime, hostname, network interfaces, etc.)
Setting this to a higher value can reduce baseline load on the Fleet server in larger deployments.
- Default value: `1h`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_DETAIL_UPDATE_INTERVAL`
2020-03-02 19:08:08 +00:00
- Config file format:
```
osquery:
detail_update_interval: 30m
2019-04-08 18:47:15 +00:00
```
2020-12-24 22:00:22 +00:00
###### `osquery_status_log_plugin`
2019-04-08 18:47:15 +00:00
Which log output plugin should be used for osquery status logs received from clients.
2021-02-24 18:02:26 +00:00
Options are `filesystem` , `firehose` , `kinesis` , `lambda` , `pubsub` , and `stdout` .
2019-04-08 18:47:15 +00:00
- Default value: `filesystem`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_STATUS_LOG_PLUGIN`
2019-04-08 18:47:15 +00:00
- Config file format:
```
osquery:
status_log_plugin: firehose
```
2020-12-24 22:00:22 +00:00
###### `osquery_result_log_plugin`
2019-04-08 18:47:15 +00:00
Which log output plugin should be used for osquery result logs received from clients.
2021-02-24 18:02:26 +00:00
Options are `filesystem` , `firehose` , `kinesis` , `lambda` , `pubsub` , and `stdout` .
2019-04-08 18:47:15 +00:00
- Default value: `filesystem`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_RESULT_LOG_PLUGIN`
2019-04-08 18:47:15 +00:00
- Config file format:
```
osquery:
result_log_plugin: firehose
```
2020-12-24 22:00:22 +00:00
###### `osquery_status_log_file`
2017-01-31 01:51:10 +00:00
2019-07-03 19:41:15 +00:00
DEPRECATED: Use filesystem_status_log_file.
2019-04-08 18:47:15 +00:00
2017-01-31 01:51:10 +00:00
The path which osquery status logs will be logged to.
- Default value: `/tmp/osquery_status`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_STATUS_LOG_FILE`
2017-01-31 01:51:10 +00:00
- Config file format:
```
osquery:
status_log_file: /var/log/osquery/status.log
```
2020-12-24 22:00:22 +00:00
###### `osquery_result_log_file`
2017-01-31 01:51:10 +00:00
2019-07-03 19:41:15 +00:00
DEPRECATED: Use filesystem_result_log_file.
2019-04-08 18:47:15 +00:00
2017-01-31 01:51:10 +00:00
The path which osquery result logs will be logged to.
- Default value: `/tmp/osquery_result`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_RESULT_LOG_FILE`
2017-01-31 01:51:10 +00:00
- Config file format:
```
osquery:
result_log_file: /var/log/osquery/result.log
```
2020-12-24 22:00:22 +00:00
###### `osquery_enable_log_rotation`
2017-04-03 21:48:50 +00:00
2019-04-08 18:47:15 +00:00
DEPRECATED: Use fileystem_enable_log_rotation.
2017-04-03 21:48:50 +00:00
This flag will cause the osquery result and status log files to be automatically
rotated when files reach a size of 500 Mb or an age of 28 days.
- Default value: `false`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_OSQUERY_ENABLE_LOG_ROTATION`
2017-04-03 21:48:50 +00:00
- Config file format:
```
osquery:
enable_log_rotation: true
```
2020-12-24 22:00:22 +00:00
##### Logging (Fleet server logging)
2017-01-31 01:51:10 +00:00
2020-12-24 22:00:22 +00:00
###### `logging_debug`
2017-01-31 01:51:10 +00:00
Whether or not to enable debug logging.
- Default value: `false`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_LOGGING_DEBUG`
2017-01-31 01:51:10 +00:00
- Config file format:
```
logging:
debug: true
```
2020-12-24 22:00:22 +00:00
###### `logging_json`
2017-01-31 01:51:10 +00:00
Whether or not to log in JSON.
- Default value: `false`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_LOGGING_JSON`
2017-01-31 01:51:10 +00:00
- Config file format:
```
logging:
json: true
```
2020-12-24 22:00:22 +00:00
###### `logging_disable_banner`
2017-01-31 01:51:10 +00:00
Whether or not to log the welcome banner.
- Default value: `false`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_LOGGING_DISABLE_BANNER`
2017-01-31 01:51:10 +00:00
- Config file format:
```
logging:
2020-09-09 20:32:13 +00:00
disable_banner: true
2017-01-31 01:51:10 +00:00
```
2019-04-08 18:47:15 +00:00
2020-12-24 22:00:22 +00:00
##### Filesystem
2019-04-08 18:47:15 +00:00
2020-12-24 22:00:22 +00:00
###### `filesystem_status_log_file`
2019-04-08 18:47:15 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `filesystem` (the default value).
The path which osquery status logs will be logged to.
- Default value: `/tmp/osquery_status`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FILESYSTEM_STATUS_LOG_FILE`
2019-04-08 18:47:15 +00:00
- Config file format:
```
filesystem:
status_log_file: /var/log/osquery/status.log
```
2020-12-24 22:00:22 +00:00
###### `filesystem_result_log_file`
2019-04-08 18:47:15 +00:00
This flag only has effect if `osquery_result_log_plugin` is set to `filesystem` (the default value).
The path which osquery result logs will be logged to.
- Default value: `/tmp/osquery_result`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FILESYSTEM_RESULT_LOG_FILE`
2019-04-08 18:47:15 +00:00
- Config file format:
```
filesystem:
result_log_file: /var/log/osquery/result.log
```
2020-12-24 22:00:22 +00:00
###### `filesystem_enable_log_rotation`
2019-04-08 18:47:15 +00:00
This flag only has effect if `osquery_result_log_plugin` or `osquery_status_log_plugin` are set to `filesystem` (the default value).
This flag will cause the osquery result and status log files to be automatically
rotated when files reach a size of 500 Mb or an age of 28 days.
- Default value: `false`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FILESYSTEM_ENABLE_LOG_ROTATION`
2019-04-08 18:47:15 +00:00
- Config file format:
```
filesystem:
enable_log_rotation: true
```
2020-12-24 22:00:22 +00:00
###### `filesystem_enable_log_compression`
2020-09-09 20:33:32 +00:00
This flag only has effect if `filesystem_enable_log_rotation` is set to `true` .
This flag will cause the rotated logs to be compressed with gzip.
- Default value: `false`
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FILESYSTEM_ENABLE_LOG_COMPRESSION`
2020-09-09 20:33:32 +00:00
- Config file format:
```
filesystem:
enable_log_compression: true
```
2020-12-24 22:00:22 +00:00
##### Firehose
2019-04-08 18:47:15 +00:00
2020-12-24 22:00:22 +00:00
###### `firehose_region`
2019-04-08 18:47:15 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `firehose` .
AWS region to use for Firehose connection
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FIREHOSE_REGION`
2019-04-08 18:47:15 +00:00
- Config file format:
```
firehose:
2020-05-12 20:30:14 +00:00
region: ca-central-1
2019-04-08 18:47:15 +00:00
```
2020-12-24 22:00:22 +00:00
###### `firehose_access_key_id`
2019-04-08 18:47:15 +00:00
2020-05-12 20:30:14 +00:00
This flag only has effect if `osquery_status_log_plugin` or `osquery_result_log_plugin` are set to `firehose` .
If `firehose_access_key_id` and `firehose_secret_access_key` are omitted, Fleet will try to use [AWS STS ](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html ) credentials.
2019-04-08 18:47:15 +00:00
AWS access key ID to use for Firehose authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FIREHOSE_ACCESS_KEY_ID`
2019-04-08 18:47:15 +00:00
- Config file format:
```
firehose:
2020-05-12 20:30:14 +00:00
access_key_id: AKIAIOSFODNN7EXAMPLE
2019-04-08 18:47:15 +00:00
```
2020-12-24 22:00:22 +00:00
###### `firehose_secret_access_key`
2019-04-08 18:47:15 +00:00
2020-05-12 20:30:14 +00:00
This flag only has effect if `osquery_status_log_plugin` or `osquery_result_log_plugin` are set to `firehose` .
2019-04-08 18:47:15 +00:00
AWS secret access key to use for Firehose authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FIREHOSE_SECRET_ACCESS_KEY`
2019-04-08 18:47:15 +00:00
- Config file format:
```
firehose:
2020-05-12 20:30:14 +00:00
secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
2019-04-08 18:47:15 +00:00
```
2020-12-24 22:00:22 +00:00
###### `firehose_sts_assume_role_arn`
2020-08-19 21:56:44 +00:00
This flag only has effect if `osquery_status_log_plugin` or
`osquery_result_log_plugin` are set to `firehose` .
AWS STS role ARN to use for Firehose authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FIREHOSE_STS_ASSUME_ROLE_ARN`
2020-08-19 21:56:44 +00:00
- Config file format:
```
firehose:
sts_assume_role_arn: arn:aws:iam::1234567890:role/firehose-role
```
2019-04-08 18:47:15 +00:00
2020-12-24 22:00:22 +00:00
###### `firehose_status_stream`
2019-04-08 18:47:15 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `firehose` .
Name of the Firehose stream to write osquery status logs received from clients.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FIREHOSE_STATUS_STREAM`
2019-04-08 18:47:15 +00:00
- Config file format:
```
firehose:
status_stream: osquery_status
```
2020-08-19 21:56:44 +00:00
The IAM role used to send to Firehose must allow the following permissions on
the stream listed:
* `firehose:DescribeDeliveryStream`
* `firehose:PutRecordBatch`
2020-12-24 22:00:22 +00:00
###### `firehose_result_stream`
2019-04-08 18:47:15 +00:00
This flag only has effect if `osquery_result_log_plugin` is set to `firehose` .
Name of the Firehose stream to write osquery result logs received from clients.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_FIREHOSE_RESULT_STREAM`
2019-04-08 18:47:15 +00:00
- Config file format:
```
firehose:
result_stream: osquery_result
```
2019-07-16 22:41:50 +00:00
2020-08-19 21:56:44 +00:00
The IAM role used to send to Firehose must allow the following permissions on
the stream listed:
* `firehose:DescribeDeliveryStream`
* `firehose:PutRecordBatch`
2020-12-24 22:00:22 +00:00
##### Kinesis
2020-08-19 21:56:44 +00:00
2020-12-24 22:00:22 +00:00
###### `kinesis_region`
2020-08-19 21:56:44 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `kinesis` .
AWS region to use for Kinesis connection
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_KINESIS_REGION`
2020-08-19 21:56:44 +00:00
- Config file format:
```
kinesis:
region: ca-central-1
```
2020-12-24 22:00:22 +00:00
###### `kinesis_access_key_id`
2020-08-19 21:56:44 +00:00
This flag only has effect if `osquery_status_log_plugin` or
`osquery_result_log_plugin` are set to `kinesis` .
If `kinesis_access_key_id` and `kinesis_secret_access_key` are omitted, Fleet
will try to use
[AWS STS ](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html )
credentials.
AWS access key ID to use for Kinesis authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_KINESIS_ACCESS_KEY_ID`
2020-08-19 21:56:44 +00:00
- Config file format:
```
kinesis:
access_key_id: AKIAIOSFODNN7EXAMPLE
```
2020-12-24 22:00:22 +00:00
###### `kinesis_secret_access_key`
2020-08-19 21:56:44 +00:00
This flag only has effect if `osquery_status_log_plugin` or
`osquery_result_log_plugin` are set to `kinesis` .
AWS secret access key to use for Kinesis authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_KINESIS_SECRET_ACCESS_KEY`
2020-08-19 21:56:44 +00:00
- Config file format:
```
kinesis:
secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
```
2020-12-24 22:00:22 +00:00
###### `kinesis_sts_assume_role_arn`
2020-08-19 21:56:44 +00:00
This flag only has effect if `osquery_status_log_plugin` or
`osquery_result_log_plugin` are set to `kinesis` .
AWS STS role ARN to use for Kinesis authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_KINESIS_STS_ASSUME_ROLE_ARN`
2020-08-19 21:56:44 +00:00
- Config file format:
```
kinesis:
sts_assume_role_arn: arn:aws:iam::1234567890:role/kinesis-role
```
2020-12-24 22:00:22 +00:00
###### `kinesis_status_stream`
2020-08-19 21:56:44 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `kinesis` .
Name of the Kinesis stream to write osquery status logs received from clients.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_KINESIS_STATUS_STREAM`
2020-08-19 21:56:44 +00:00
- Config file format:
```
kinesis:
status_stream: osquery_status
```
The IAM role used to send to Kinesis must allow the following permissions on
the stream listed:
* `kinesis:DescribeStream`
* `kinesis:PutRecords`
2020-12-24 22:00:22 +00:00
###### `kinesis_result_stream`
2020-08-19 21:56:44 +00:00
This flag only has effect if `osquery_result_log_plugin` is set to `kinesis` .
Name of the Kinesis stream to write osquery result logs received from clients.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_KINESIS_RESULT_STREAM`
2020-08-19 21:56:44 +00:00
- Config file format:
```
kinesis:
result_stream: osquery_result
```
The IAM role used to send to Kinesis must allow the following permissions on
the stream listed:
* `kinesis:DescribeStream`
* `kinesis:PutRecords`
2021-02-24 18:02:26 +00:00
##### Lambda
###### `lambda_region`
This flag only has effect if `osquery_status_log_plugin` is set to `lambda` .
AWS region to use for Lambda connection
- Default value: none
- Environment variable: `FLEET_LAMBDA_REGION`
- Config file format:
```
lambda:
region: ca-central-1
```
###### `lambda_access_key_id`
This flag only has effect if `osquery_status_log_plugin` or
`osquery_result_log_plugin` are set to `lambda` .
If `lambda_access_key_id` and `lambda_secret_access_key` are omitted, Fleet
will try to use
[AWS STS ](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html )
credentials.
AWS access key ID to use for Lambda authentication.
- Default value: none
- Environment variable: `FLEET_LAMBDA_ACCESS_KEY_ID`
- Config file format:
```
lambda:
access_key_id: AKIAIOSFODNN7EXAMPLE
```
###### `lambda_secret_access_key`
This flag only has effect if `osquery_status_log_plugin` or
`osquery_result_log_plugin` are set to `lambda` .
AWS secret access key to use for Lambda authentication.
- Default value: none
- Environment variable: `FLEET_LAMBDA_SECRET_ACCESS_KEY`
- Config file format:
```
lambda:
secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
```
###### `lambda_sts_assume_role_arn`
This flag only has effect if `osquery_status_log_plugin` or
`osquery_result_log_plugin` are set to `lambda` .
AWS STS role ARN to use for Lambda authentication.
- Default value: none
- Environment variable: `FLEET_LAMBDA_STS_ASSUME_ROLE_ARN`
- Config file format:
```
lambda:
sts_assume_role_arn: arn:aws:iam::1234567890:role/lambda-role
```
###### `lambda_status_function`
This flag only has effect if `osquery_status_log_plugin` is set to `lambda` .
Name of the Lambda function to write osquery status logs received from clients.
- Default value: none
- Environment variable: `FLEET_LAMBDA_STATUS_FUNCTION`
- Config file format:
```
lambda:
status_function: statusFunction
```
The IAM role used to send to Lambda must allow the following permissions on
the function listed:
* `lambda:InvokeFunction`
###### `lambda_result_function`
This flag only has effect if `osquery_result_log_plugin` is set to `lambda` .
Name of the Lambda function to write osquery result logs received from clients.
- Default value: none
- Environment variable: `FLEET_LAMBDA_RESULT_FUNCTION`
- Config file format:
```
lambda:
result_function: resultFunction
```
The IAM role used to send to Lambda must allow the following permissions on
the function listed:
* `lambda:InvokeFunction`
2020-12-24 22:00:22 +00:00
##### PubSub
2019-07-16 22:41:50 +00:00
2020-12-24 22:00:22 +00:00
###### `pubsub_project`
2019-07-16 22:41:50 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `pubsub` .
The identifier of the Google Cloud project containing the pubsub topics to
publish logs to.
Note that the pubsub plugin uses [Application Default Credentials (ADCs) ](https://cloud.google.com/docs/authentication/production )
for authentication with the service.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_PUBSUB_PROJECT`
2019-07-16 22:41:50 +00:00
- Config file format:
```
pubsub:
project: my-gcp-project
```
2020-12-24 22:00:22 +00:00
###### `pubsub_result_topic`
2019-07-16 22:41:50 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `pubsub` .
The identifier of the pubsub topic that client results will be published to.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_PUBSUB_RESULT_TOPIC`
2019-07-16 22:41:50 +00:00
- Config file format:
```
pubsub:
result_topic: osquery_result
```
2020-12-24 22:00:22 +00:00
###### `pubsub_status_topic`
2019-07-16 22:41:50 +00:00
This flag only has effect if `osquery_status_log_plugin` is set to `pubsub` .
The identifier of the pubsub topic that osquery status logs will be published to.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_PUBSUB_STATUS_TOPIC`
2019-07-16 22:41:50 +00:00
- Config file format:
```
pubsub:
status_topic: osquery_status
```
2020-12-16 17:16:55 +00:00
2020-12-24 22:00:22 +00:00
##### S3 file carving backend
2020-12-16 17:16:55 +00:00
2020-12-24 22:00:22 +00:00
###### `s3_bucket`
2020-12-16 17:16:55 +00:00
Name of the S3 bucket to use to store file carves.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_S3_BUCKET`
2020-12-16 17:16:55 +00:00
- Config file format:
```
s3:
bucket: some-carve-bucket
```
2020-12-24 22:00:22 +00:00
###### `s3_prefix`
2020-12-16 17:16:55 +00:00
Prefix to prepend to carve objects.
All carve objects will also be prefixed by date and hour (UTC), making the resulting keys look like: `<prefix><year>/<month>/<day>/<hour>/<carve-name>` .
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_S3_PREFIX`
2020-12-16 17:16:55 +00:00
- Config file format:
```
s3:
prefix: carves-go-here/
```
2020-12-24 22:00:22 +00:00
###### `s3_access_key_id`
2020-12-16 17:16:55 +00:00
AWS access key ID to use for S3 authentication.
If `s3_access_key_id` and `s3_secret_access_key` are omitted, Fleet will try to use
[the default credential provider chain ](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials ).
The IAM identity used in this context must be allowed to perform the following actions on the bucket: `s3:PutObject` , `s3:GetObject` , `s3:ListMultipartUploadParts` , `s3:ListBucket` , `s3:GetBucketLocation` .
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_S3_ACCESS_KEY_ID`
2020-12-16 17:16:55 +00:00
- Config file format:
```
s3:
access_key_id: AKIAIOSFODNN7EXAMPLE
```
2020-12-24 22:00:22 +00:00
###### `s3_secret_access_key`
2020-12-16 17:16:55 +00:00
AWS secret access key to use for S3 authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_S3_SECRET_ACCESS_KEY`
2020-12-16 17:16:55 +00:00
- Config file format:
```
s3:
secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
```
2020-12-24 22:00:22 +00:00
###### `s3_sts_assume_role_arn`
2020-12-16 17:16:55 +00:00
AWS STS role ARN to use for S3 authentication.
- Default value: none
2021-02-11 23:36:58 +00:00
- Environment variable: `FLEET_S3_STS_ASSUME_ROLE_ARN`
2020-12-16 17:16:55 +00:00
- Config file format:
```
s3:
sts_assume_role_arn: arn:aws:iam::1234567890:role/some-s3-role
```
2020-12-24 22:00:22 +00:00
## Managing osquery configurations
We recommend that you use an infrastructure configuration management tool to manage these osquery configurations consistently across your environment. If you're unsure about what configuration management tools your organization uses, contact your company's system administrators. If you are evaluating new solutions for this problem, the founders of Kolide have successfully managed configurations in large production environments using [Chef ](https://www.chef.io/chef/ ) and [Puppet ](https://puppet.com/ ).
## Running with systemd
Once you've verified that you can run fleet in your shell, you'll likely want to keep fleet running in the background and after the server reboots. To do that we recommend using [systemd ](https://coreos.com/os/docs/latest/getting-started-with-systemd.html ).
Below is a sample unit file.
```
[Unit]
Description=Fleet
After=network.target
[Service]
LimitNOFILE=8192
ExecStart=/usr/local/bin/fleet serve \
--mysql_address=127.0.0.1:3306 \
--mysql_database=kolide \
--mysql_username=root \
--mysql_password=toor \
--redis_address=127.0.0.1:6379 \
--server_cert=/tmp/server.cert \
--server_key=/tmp/server.key \
--auth_jwt_key=this_string_is_not_secure_replace_it \
--logging_json
[Install]
WantedBy=multi-user.target
```
Once you created the file, you need to move it to `/etc/systemd/system/fleet.service` and start the service.
```
sudo mv fleet.service /etc/systemd/system/fleet.service
sudo systemctl start fleet.service
sudo systemctl status fleet.service
sudo journalctl -u fleet.service -f
```
### Making changes
Sometimes you'll need to update the systemd unit file defining the service. To do that, first open /etc/systemd/system/fleet.service in a text editor, and make your modifications.
Then, run
```
sudo systemctl daemon-reload
sudo systemctl restart fleet.service
```
## Configuring Single Sign On
Fleet supports SAML single sign on capability. This feature is convenient for users and offloads responsibility for user authentication to a third party identity provider such as Salesforce or Onelogin. Fleet supports the SAML Web Browser SSO Profile using the HTTP Redirect Binding. Fleet only supports SP-initiated SAML login and not IDP-initiated login.
### Identity Provider (IDP) Configuration
Several items are required to configure an IDP to provide SSO services to Fleet. Note that the names of these items may vary from provider to provider and may not conform to the SAML spec. Individual users must also be setup on the IDP before they can sign in to Fleet. The particulars of setting up the connected application (Fleet) and users will vary for different identity providers but will generally require the following information.
* _Assertion Consumer Service_ - This is the call back URL that the identity provider
will use to send security assertions to Fleet. In Okta, this field is called *Single sign on URL* . The value that you supply will be a fully qualified URL
2021-02-10 20:13:11 +00:00
consisting of your Fleet web address and the callback path `/api/v1/fleet/sso/callback` . For example,
2020-12-24 22:00:22 +00:00
if your Fleet web address is https://fleet.acme.org, then the value you would
use in the identity provider configuration would be:
```
2021-02-10 20:13:11 +00:00
https://fleet.acme.org/api/v1/fleet/sso/callback
2020-12-24 22:00:22 +00:00
```
* _Entity ID_ - This value is a URI that you define. It identifies your Fleet instance as the service provider that issues authorization requests. The value must exactly match the
Entity ID that you define in the Fleet SSO configuration.
* _Name ID Format_ - The value should be `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` . This may be shortened in the IDP setup to something like `email` or `EmailAddress` .
* _Subject Type (Application username in Okta)_ - `username` .
#### Example Salesforce IDP Configuration
#### Example Okta IDP Configuration
The IDP will generate an issuer URI and a metadata URL that will be used to configure
Fleet as a service provider.
### Fleet SSO Configuration
A user must be an admin to configure Fleet for SSO. The SSO configuration is
found in App Settings. If your IDP supports dynamic configuration, like Okta, you only need to provide an _Identity Provider Name_ and _Entity ID_ , then paste a link in the metadata URL field. Otherwise, the following values are required.
* _Identity Provider Name_ - A human friendly name of the IDP.
* _Entity ID_ - A URI that identifies your Fleet instance as the issuer of authorization
requests. Assuming your company name is Acme, an example might be `fleet.acme.org` although
the value could be anything as long as it is unique to Fleet as a service provider
and matches the entity provider value used in the IDP configuration.
* _Issuer URI_ - This value is obtained from the IDP.
* _Metadata URL_ - This value is obtained from the IDP and is used by Fleet to
issue authorization requests to the IDP.
* _Metadata_ - If the IDP does not provide a metadata URL, the metadata must
be obtained from the IDP and entered. Note that the metadata URL is preferred if
the IDP provides metadata in both forms.
#### Example Fleet SSO Configuration
### Creating SSO users in Fleet
When an admin invites a new user to Fleet, they may select the `Enable SSO` option. The
SSO enabled users will not be able to sign in with a regular user ID and password. It is
strongly recommended that at least one admin user is set up to use the traditional password
based log in so that there is a fallback method for logging into Fleet in the event of SSO
configuration problems.
[SAML Bindings ](http://docs.oasis-open.org/security/saml/v2.0/saml-bindings-2.0-os.pdf )
[SAML Profiles ](http://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf )
