mirror of
https://github.com/fleetdm/fleet
synced 2026-05-22 08:28:52 +00:00
166 lines
5.6 KiB
Markdown
166 lines
5.6 KiB
Markdown
# Configuration for contributors
|
|
|
|
- [Integrations](#integrations)
|
|
- [SMTP-settings](#smtp-settings)
|
|
- [Server configuration](#server-configuration)
|
|
- [Environment variables](#environment-variables)
|
|
|
|
This document includes Fleet server configuration settings that are helpful when developing or contributing to Fleet.
|
|
|
|
Unlike the [fleetctl apply format](https://github.com/fleetdm/fleet/tree/main/docs/Contributing/fleetctl-apply.md), the files and settings in this document are not recommended for production use. Each setting includes the best practice for being successful in production.
|
|
|
|
## Server configuration
|
|
|
|
##### s3_software_installers_disable_ssl
|
|
|
|
AWS S3 Disable SSL. Useful for local testing.
|
|
|
|
- Default value: false
|
|
- Environment variable: `FLEET_S3_SOFTWARE_INSTALLERS_DISABLE_SSL`
|
|
- Config file format:
|
|
```yaml
|
|
s3:
|
|
software_installers_disable_ssl: false
|
|
```
|
|
|
|
##### s3_carves_disable_ssl
|
|
|
|
- Default value: false
|
|
- Environment variable: `FLEET_S3_CARVES_DISABLE_SSL`
|
|
- Config file format:
|
|
```yaml
|
|
s3:
|
|
carves_disable_ssl: false
|
|
```
|
|
|
|
##### mdm.apple_apns_cert_bytes
|
|
|
|
The content of the Apple Push Notification service (APNs) certificate. An X.509 certificate, PEM-encoded. Typically generated via `fleetctl generate mdm-apple`.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_APNS_CERT_BYTES`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_apns_cert_bytes: |
|
|
-----BEGIN CERTIFICATE-----
|
|
... PEM-encoded content ...
|
|
-----END CERTIFICATE-----
|
|
```
|
|
|
|
##### mdm.apple_apns_key_bytes
|
|
|
|
The content of the PEM-encoded private key for the Apple Push Notification service (APNs). Typically generated via `fleetctl generate mdm-apple`.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_APNS_KEY_BYTES`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_apns_key_bytes: |
|
|
-----BEGIN RSA PRIVATE KEY-----
|
|
... PEM-encoded content ...
|
|
-----END RSA PRIVATE KEY-----
|
|
```
|
|
|
|
##### mdm.apple_scep_cert_bytes
|
|
|
|
The content of the Simple Certificate Enrollment Protocol (SCEP) certificate. An X.509 certificate, PEM-encoded. Typically generated via `fleetctl generate mdm-apple`.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_SCEP_CERT_BYTES`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_scep_cert_bytes: |
|
|
-----BEGIN CERTIFICATE-----
|
|
... PEM-encoded content ...
|
|
-----END CERTIFICATE-----
|
|
```
|
|
|
|
The SCEP certificate/key pair generated by Fleet expires every 10 years. It's recommended to never change these unless they were compromised.
|
|
|
|
If your certificate/key pair was compromised and you change the pair, the disk encryption keys will no longer be viewable on all macOS hosts' **Host details** page until you turn disk encryption off and back on and the keys are [reset by the end user](https://fleetdm.com/docs/using-fleet/MDM-migration-guide#how-to-turn-on-disk-encryption).
|
|
|
|
##### mdm.apple_scep_key_bytes
|
|
|
|
The content of the PEM-encoded private key for the Simple Certificate Enrollment Protocol (SCEP). Typically generated via `fleetctl generate mdm-apple`.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_SCEP_KEY_BYTES`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_scep_key_bytes: |
|
|
-----BEGIN RSA PRIVATE KEY-----
|
|
... PEM-encoded content ...
|
|
-----END RSA PRIVATE KEY-----
|
|
```
|
|
|
|
##### mdm.apple_scep_challenge
|
|
|
|
An alphanumeric secret for the Simple Certificate Enrollment Protocol (SCEP). Define a unique, static secret 32 characters in length and only include alphanumeric characters.
|
|
|
|
> SCEP is commonly applied to a number of certificate use cases. Notably, Mobile Device Management (MDM) systems like Microsoft Intune and Apple MDM use SCEP for PKI certificate enrollment.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_SCEP_CHALLENGE`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_scep_challenge: scepchallenge
|
|
```
|
|
|
|
##### mdm.apple_bm_server_token_bytes
|
|
|
|
This is the content of the Apple Business Manager encrypted server token downloaded from Apple Business Manager.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_BM_SERVER_TOKEN_BYTES`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_bm_server_token_bytes: |
|
|
Content-Type: application/pkcs7-mime; name="smime.p7m"; smime-type=enveloped-data
|
|
Content-Transfer-Encoding: base64
|
|
... rest of content ...
|
|
```
|
|
|
|
##### mdm.apple_bm_cert_bytes
|
|
|
|
This is the content of the Apple Business Manager certificate. The certificate is a PEM-encoded X.509 certificate that's typically generated via `fleetctl generate mdm-apple-bm`.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_BM_CERT_BYTES`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_bm_cert_bytes: |
|
|
-----BEGIN CERTIFICATE-----
|
|
... PEM-encoded content ...
|
|
-----END CERTIFICATE-----
|
|
```
|
|
|
|
##### mdm.apple_bm_key_bytes
|
|
|
|
This is the content of the PEM-encoded private key for the Apple Business Manager. It's typically generated via `fleetctl generate mdm-apple-bm`.
|
|
|
|
- Default value: ""
|
|
- Environment variable: `FLEET_MDM_APPLE_BM_KEY_BYTES`
|
|
- Config file format:
|
|
```yaml
|
|
mdm:
|
|
apple_bm_key_bytes: |
|
|
-----BEGIN RSA PRIVATE KEY-----
|
|
... PEM-encoded content ...
|
|
-----END RSA PRIVATE KEY-----
|
|
```
|
|
|
|
## Environment variables
|
|
|
|
### FLEET_ENABLE_POST_CLIENT_DEBUG_ERRORS
|
|
|
|
Use this environment variable to allow `fleetd` to report errors to the server using the [endpoint to report an agent error](./API-for-contributors.md#report-an-agent-error).
|
|
|
|
<meta name="pageOrderInSection" value="1100">
|
|
<meta name="description" value="Learn about the configuration files and settings that are helpful when developing or contributing to Fleet.">
|