2026-08-11 11:22:55 -04:00
---
# Code generated by make gen. DO NOT EDIT.
2026-09-28 15:44:10 -04:00
title : "`coder server`"
2026-10-20 18:51:44 -04:00
description : Start a Coder server.
2026-08-11 11:22:55 -04:00
---
2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Start a Coder server
## Usage
```console
coder server [flags]
```
## Subcommands
2026-09-28 15:44:10 -04:00
| Name | Purpose |
|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| [<code>create-admin-user</code> ](./create-admin-user.md ) | Create a new admin user with the given username, email and password and adds it to every organization. |
| [<code>postgres-builtin-url</code> ](./postgres-builtin-url.md ) | Output the connection URL for the built-in PostgreSQL deployment. |
| [<code>postgres-builtin-serve</code> ](./postgres-builtin-serve.md ) | Run the built-in PostgreSQL deployment. |
| [<code>fix-oidc-links</code> ](./fix-oidc-links.md ) | Reset OIDC linked IDs that do not match the expected issuer, allowing users to re-authenticate. |
| [<code>dbcrypt</code> ](./dbcrypt/index.md ) | Manage database encryption. |
2023-03-23 17:42:20 -05:00
## Options
2026-08-30 13:09:17 +02:00
### --mcp-allowed-private-cidrs
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-08-30 13:09:17 +02:00
|-------------|-----------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_MCP_ALLOWED_PRIVATE_CIDRS</code> |
| YAML | <code>mcp.allowed_private_cidrs</code> |
MCP server destinations in private or reserved IP ranges are blocked by default for SSRF protection. This applies to OAuth2 discovery, OAuth2 token and revocation exchanges, and runtime MCP connections from coderd. This option exempts specific CIDRs.
2023-03-23 17:42:20 -05:00
### --access-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------|
2023-04-07 17:58:21 -05:00
| Type | <code>url</code> |
| Environment | <code>$CODER_ACCESS_URL</code> |
| YAML | <code>networking.accessURL</code> |
2023-03-23 17:42:20 -05:00
The URL that users will use to access the Coder deployment.
2024-03-15 11:24:38 -05:00
### --wildcard-access-url
2023-12-15 01:33:51 -08:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_WILDCARD_ACCESS_URL</code> |
| YAML | <code>networking.wildcardAccessURL</code> |
2023-12-15 01:33:51 -08:00
2025-01-03 18:12:59 +05:00
Specifies the wildcard hostname to use for workspace applications in the form "*.example.com".
2023-12-15 01:33:51 -08:00
2024-03-15 11:24:38 -05:00
### --docs-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-09-18 21:47:53 +10:00
| Type | <code>url</code> |
| Environment | <code>$CODER_DOCS_URL</code> |
| YAML | <code>networking.docsURL</code> |
| Default | <code>https://coder.com/docs</code> |
2024-03-15 11:24:38 -05:00
Specifies the custom docs URL.
### --redirect-to-access-url
2023-12-15 13:38:47 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2023-12-15 13:38:47 -05:00
| Type | <code>bool</code> |
2024-03-15 11:24:38 -05:00
| Environment | <code>$CODER_REDIRECT_TO_ACCESS_URL</code> |
| YAML | <code>networking.redirectToAccessURL</code> |
2023-12-15 13:38:47 -05:00
2024-03-15 11:24:38 -05:00
Specifies whether to redirect requests that do not match the access URL host.
2023-12-15 13:38:47 -05:00
2024-03-15 11:24:38 -05:00
### --http-address
2023-06-22 08:02:05 +10:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_HTTP_ADDRESS</code> |
| YAML | <code>networking.http.httpAddress</code> |
| Default | <code>127.0.0.1:3000</code> |
2023-06-22 08:02:05 +10:00
2024-03-15 11:24:38 -05:00
HTTP bind address of the server. Unset to disable the HTTP endpoint.
2023-06-22 08:02:05 +10:00
2024-03-15 11:24:38 -05:00
### --tls-address
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>host:port</code> |
| Environment | <code>$CODER_TLS_ADDRESS</code> |
| YAML | <code>networking.tls.address</code> |
| Default | <code>127.0.0.1:3443</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
HTTPS bind address of the server.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --tls-enable
2024-01-30 17:11:37 -06:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_TLS_ENABLE</code> |
| YAML | <code>networking.tls.enable</code> |
2024-01-30 17:11:37 -06:00
2024-03-15 11:24:38 -05:00
Whether TLS will be enabled.
2024-01-30 17:11:37 -06:00
2024-03-15 11:24:38 -05:00
### --tls-cert-file
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_TLS_CERT_FILE</code> |
| YAML | <code>networking.tls.certFiles</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Path to each certificate for TLS. It requires a PEM-encoded file. To configure the listener to use a CA certificate, concatenate the primary certificate and the CA certificate together. The primary certificate should appear first in the combined file.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --tls-client-ca-file
2023-04-07 17:58:21 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_CA_FILE</code> |
| YAML | <code>networking.tls.clientCAFile</code> |
2023-04-07 17:58:21 -05:00
2024-03-15 11:24:38 -05:00
PEM-encoded Certificate Authority file used for checking the authenticity of client.
2023-04-07 17:58:21 -05:00
2024-03-15 11:24:38 -05:00
### --tls-client-auth
2023-04-07 17:58:21 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_AUTH</code> |
| YAML | <code>networking.tls.clientAuth</code> |
| Default | <code>none</code> |
2023-04-07 17:58:21 -05:00
2024-03-15 11:24:38 -05:00
Policy the server will follow for TLS Client Authentication. Accepted values are "none", "request", "require-any", "verify-if-given", or "require-and-verify".
2023-04-07 17:58:21 -05:00
2024-03-15 11:24:38 -05:00
### --tls-key-file
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_TLS_KEY_FILE</code> |
| YAML | <code>networking.tls.keyFiles</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Paths to the private keys for each of the certificates. It requires a PEM-encoded file.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --tls-min-version
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_MIN_VERSION</code> |
| YAML | <code>networking.tls.minVersion</code> |
| Default | <code>tls12</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Minimum supported version of TLS. Accepted values are "tls10", "tls11", "tls12" or "tls13".
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --tls-client-cert-file
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_CERT_FILE</code> |
| YAML | <code>networking.tls.clientCertFile</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Path to certificate for client TLS authentication. It requires a PEM-encoded file.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --tls-client-key-file
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_KEY_FILE</code> |
| YAML | <code>networking.tls.clientKeyFile</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Path to key for client TLS authentication. It requires a PEM-encoded file.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --tls-ciphers
2023-08-24 10:22:31 -07:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_TLS_CIPHERS</code> |
| YAML | <code>networking.tls.tlsCiphers</code> |
2023-08-24 10:22:31 -07:00
2024-03-15 11:24:38 -05:00
Specify specific TLS ciphers that allowed to be used. See https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53 -L75.
### --tls-allow-insecure-ciphers
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_TLS_ALLOW_INSECURE_CIPHERS</code> |
| YAML | <code>networking.tls.tlsAllowInsecureCiphers</code> |
| Default | <code>false</code> |
By default, only ciphers marked as 'secure' are allowed to be used. See https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82 -L95.
2023-08-24 10:22:31 -07:00
2023-03-23 17:42:20 -05:00
### --derp-server-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DERP_SERVER_ENABLE</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>networking.derp.enable</code> |
2023-03-23 17:42:20 -05:00
| Default | <code>true</code> |
Whether to enable or disable the embedded DERP relay server.
### --derp-server-region-name
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_DERP_SERVER_REGION_NAME</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>networking.derp.regionName</code> |
2023-03-23 17:42:20 -05:00
| Default | <code>Coder Embedded Relay</code> |
Region name that for the embedded DERP server.
### --derp-server-stun-addresses
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------------------------------------------------------------------------------------------------|
2023-08-10 12:04:17 -07:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_DERP_SERVER_STUN_ADDRESSES</code> |
| YAML | <code>networking.derp.stunAddresses</code> |
| Default | <code>stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302,stun3.l.google.com:19302,stun4.l.google.com:19302</code> |
2023-03-23 17:42:20 -05:00
2023-08-10 12:04:17 -07:00
Addresses for STUN servers to establish P2P connections. It's recommended to have at least two STUN servers to give users the best chance of connecting P2P to workspaces. Each STUN server will get it's own DERP region, with region IDs starting at `--derp-server-region-id + 1` . Use special value 'disable' to turn off STUN completely.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --derp-server-relay-url
2023-07-20 06:35:41 -07:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>url</code> |
| Environment | <code>$CODER_DERP_SERVER_RELAY_URL</code> |
| YAML | <code>networking.derp.relayURL</code> |
2023-07-20 06:35:41 -07:00
2024-03-15 11:24:38 -05:00
An HTTP URL that is accessible by other replicas to relay DERP traffic. Required for high availability.
2023-07-20 06:35:41 -07:00
2024-03-15 11:24:38 -05:00
### --block-direct-connections
2023-04-11 08:57:23 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_BLOCK_DIRECT</code> |
| YAML | <code>networking.derp.blockDirect</code> |
2023-04-11 08:57:23 -05:00
2024-03-15 11:24:38 -05:00
Block peer-to-peer (aka. direct) workspace connections. All workspace connections from the CLI will be proxied through Coder (or custom configured DERP servers) and will never be peer-to-peer when enabled. Workspaces may still reach out to STUN servers to get their address until they are restarted after this change has been made, but new connections will still be proxied regardless.
2023-04-11 08:57:23 -05:00
2024-03-15 11:24:38 -05:00
### --derp-force-websockets
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DERP_FORCE_WEBSOCKETS</code> |
| YAML | <code>networking.derp.forceWebSockets</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Force clients and agents to always use WebSocket to connect to DERP relay servers. By default, DERP uses `Upgrade: derp` , which may cause issues with some reverse proxies. Clients may automatically fallback to WebSocket if they detect an issue with `Upgrade: derp` , but this does not work in all situations.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --derp-config-url
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_DERP_CONFIG_URL</code> |
| YAML | <code>networking.derp.url</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --derp-config-path
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_DERP_CONFIG_PATH</code> |
| YAML | <code>networking.derp.configPath</code> |
Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/.
2026-01-05 11:44:06 -09:00
### --stats-collection-usage-stats-enable
2025-12-13 18:00:03 -09:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-01-05 11:44:06 -09:00
|-------------|--------------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_STATS_COLLECTION_USAGE_STATS_ENABLE</code> |
| YAML | <code>introspection.statsCollection.usageStats.enable</code> |
| Default | <code>true</code> |
2025-12-13 18:00:03 -09:00
2026-01-05 11:44:06 -09:00
Enable the collection of application and workspace usage along with the associated API endpoints and the template insights page. Disabling this will also disable traffic and connection insights in the deployment stats shown to admins in the bottom bar of the Coder UI, and will prevent Prometheus collection of these values.
2025-12-13 18:00:03 -09:00
2024-03-15 11:24:38 -05:00
### --prometheus-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_ENABLE</code> |
| YAML | <code>introspection.prometheus.enable</code> |
Serve prometheus metrics on the address defined by prometheus address.
### --prometheus-address
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>host:port</code> |
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
| YAML | <code>introspection.prometheus.address</code> |
| Default | <code>127.0.0.1:2112</code> |
The bind address to serve prometheus metrics.
### --prometheus-collect-agent-stats
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_COLLECT_AGENT_STATS</code> |
| YAML | <code>introspection.prometheus.collect_agent_stats</code> |
Collect agent stats (may increase charges for metrics storage).
### --prometheus-aggregate-agent-stats-by
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROMETHEUS_AGGREGATE_AGENT_STATS_BY</code> |
| YAML | <code>introspection.prometheus.aggregate_agent_stats_by</code> |
| Default | <code>agent_name,template_name,username,workspace_name</code> |
When collecting agent stats, aggregate metrics by a given set of comma-separated labels to reduce cardinality. Accepted values are agent_name, template_name, username, workspace_name.
### --prometheus-collect-db-metrics
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------------|
2023-04-07 17:58:21 -05:00
| Type | <code>bool</code> |
2024-03-15 11:24:38 -05:00
| Environment | <code>$CODER_PROMETHEUS_COLLECT_DB_METRICS</code> |
| YAML | <code>introspection.prometheus.collect_db_metrics</code> |
| Default | <code>false</code> |
2023-03-23 17:42:20 -05:00
2024-10-25 12:14:15 -04:00
Collect database query metrics (may increase charges for metrics storage). If set to false, a reduced set of database metrics are still collected.
2023-03-23 17:42:20 -05:00
2026-11-11 18:02:18 +03:00
### --prometheus-collect-workspace-stats
| Property | Value |
|-------------|---------------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_COLLECT_WORKSPACE_STATS</code> |
| YAML | <code>introspection.prometheus.collect_workspace_stats</code> |
| Default | <code>false</code> |
Collect per-workspace stats (may increase charges for metrics storage).
2024-03-15 11:24:38 -05:00
### --pprof-enable
2023-07-19 13:31:17 +02:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_PPROF_ENABLE</code> |
| YAML | <code>introspection.pprof.enable</code> |
2023-07-19 13:31:17 +02:00
2024-03-15 11:24:38 -05:00
Serve pprof metrics on the address defined by pprof address.
2023-07-19 13:31:17 +02:00
2024-03-15 11:24:38 -05:00
### --pprof-address
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>host:port</code> |
| Environment | <code>$CODER_PPROF_ADDRESS</code> |
| YAML | <code>introspection.pprof.address</code> |
| Default | <code>127.0.0.1:6060</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
The bind address to serve pprof.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --oauth2-github-client-id
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2023-04-07 17:58:21 -05:00
| Type | <code>string</code> |
2024-03-15 11:24:38 -05:00
| Environment | <code>$CODER_OAUTH2_GITHUB_CLIENT_ID</code> |
| YAML | <code>oauth2.github.clientID</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Client ID for Login with GitHub.
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --oauth2-github-client-secret
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_CLIENT_SECRET</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Client secret for Login with GitHub.
2023-03-23 17:42:20 -05:00
2025-02-21 18:42:16 +01:00
### --oauth2-github-device-flow
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-02-21 18:42:16 +01:00
|-------------|-----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_DEVICE_FLOW</code> |
| YAML | <code>oauth2.github.deviceFlow</code> |
| Default | <code>false</code> |
Enable device flow for Login with GitHub.
2025-02-25 16:31:33 +01:00
### --oauth2-github-default-provider-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-02-25 16:31:33 +01:00
|-------------|-----------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_DEFAULT_PROVIDER_ENABLE</code> |
| YAML | <code>oauth2.github.defaultProviderEnable</code> |
| Default | <code>true</code> |
Enable the default GitHub OAuth2 provider managed by Coder.
2023-03-23 17:42:20 -05:00
### --oauth2-github-allowed-orgs
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOWED_ORGS</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>oauth2.github.allowedOrgs</code> |
2023-03-23 17:42:20 -05:00
Organizations the user must be a member of to Login with GitHub.
### --oauth2-github-allowed-teams
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOWED_TEAMS</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>oauth2.github.allowedTeams</code> |
2023-03-23 17:42:20 -05:00
2026-07-14 13:39:58 -04:00
Teams inside organizations the user must be a member of to Login with GitHub. Structured as: `<organization-name>/<team-slug>` .
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
### --oauth2-github-allow-signups
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS</code> |
| YAML | <code>oauth2.github.allowSignups</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Whether new users can sign up with GitHub.
### --oauth2-github-allow-everyone
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOW_EVERYONE</code> |
| YAML | <code>oauth2.github.allowEveryone</code> |
Allow all logins, setting this option means allowed orgs and teams must be empty.
2023-03-23 17:42:20 -05:00
### --oauth2-github-enterprise-base-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>oauth2.github.enterpriseBaseURL</code> |
2023-03-23 17:42:20 -05:00
Base URL of a GitHub Enterprise deployment to use for Login with GitHub.
2026-09-14 08:31:26 -07:00
### --oauth2-provider-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-14 08:31:26 -07:00
|-------------|--------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_OAUTH2_PROVIDER_ENABLE</code> |
| YAML | <code>oauth2.provider.enable</code> |
| Default | <code>false</code> |
Enable the OAuth 2.1 authorization server, which lets external applications (such as MCP clients) obtain tokens for Coder on behalf of users. Disabled by default. When disabled, the OAuth2 endpoints and discovery documents return 404.
2023-03-23 17:42:20 -05:00
### --oidc-allow-signups
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_OIDC_ALLOW_SIGNUPS</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>oidc.allowSignups</code> |
2023-03-23 17:42:20 -05:00
| Default | <code>true</code> |
Whether new users can sign up with OIDC.
2024-03-15 11:24:38 -05:00
### --oidc-client-id
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_CLIENT_ID</code> |
| YAML | <code>oidc.clientID</code> |
Client ID to use for Login with OIDC.
### --oidc-client-secret
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_CLIENT_SECRET</code> |
Client secret to use for Login with OIDC.
### --oidc-client-key-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_CLIENT_KEY_FILE</code> |
| YAML | <code>oidc.oidcClientKeyFile</code> |
Pem encoded RSA private key to use for oauth2 PKI/JWT authorization. This can be used instead of oidc-client-secret if your IDP supports it.
### --oidc-client-cert-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_CLIENT_CERT_FILE</code> |
| YAML | <code>oidc.oidcClientCertFile</code> |
Pem encoded certificate file to use for oauth2 PKI/JWT authorization. The public certificate that accompanies oidc-client-key-file. A standard x509 certificate is expected.
### --oidc-email-domain
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OIDC_EMAIL_DOMAIN</code> |
| YAML | <code>oidc.emailDomain</code> |
Email domains that clients logging in with OIDC must match.
### --oidc-issuer-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_ISSUER_URL</code> |
| YAML | <code>oidc.issuerURL</code> |
Issuer URL to use for Login with OIDC.
### --oidc-scopes
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OIDC_SCOPES</code> |
| YAML | <code>oidc.scopes</code> |
| Default | <code>openid,profile,email</code> |
Scopes to grant when authenticating with OIDC.
### --oidc-ignore-email-verified
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_OIDC_IGNORE_EMAIL_VERIFIED</code> |
| YAML | <code>oidc.ignoreEmailVerified</code> |
Ignore the email_verified claim from the upstream provider.
### --oidc-username-field
2023-12-08 10:14:19 -06:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_USERNAME_FIELD</code> |
| YAML | <code>oidc.usernameField</code> |
| Default | <code>preferred_username</code> |
2023-12-08 10:14:19 -06:00
2024-03-15 11:24:38 -05:00
OIDC claim field to use as the username.
2024-06-06 13:37:08 +01:00
### --oidc-name-field
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-06-06 13:37:08 +01:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_NAME_FIELD</code> |
| YAML | <code>oidc.nameField</code> |
| Default | <code>name</code> |
OIDC claim field to use as the name.
2024-03-15 11:24:38 -05:00
### --oidc-email-field
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_EMAIL_FIELD</code> |
| YAML | <code>oidc.emailField</code> |
| Default | <code>email</code> |
OIDC claim field to use as the email.
2023-12-08 10:14:19 -06:00
2023-03-30 09:36:57 +01:00
### --oidc-auth-url-params
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2023-03-30 09:36:57 +01:00
| Type | <code>struct[map[string]string]</code> |
| Environment | <code>$CODER_OIDC_AUTH_URL_PARAMS</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>oidc.authURLParams</code> |
2023-03-30 09:36:57 +01:00
| Default | <code>{"access_type": "offline"}</code> |
OIDC auth URL parameters to pass to the upstream provider.
2024-03-15 11:24:38 -05:00
### --oidc-ignore-userinfo
2023-08-14 17:33:13 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_OIDC_IGNORE_USERINFO</code> |
| YAML | <code>oidc.ignoreUserInfo</code> |
| Default | <code>false</code> |
2023-08-14 17:33:13 -05:00
2024-03-15 11:24:38 -05:00
Ignore the userinfo endpoint and only use the ID token for user information.
2023-03-30 09:36:57 +01:00
2023-03-23 17:42:20 -05:00
### --oidc-group-field
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_GROUP_FIELD</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>oidc.groupField</code> |
2023-03-23 17:42:20 -05:00
2023-06-08 08:51:59 -05:00
This field must be set if using the group sync feature and the scope name is not 'groups'. Set to the claim to be used for groups.
2023-03-23 17:42:20 -05:00
### --oidc-group-mapping
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>struct[map[string]string]</code> |
2023-04-05 09:07:43 +01:00
| Environment | <code>$CODER_OIDC_GROUP_MAPPING</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>oidc.groupMapping</code> |
2023-03-23 17:42:20 -05:00
| Default | <code>{}</code> |
A map of OIDC group IDs and the group in Coder it should map to. This is useful for when OIDC providers only return group IDs.
2024-03-15 11:24:38 -05:00
### --oidc-group-auto-create
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_OIDC_GROUP_AUTO_CREATE</code> |
| YAML | <code>oidc.enableGroupAutoCreate</code> |
| Default | <code>false</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Automatically creates missing groups from a user's groups claim.
2023-03-23 17:42:20 -05:00
2023-08-08 11:37:49 -05:00
### --oidc-group-regex-filter
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2023-08-08 11:37:49 -05:00
| Type | <code>regexp</code> |
| Environment | <code>$CODER_OIDC_GROUP_REGEX_FILTER</code> |
| YAML | <code>oidc.groupRegexFilter</code> |
2025-01-03 18:12:59 +05:00
| Default | <code>.*</code> |
2023-08-08 11:37:49 -05:00
If provided any group name not matching the regex is ignored. This allows for filtering out groups that are not needed. This filter is applied after the group mapping.
2024-03-15 11:24:38 -05:00
### --oidc-allowed-groups
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OIDC_ALLOWED_GROUPS</code> |
| YAML | <code>oidc.groupAllowed</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
If provided any group name not in the list will not be allowed to authenticate. This allows for restricting access to a specific set of groups. This filter is applied after the group mapping and before the regex filter.
2023-07-24 08:34:24 -04:00
### --oidc-user-role-field
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2023-07-24 08:34:24 -04:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_USER_ROLE_FIELD</code> |
| YAML | <code>oidc.userRoleField</code> |
This field must be set if using the user roles sync feature. Set this to the name of the claim used to store the user's role. The roles should be sent as an array of strings.
### --oidc-user-role-mapping
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2023-07-24 08:34:24 -04:00
| Type | <code>struct[map[string][]string]</code> |
| Environment | <code>$CODER_OIDC_USER_ROLE_MAPPING</code> |
| YAML | <code>oidc.userRoleMapping</code> |
| Default | <code>{}</code> |
A map of the OIDC passed in user roles and the groups in Coder it should map to. This is useful if the group names do not match. If mapped to the empty string, the role will ignored.
2024-03-15 11:24:38 -05:00
### --oidc-user-role-default
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OIDC_USER_ROLE_DEFAULT</code> |
| YAML | <code>oidc.userRoleDefault</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
If user role sync is enabled, these roles are always included for all authenticated users. The 'member' role is always assigned.
2023-03-23 17:42:20 -05:00
2023-04-07 17:58:21 -05:00
### --oidc-sign-in-text
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string</code> |
2023-04-07 17:58:21 -05:00
| Environment | <code>$CODER_OIDC_SIGN_IN_TEXT</code> |
| YAML | <code>oidc.signInText</code> |
| Default | <code>OpenID Connect</code> |
2023-03-23 17:42:20 -05:00
2023-04-07 17:58:21 -05:00
The text to show on the OpenID Connect sign in button.
2023-03-23 17:42:20 -05:00
2023-04-07 17:58:21 -05:00
### --oidc-icon-url
2023-03-23 17:42:20 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------|
2023-04-07 17:58:21 -05:00
| Type | <code>url</code> |
| Environment | <code>$CODER_OIDC_ICON_URL</code> |
| YAML | <code>oidc.iconURL</code> |
2023-03-23 17:42:20 -05:00
2023-09-05 13:37:21 -05:00
URL pointing to the icon to use on the OpenID Connect login button.
2023-03-23 17:42:20 -05:00
2024-02-01 18:01:25 +01:00
### --oidc-signups-disabled-text
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------|
2024-02-01 18:01:25 +01:00
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_SIGNUPS_DISABLED_TEXT</code> |
| YAML | <code>oidc.signupsDisabledText</code> |
The custom text to show on the error page informing about disabled OIDC signups. Markdown format is supported.
2024-07-24 11:45:47 -10:00
### --dangerous-oidc-skip-issuer-checks
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------------|
2024-07-24 11:45:47 -10:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DANGEROUS_OIDC_SKIP_ISSUER_CHECKS</code> |
| YAML | <code>oidc.dangerousSkipIssuerChecks</code> |
OIDC issuer urls must match in the request, the id_token 'iss' claim, and in the well-known configuration. This flag disables that requirement, and can lead to an insecure OIDC configuration. It is not recommended to use this flag.
2026-08-12 16:02:15 -05:00
### --oidc-redirect-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-08-12 16:02:15 -05:00
|-------------|---------------------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_OIDC_REDIRECT_URL</code> |
| YAML | <code>oidc.oidc-redirect-url</code> |
Optional override of the default redirect url which uses the deployment's access url. Useful in situations where a deployment has more than 1 domain. Using this setting can also break OIDC, so use with caution.
2023-03-23 17:42:20 -05:00
### --telemetry
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_TELEMETRY_ENABLE</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>telemetry.enable</code> |
2023-03-23 17:42:20 -05:00
| Default | <code>true</code> |
Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.
### --trace
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2023-04-07 17:58:21 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_TRACE_ENABLE</code> |
| YAML | <code>introspection.tracing.enable</code> |
2023-03-23 17:42:20 -05:00
Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
### --trace-honeycomb-api-key
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_TRACE_HONEYCOMB_API_KEY</code> |
Enables trace exporting to Honeycomb.io using the provided API Key.
2024-03-15 11:24:38 -05:00
### --trace-logs
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_TRACE_LOGS</code> |
| YAML | <code>introspection.tracing.captureLogs</code> |
Enables capturing of logs as events in traces. This is useful for debugging, but may result in a very large amount of events being sent to the tracing backend which may incur significant costs.
### --provisioner-daemons
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>int</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMONS</code> |
| YAML | <code>provisioning.daemons</code> |
| Default | <code>3</code> |
Number of provisioner daemons to create on start. If builds are stuck in queued state for a long time, consider increasing this.
### --provisioner-daemon-poll-interval
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_POLL_INTERVAL</code> |
| YAML | <code>provisioning.daemonPollInterval</code> |
| Default | <code>1s</code> |
Deprecated and ignored.
### --provisioner-daemon-poll-jitter
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_POLL_JITTER</code> |
| YAML | <code>provisioning.daemonPollJitter</code> |
| Default | <code>100ms</code> |
Deprecated and ignored.
### --provisioner-force-cancel-interval
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_FORCE_CANCEL_INTERVAL</code> |
| YAML | <code>provisioning.forceCancelInterval</code> |
| Default | <code>10m0s</code> |
Time to force cancel provisioning tasks that are stuck.
2026-09-11 18:13:16 -05:00
### --provisioner-disable-module-cache
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-11 18:13:16 -05:00
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_DISABLE_MODULE_CACHE</code> |
| YAML | <code>provisioning.disableModuleCache</code> |
| Default | <code>false</code> |
2026-11-06 20:32:46 -05:00
Disable the reuse of Terraform modules and the provider lock file cached at template import for all templates. Modules are re-downloaded on every workspace build. Individual templates cannot opt back in.
2026-09-11 18:13:16 -05:00
2024-03-15 11:24:38 -05:00
### --provisioner-daemon-psk
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
Pre-shared key to authenticate external provisioner daemons to Coder server.
### -l, --log-filter
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_LOG_FILTER</code> |
| YAML | <code>introspection.logging.filter</code> |
2025-01-03 18:12:59 +05:00
Filter debug logs by matching against a given regex. Use .* to match all debug logs.
2024-03-15 11:24:38 -05:00
### --log-human
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_HUMAN</code> |
| YAML | <code>introspection.logging.humanPath</code> |
| Default | <code>/dev/stderr</code> |
Output human-readable logs to a given file.
### --log-json
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_JSON</code> |
| YAML | <code>introspection.logging.jsonPath</code> |
Output JSON logs to a given file.
### --log-stackdriver
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_STACKDRIVER</code> |
| YAML | <code>introspection.logging.stackdriverPath</code> |
Output Stackdriver compatible logs to a given file.
### --enable-terraform-debug-mode
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_ENABLE_TERRAFORM_DEBUG_MODE</code> |
| YAML | <code>introspection.logging.enableTerraformDebugMode</code> |
| Default | <code>false</code> |
Allow administrators to enable Terraform debug output.
2024-11-21 11:53:53 -06:00
### --additional-csp-policy
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------------|
2024-11-21 11:53:53 -06:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_ADDITIONAL_CSP_POLICY</code> |
| YAML | <code>networking.http.additionalCSPPolicy</code> |
Coder configures a Content Security Policy (CSP) to protect against XSS attacks. This setting allows you to add additional CSP directives, which can open the attack surface of the deployment. Format matches the CSP directive format, e.g. --additional-csp-policy="script-src https://example.com".
2024-03-15 11:24:38 -05:00
### --dangerous-allow-path-app-sharing
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DANGEROUS_ALLOW_PATH_APP_SHARING</code> |
Allow workspace apps that are not served from subdomains to be shared. Path-based app sharing is DISABLED by default for security purposes. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.
### --dangerous-allow-path-app-site-owner-access
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS</code> |
Allow site-owners to access workspace apps from workspaces they do not own. Owners cannot access path-based apps they do not own by default. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.
### --experiments
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXPERIMENTS</code> |
| YAML | <code>experiments</code> |
2026-11-13 16:34:59 -05:00
Enable one or more experiments. These are not ready for production. Separate multiple experiments with commas, or enter '*' to opt-in to the experiments that are marked safe.
2024-03-15 11:24:38 -05:00
2023-03-23 17:42:20 -05:00
### --update-check
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_UPDATE_CHECK</code> |
2023-04-07 17:58:21 -05:00
| YAML | <code>updateCheck</code> |
2023-03-23 17:42:20 -05:00
| Default | <code>false</code> |
Periodically check for new releases of Coder and inform the owner. The check is performed once per day.
2024-03-15 11:24:38 -05:00
### --max-token-lifetime
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_MAX_TOKEN_LIFETIME</code> |
| YAML | <code>networking.http.maxTokenLifetime</code> |
| Default | <code>876600h0m0s</code> |
The maximum lifetime duration users can specify when creating an API token.
2025-06-06 17:36:30 +02:00
### --max-admin-token-lifetime
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-06-06 17:36:30 +02:00
|-------------|----------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_MAX_ADMIN_TOKEN_LIFETIME</code> |
| YAML | <code>networking.http.maxAdminTokenLifetime</code> |
| Default | <code>168h0m0s</code> |
The maximum lifetime duration administrators can specify when creating an API token.
2024-09-18 21:23:42 +10:00
### --default-token-lifetime
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-09-18 21:23:42 +10:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_DEFAULT_TOKEN_LIFETIME</code> |
| YAML | <code>defaultTokenLifetime</code> |
| Default | <code>168h0m0s</code> |
The default lifetime duration for API tokens. This value is used when creating a token without specifying a duration, such as when authenticating the CLI or an IDE plugin.
2025-09-13 08:57:26 +02:00
### --default-oauth-refresh-lifetime
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-09-13 08:57:26 +02:00
|-------------|----------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_DEFAULT_OAUTH_REFRESH_LIFETIME</code> |
| YAML | <code>defaultOAuthRefreshLifetime</code> |
| Default | <code>720h0m0s</code> |
The default lifetime duration for OAuth2 refresh tokens. This controls how long refresh tokens remain valid after issuance or rotation.
2024-03-15 11:24:38 -05:00
### --swagger-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_SWAGGER_ENABLE</code> |
| YAML | <code>enableSwagger</code> |
Expose the swagger endpoint via /swagger.
### --proxy-trusted-headers
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROXY_TRUSTED_HEADERS</code> |
| YAML | <code>networking.proxyTrustedHeaders</code> |
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, True-Client-Ip, X-Forwarded-For.
### --proxy-trusted-origins
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROXY_TRUSTED_ORIGINS</code> |
| YAML | <code>networking.proxyTrustedOrigins</code> |
2026-06-11 10:55:00 -07:00
Origin addresses to respect "proxy-trusted-headers" and X-Forwarded-Host for subdomain app routing. e.g. 192.168.1.0/24.
2024-03-15 11:24:38 -05:00
### --cache-dir
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_CACHE_DIRECTORY</code> |
| YAML | <code>cacheDir</code> |
| Default | <code>~/.cache/coder</code> |
2024-08-08 14:42:47 +02:00
The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd. This directory is NOT safe to be configured as a shared directory across coderd/provisionerd replicas.
2024-03-15 11:24:38 -05:00
### --postgres-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
2024-12-24 12:22:40 +00:00
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the config root. Access the built-in database with "coder server postgres-builtin-url". Note that any special characters in the URL must be URL-encoded.
2024-03-15 11:24:38 -05:00
2024-03-20 13:14:43 -04:00
### --postgres-auth
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------|
2024-08-20 14:47:46 +10:00
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_AUTH</code> |
| YAML | <code>pgAuth</code> |
| Default | <code>password</code> |
2024-03-20 13:14:43 -04:00
2024-12-24 12:22:40 +00:00
Type of auth to use when connecting to postgres. For AWS RDS, using IAM authentication (awsiamrds) is recommended.
2024-03-20 13:14:43 -04:00
2026-01-13 10:50:57 +02:00
### --postgres-conn-max-open
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-01-13 10:50:57 +02:00
|-------------|--------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_PG_CONN_MAX_OPEN</code> |
| YAML | <code>pgConnMaxOpen</code> |
| Default | <code>10</code> |
Maximum number of open connections to the database. Defaults to 10.
### --postgres-conn-max-idle
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-01-13 10:50:57 +02:00
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONN_MAX_IDLE</code> |
| YAML | <code>pgConnMaxIdle</code> |
| Default | <code>auto</code> |
Maximum number of idle connections to the database. Set to "auto" (the default) to use max open / 3. Value must be greater or equal to 0; 0 means explicitly no idle connections.
2024-03-15 11:24:38 -05:00
### --secure-auth-cookie
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_SECURE_AUTH_COOKIE</code> |
| YAML | <code>networking.secureAuthCookie</code> |
Controls if the 'Secure' property is set on browser session cookies.
2025-04-08 14:15:14 -05:00
### --samesite-auth-cookie
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-04-08 14:15:14 -05:00
|-------------|--------------------------------------------|
| Type | <code>lax\|none</code> |
| Environment | <code>$CODER_SAMESITE_AUTH_COOKIE</code> |
| YAML | <code>networking.sameSiteAuthCookie</code> |
| Default | <code>lax</code> |
Controls the 'SameSite' property is set on browser session cookies.
2026-02-20 09:01:00 -06:00
### --host-prefix-cookie
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-02-20 09:01:00 -06:00
|-------------|------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_HOST_PREFIX_COOKIE</code> |
| YAML | <code>networking.hostPrefixCookie</code> |
2026-02-20 20:12:51 +01:00
| Default | <code>false</code> |
2026-02-20 09:01:00 -06:00
2026-03-02 10:23:09 -06:00
Recommended to be enabled. Enables `__Host-` prefix for cookies to guarantee they are only set by the right domain. This change is disruptive to any workspaces built before release 2.31, requiring a workspace restart.
2026-02-20 09:01:00 -06:00
2024-04-25 16:36:51 -06:00
### --terms-of-service-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-04-25 16:36:51 -06:00
| Type | <code>string</code> |
| Environment | <code>$CODER_TERMS_OF_SERVICE_URL</code> |
| YAML | <code>termsOfServiceURL</code> |
A URL to an external Terms of Service that must be accepted by users when logging in.
2024-03-15 11:24:38 -05:00
### --strict-transport-security
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>int</code> |
| Environment | <code>$CODER_STRICT_TRANSPORT_SECURITY</code> |
| YAML | <code>networking.tls.strictTransportSecurity</code> |
| Default | <code>0</code> |
Controls if the 'Strict-Transport-Security' header is set on all static file responses. This header should only be set if the server is accessed via HTTPS. This value is the MaxAge in seconds of the header.
### --strict-transport-security-options
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_STRICT_TRANSPORT_SECURITY_OPTIONS</code> |
| YAML | <code>networking.tls.strictTransportSecurityOptions</code> |
Two optional fields can be set in the Strict-Transport-Security header; 'includeSubDomains' and 'preload'. The 'strict-transport-security' flag must be set to a non-zero value for these options to be used.
### --ssh-keygen-algorithm
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
| YAML | <code>sshKeygenAlgorithm</code> |
| Default | <code>ed25519</code> |
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
### --browser-only
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_BROWSER_ONLY</code> |
| YAML | <code>networking.browserOnly</code> |
Whether Coder only allows connections to workspaces via the browser.
2026-06-26 08:57:23 -04:00
### --cluster-host
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-06-26 08:57:23 -04:00
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CLUSTER_HOST</code> |
| YAML | <code>networking.cluster.clusterHost</code> |
Hostname or (more commonly) IP to reach this replica for clustering.
2024-03-15 11:24:38 -05:00
### --scim-auth-header
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_SCIM_AUTH_HEADER</code> |
Enables SCIM and sets the authentication header for the built-in SCIM server. New users are automatically created with OIDC authentication.
2026-06-17 09:44:01 -07:00
### --scim-use-legacy
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-06-17 09:44:01 -07:00
|-------------|-------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCIM_USE_LEGACY</code> |
| YAML | <code>scimUseLegacy</code> |
| Default | <code>true</code> |
Use the legacy SCIM implementation instead of the SCIM 2.0 handler. This is provided for backward compatibility for existing users.
2024-03-15 11:24:38 -05:00
### --external-token-encryption-keys
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_KEYS</code> |
Encrypt OIDC and Git authentication tokens with AES-256-GCM in the database. The value must be a comma-separated list of base64-encoded keys. Each key, when base64-decoded, must be exactly 32 bytes in length. The first key will be used to encrypt new values. Subsequent keys will be used as a fallback when decrypting. During normal operation it is recommended to only set one key unless you are in the process of rotating keys with the `coder server dbcrypt rotate` command.
### --disable-path-apps
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_PATH_APPS</code> |
| YAML | <code>disablePathApps</code> |
Disable workspace apps that are not served from subdomains. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. This is recommended for security purposes if a --wildcard-access-url is configured.
### --disable-owner-workspace-access
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_OWNER_WORKSPACE_ACCESS</code> |
| YAML | <code>disableOwnerWorkspaceAccess</code> |
Remove the permission for the 'owner' role to have workspace execution on all workspaces. This prevents the 'owner' from ssh, apps, and terminal access based on the 'owner' role. They still have their user permissions to access their own workspaces.
2025-12-09 08:13:09 -08:00
### --disable-workspace-sharing
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-12-09 08:13:09 -08:00
|-------------|-----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_WORKSPACE_SHARING</code> |
| YAML | <code>disableWorkspaceSharing</code> |
2026-02-23 08:30:32 -08:00
Disable workspace sharing. Workspace ACL checking is disabled and only owners can have ssh, apps and terminal access to workspaces. Access based on the 'owner' role is also allowed unless disabled via --disable-owner-workspace-access.
2025-12-09 08:13:09 -08:00
2026-05-18 22:32:05 +01:00
### --disable-chat-sharing
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-18 22:32:05 +01:00
|-------------|------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_CHAT_SHARING</code> |
| YAML | <code>disableChatSharing</code> |
2026-10-14 10:42:00 -04:00
Disable chat and chat project sharing. Existing shares stop granting access and new shares are rejected. Owners keep access to their own chats and projects, and administrators keep only the access their roles grant.
2026-05-18 22:32:05 +01:00
2026-09-25 18:51:53 +10:00
### --disable-chat-caller-supplied-tools
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-25 18:51:53 +10:00
|-------------|--------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_CHAT_CALLER_SUPPLIED_TOOLS</code> |
| YAML | <code>disableChatCallerSuppliedTools</code> |
2026-09-25 18:51:55 +10:00
Disable caller-supplied tools in chats. Chat requests that include unsafe_dynamic_tools or inline_mcp_servers are rejected, and existing chats run without their dynamic tools and inline MCP servers.
2026-09-25 18:51:53 +10:00
2026-08-24 19:58:30 -05:00
### --disable-workspace-agent-context-sync
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-08-24 19:58:30 -05:00
|-------------|----------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_WORKSPACE_AGENT_CONTEXT_SYNC</code> |
| YAML | <code>disableWorkspaceAgentContextSync</code> |
Stop persisting workspace agent context snapshots (instructions, skills, and MCP state used for pinned chat context). When set, coderd rejects agent context pushes as unimplemented and agents stop sending them; chats cannot pin workspace context. Use this to shed the database write load of context sync on large deployments.
2026-09-02 12:21:36 -04:00
### --disable-user-secret-file-path
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-02 12:21:36 -04:00
|-------------|---------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_USER_SECRET_FILE_PATH</code> |
| YAML | <code>disableUserSecretFilePath</code> |
Disable Coder-managed file path delivery for user secrets. Stored paths remain until users clear them and resume if this setting is turned off.
2024-03-15 11:24:38 -05:00
### --session-duration
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_SESSION_DURATION</code> |
| YAML | <code>networking.http.sessionDuration</code> |
| Default | <code>24h0m0s</code> |
The token expiry duration for browser sessions. Sessions may last longer if they are actively making requests, but this functionality can be disabled via --disable-session-expiry-refresh.
### --disable-session-expiry-refresh
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_SESSION_EXPIRY_REFRESH</code> |
| YAML | <code>networking.http.disableSessionExpiryRefresh</code> |
Disable automatic session expiry bumping due to activity. This forces all sessions to become invalid after the session expiry duration has been reached.
### --disable-password-auth
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_PASSWORD_AUTH</code> |
| YAML | <code>networking.http.disablePasswordAuth</code> |
2026-10-07 19:03:46 +02:00
Disable password authentication. This is recommended for security purposes in production deployments that rely on an identity provider. This applies to all users, including owners. Ensure an owner can sign in through your identity provider before enabling this. To recover access, unset this option, restart the server, and use `coder server create-admin-user` if needed.
2024-03-15 11:24:38 -05:00
### -c, --config
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>yaml-config-path</code> |
| Environment | <code>$CODER_CONFIG_PATH</code> |
Specify a YAML file to load configuration from.
2025-04-07 11:35:47 +04:00
### --workspace-hostname-suffix
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-04-07 11:35:47 +04:00
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_HOSTNAME_SUFFIX</code> |
| YAML | <code>client.workspaceHostnameSuffix</code> |
| Default | <code>coder</code> |
2026-06-10 15:48:02 +01:00
Workspace hostnames use this suffix in SSH config and Coder Connect on Coder Desktop. By default it is coder, resulting in names like myworkspace.coder. The suffix must not start with a dot, and must not contain spaces, newlines, or glob characters (* and ?).
2025-04-07 11:35:47 +04:00
2024-03-15 11:24:38 -05:00
### --ssh-config-options
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTIONS</code> |
| YAML | <code>client.sshConfigOptions</code> |
2026-06-10 15:48:02 +01:00
These SSH config options will override the default SSH config options. Provide options in "key=value" or "key value" format separated by commas. Using this incorrectly can break SSH to your deployment, use cautiously. The following options are not allowed: Host, Match, Include, ProxyCommand, ProxyJump, LocalCommand, PermitLocalCommand, RemoteCommand, KnownHostsCommand, PKCS11Provider, SecurityKeyProvider, SmartcardDevice, XAuthLocation. Option values must not contain newline, carriage return, or NUL characters.
2024-03-15 11:24:38 -05:00
### --cli-upgrade-message
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_CLI_UPGRADE_MESSAGE</code> |
| YAML | <code>client.cliUpgradeMessage</code> |
2026-09-24 14:23:54 -04:00
The upgrade message to display to users when a client/server mismatch is detected. By default it instructs users to update using 'curl -fsSL https://coder.com/install.sh | sh'.
2024-03-15 11:24:38 -05:00
### --write-config
2026-10-21 10:58:04 -07:00
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
2024-03-15 11:24:38 -05:00
<br/>Write out the current server config as YAML to stdout.
### --support-links
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>struct[[]codersdk.LinkConfig]</code> |
| Environment | <code>$CODER_SUPPORT_LINKS</code> |
| YAML | <code>supportLinks</code> |
Support links to display in the top right drop down menu.
2026-02-27 11:50:56 -05:00
### --external-auth-github-default-provider-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-02-27 11:50:56 -05:00
|-------------|------------------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_EXTERNAL_AUTH_GITHUB_DEFAULT_PROVIDER_ENABLE</code> |
| YAML | <code>externalAuthGithubDefaultProviderEnable</code> |
| Default | <code>true</code> |
Enable the default GitHub external auth provider managed by Coder.
2024-03-15 11:24:38 -05:00
### --proxy-health-interval
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROXY_HEALTH_INTERVAL</code> |
| YAML | <code>networking.http.proxyHealthInterval</code> |
| Default | <code>1m0s</code> |
The interval in which coderd should be checking the status of workspace proxies.
### --default-quiet-hours-schedule
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_QUIET_HOURS_DEFAULT_SCHEDULE</code> |
| YAML | <code>userQuietHoursSchedule.defaultQuietHoursSchedule</code> |
2025-01-03 18:12:59 +05:00
| Default | <code>CRON_TZ=UTC 0 0 ** *</code> |
2024-03-15 11:24:38 -05:00
2026-11-13 16:34:59 -05:00
The default daily cron schedule applied to users that haven't set a custom quiet hours schedule themselves. The quiet hours schedule determines when workspaces will be force stopped due to the template's autostop requirement, and will set the max deadline to the start of the user's quiet hours window on the next day that the template's autostop requirement applies (or default). The format is the same as the standard cron format, but the day-of-month, month and day-of-week must be *. Only one hour and minute can be specified (ranges or comma separated values are not supported).
2024-03-15 11:24:38 -05:00
### --allow-custom-quiet-hours
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_ALLOW_CUSTOM_QUIET_HOURS</code> |
| YAML | <code>userQuietHoursSchedule.allowCustomQuietHours</code> |
| Default | <code>true</code> |
Allow users to set their own quiet hours schedule for workspaces to stop in (depending on template autostop requirement settings). If false, users can't change their quiet hours schedule and the site default is always used.
2023-10-10 13:18:02 -05:00
### --web-terminal-renderer
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2023-10-10 13:18:02 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_WEB_TERMINAL_RENDERER</code> |
| YAML | <code>client.webTerminalRenderer</code> |
| Default | <code>canvas</code> |
The renderer to use when opening a web terminal. Valid values are 'canvas', 'webgl', or 'dom'.
2024-03-15 11:24:38 -05:00
### --health-check-refresh
2023-04-07 17:58:21 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_HEALTH_CHECK_REFRESH</code> |
| YAML | <code>introspection.healthcheck.refresh</code> |
| Default | <code>10m0s</code> |
2023-04-07 17:58:21 -05:00
2024-03-15 11:24:38 -05:00
Refresh interval for healthchecks.
2023-04-07 17:58:21 -05:00
2024-03-15 11:24:38 -05:00
### --health-check-threshold-database
2023-04-07 17:58:21 -05:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_HEALTH_CHECK_THRESHOLD_DATABASE</code> |
| YAML | <code>introspection.healthcheck.thresholdDatabase</code> |
| Default | <code>15ms</code> |
2023-04-07 17:58:21 -05:00
2024-03-15 11:24:38 -05:00
The threshold for the database health check. If the median latency of the database exceeds this threshold over 5 attempts, the database is considered unhealthy. The default value is 15ms.
2024-07-08 15:38:50 +02:00
2024-10-30 10:06:10 +00:00
### --email-from
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_FROM</code> |
| YAML | <code>email.from</code> |
The sender's address to use.
### --email-smarthost
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-11-19 10:05:12 -05:00
| Type | <code>string</code> |
2024-10-30 10:06:10 +00:00
| Environment | <code>$CODER_EMAIL_SMARTHOST</code> |
| YAML | <code>email.smarthost</code> |
The intermediary SMTP host through which emails are sent.
### --email-hello
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_HELLO</code> |
| YAML | <code>email.hello</code> |
| Default | <code>localhost</code> |
The hostname identifying the SMTP server.
### --email-force-tls
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_EMAIL_FORCE_TLS</code> |
| YAML | <code>email.forceTLS</code> |
| Default | <code>false</code> |
Force a TLS connection to the configured SMTP smarthost.
### --email-auth-identity
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_AUTH_IDENTITY</code> |
| YAML | <code>email.emailAuth.identity</code> |
Identity to use with PLAIN authentication.
### --email-auth-username
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_AUTH_USERNAME</code> |
| YAML | <code>email.emailAuth.username</code> |
Username to use with PLAIN/LOGIN authentication.
### --email-auth-password
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_AUTH_PASSWORD</code> |
Password to use with PLAIN/LOGIN authentication.
### --email-auth-password-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_AUTH_PASSWORD_FILE</code> |
| YAML | <code>email.emailAuth.passwordFile</code> |
File from which to load password for use with PLAIN/LOGIN authentication.
### --email-tls-starttls
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_EMAIL_TLS_STARTTLS</code> |
| YAML | <code>email.emailTLS.startTLS</code> |
Enable STARTTLS to upgrade insecure SMTP connections using TLS.
### --email-tls-server-name
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_TLS_SERVERNAME</code> |
| YAML | <code>email.emailTLS.serverName</code> |
Server name to verify against the target certificate.
### --email-tls-skip-verify
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_EMAIL_TLS_SKIPVERIFY</code> |
| YAML | <code>email.emailTLS.insecureSkipVerify</code> |
Skip verification of the target server's certificate (insecure).
### --email-tls-ca-cert-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_TLS_CACERTFILE</code> |
| YAML | <code>email.emailTLS.caCertFile</code> |
CA certificate file to use.
### --email-tls-cert-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_TLS_CERTFILE</code> |
| YAML | <code>email.emailTLS.certFile</code> |
Certificate file to use.
### --email-tls-cert-key-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------|
2024-10-30 10:06:10 +00:00
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL_TLS_CERTKEYFILE</code> |
| YAML | <code>email.emailTLS.certKeyFile</code> |
Certificate key file to use.
2024-07-08 15:38:50 +02:00
### --notifications-method
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------|
2024-07-08 15:38:50 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_METHOD</code> |
| YAML | <code>notifications.method</code> |
| Default | <code>smtp</code> |
Which delivery method to use (available options: 'smtp', 'webhook').
### --notifications-dispatch-timeout
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------|
2024-07-08 15:38:50 +02:00
| Type | <code>duration</code> |
| Environment | <code>$CODER_NOTIFICATIONS_DISPATCH_TIMEOUT</code> |
2024-07-19 09:22:15 +02:00
| YAML | <code>notifications.dispatchTimeout</code> |
2024-07-08 15:38:50 +02:00
| Default | <code>1m0s</code> |
How long to wait while a notification is being sent before giving up.
### --notifications-email-from
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------|
2024-07-08 15:38:50 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_FROM</code> |
| YAML | <code>notifications.email.from</code> |
The sender's address to use.
### --notifications-email-smarthost
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------------|
2024-11-19 10:05:12 -05:00
| Type | <code>string</code> |
2024-07-08 15:38:50 +02:00
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_SMARTHOST</code> |
| YAML | <code>notifications.email.smarthost</code> |
The intermediary SMTP host through which emails are sent.
### --notifications-email-hello
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------|
2024-07-08 15:38:50 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_HELLO</code> |
| YAML | <code>notifications.email.hello</code> |
The hostname identifying the SMTP server.
2024-07-19 09:22:15 +02:00
### --notifications-email-force-tls
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_FORCE_TLS</code> |
| YAML | <code>notifications.email.forceTLS</code> |
Force a TLS connection to the configured SMTP smarthost.
### --notifications-email-auth-identity
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_AUTH_IDENTITY</code> |
| YAML | <code>notifications.email.emailAuth.identity</code> |
Identity to use with PLAIN authentication.
### --notifications-email-auth-username
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_AUTH_USERNAME</code> |
| YAML | <code>notifications.email.emailAuth.username</code> |
Username to use with PLAIN/LOGIN authentication.
### --notifications-email-auth-password
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_AUTH_PASSWORD</code> |
Password to use with PLAIN/LOGIN authentication.
### --notifications-email-auth-password-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_AUTH_PASSWORD_FILE</code> |
| YAML | <code>notifications.email.emailAuth.passwordFile</code> |
File from which to load password for use with PLAIN/LOGIN authentication.
### --notifications-email-tls-starttls
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_TLS_STARTTLS</code> |
| YAML | <code>notifications.email.emailTLS.startTLS</code> |
Enable STARTTLS to upgrade insecure SMTP connections using TLS.
### --notifications-email-tls-server-name
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_TLS_SERVERNAME</code> |
| YAML | <code>notifications.email.emailTLS.serverName</code> |
Server name to verify against the target certificate.
### --notifications-email-tls-skip-verify
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_TLS_SKIPVERIFY</code> |
| YAML | <code>notifications.email.emailTLS.insecureSkipVerify</code> |
Skip verification of the target server's certificate (insecure).
### --notifications-email-tls-ca-cert-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_TLS_CACERTFILE</code> |
| YAML | <code>notifications.email.emailTLS.caCertFile</code> |
CA certificate file to use.
### --notifications-email-tls-cert-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_TLS_CERTFILE</code> |
| YAML | <code>notifications.email.emailTLS.certFile</code> |
Certificate file to use.
### --notifications-email-tls-cert-key-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------------------------------|
2024-07-19 09:22:15 +02:00
| Type | <code>string</code> |
| Environment | <code>$CODER_NOTIFICATIONS_EMAIL_TLS_CERTKEYFILE</code> |
| YAML | <code>notifications.email.emailTLS.certKeyFile</code> |
Certificate key file to use.
2024-07-08 15:38:50 +02:00
### --notifications-webhook-endpoint
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------------|
2024-07-08 15:38:50 +02:00
| Type | <code>url</code> |
| Environment | <code>$CODER_NOTIFICATIONS_WEBHOOK_ENDPOINT</code> |
2024-07-23 16:59:27 +02:00
| YAML | <code>notifications.webhook.endpoint</code> |
2024-07-08 15:38:50 +02:00
The endpoint to which to send webhooks.
2025-03-25 12:51:26 +00:00
### --notifications-inbox-enabled
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-03-25 12:51:26 +00:00
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_NOTIFICATIONS_INBOX_ENABLED</code> |
| YAML | <code>notifications.inbox.enabled</code> |
| Default | <code>true</code> |
Enable Coder Inbox.
2024-07-08 15:38:50 +02:00
### --notifications-max-send-attempts
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------------|
2024-07-08 15:38:50 +02:00
| Type | <code>int</code> |
| Environment | <code>$CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS</code> |
2024-07-19 09:22:15 +02:00
| YAML | <code>notifications.maxSendAttempts</code> |
2024-07-08 15:38:50 +02:00
| Default | <code>5</code> |
The upper limit of attempts to send a notification.
2025-06-18 18:32:34 +02:00
2025-06-26 15:54:52 +02:00
### --workspace-prebuilds-reconciliation-interval
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-06-26 15:54:52 +02:00
|-------------|-----------------------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL</code> |
| YAML | <code>workspace_prebuilds.reconciliation_interval</code> |
2025-07-01 14:35:02 +01:00
| Default | <code>1m0s</code> |
2025-06-26 15:54:52 +02:00
How often to reconcile workspace prebuilds state.
2026-04-13 15:06:06 +02:00
### --chat-debug-logging-enabled
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-04-13 15:06:06 +02:00
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CHAT_DEBUG_LOGGING_ENABLED</code> |
| YAML | <code>chat.debugLoggingEnabled</code> |
| Default | <code>false</code> |
Force chat debug logging on for every chat, bypassing the runtime admin and user opt-in settings.
2026-09-28 11:25:01 +02:00
### --chat-max-steps-per-turn
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-28 11:25:01 +02:00
|-------------|---------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_CHAT_MAX_STEPS_PER_TURN</code> |
| YAML | <code>chat.maxStepsPerTurn</code> |
| Default | <code>1200</code> |
Maximum number of steps in a chat turn. Each model response is one step; compaction summaries, advisor calls, and retried attempts do not count. A turn that reaches the limit runs the tools from the last response, then ends without an error. Must be at least 1.
### --chat-max-generation-retries
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-28 11:25:01 +02:00
|-------------|-------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_CHAT_MAX_GENERATION_RETRIES</code> |
| YAML | <code>chat.maxGenerationRetries</code> |
| Default | <code>25</code> |
Maximum number of consecutive retries after a model generation fails with a transient error, such as a rate limit, an overloaded provider, or a stream that stops sending data. The count resets after each successful step. When the retries run out, the chat moves to the error state and shows the provider error. Advisor calls and the generation of chat titles, summaries, and turn status labels use the same limit. Must be at least 1.
### --chat-max-queued-messages-per-chat
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-28 11:25:01 +02:00
|-------------|-------------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_CHAT_MAX_QUEUED_MESSAGES_PER_CHAT</code> |
| YAML | <code>chat.maxQueuedMessagesPerChat</code> |
| Default | <code>20</code> |
2026-11-09 15:55:17 +11:00
Maximum number of messages that can be queued in a chat. Sending a message that would make a full queue longer fails with HTTP 429. Must be at least 1.
2026-09-28 11:25:01 +02:00
### --chat-max-attachments-per-chat
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-28 11:25:01 +02:00
|-------------|---------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_CHAT_MAX_ATTACHMENTS_PER_CHAT</code> |
| YAML | <code>chat.maxAttachmentsPerChat</code> |
| Default | <code>50</code> |
Maximum number of files linked to a chat, including user uploads, files the agent attaches, and desktop recordings and their thumbnails. Linking a file beyond the limit permanently deletes the chat's earliest-uploaded files, and earlier messages show them as expired. A message that includes more files than the limit is rejected with HTTP 400. Must be at least 1.
### --chat-max-prompt-bytes
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-28 11:25:01 +02:00
|-------------|-------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_CHAT_MAX_PROMPT_BYTES</code> |
| YAML | <code>chat.maxPromptBytes</code> |
| Default | <code>131072</code> |
Maximum size in bytes of the deployment system prompt, the plan mode instructions, and each user's custom prompt. Saving a longer prompt fails with HTTP 400. Lowering the limit does not affect prompts that are already saved. Must be at least 1.
### --chat-max-concurrent-recording-uploads
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-28 11:25:01 +02:00
|-------------|-----------------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_CHAT_MAX_CONCURRENT_RECORDING_UPLOADS</code> |
| YAML | <code>chat.maxConcurrentRecordingUploads</code> |
| Default | <code>25</code> |
Maximum number of virtual desktop recordings that each Coder server stores at the same time. Each upload holds the recording and its thumbnail in memory, up to 110 MB. Additional recordings wait for a free slot and are discarded if none frees up within 90 seconds. Must be at least 1.
2026-09-18 15:24:15 +10:00
### --chat-stream-silence-timeout
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-18 15:24:15 +10:00
|-------------|-------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_CHAT_STREAM_SILENCE_TIMEOUT</code> |
| YAML | <code>chat.streamSilenceTimeout</code> |
| Default | <code>10m0s</code> |
Maximum time to wait for the next streamed part from the chat model before the attempt is canceled and retried. This also bounds the time to first token. Set to 0 to disable. Must be no more than 24h.
2026-05-21 11:14:11 +02:00
### --ai-gateway-enabled
2025-10-29 06:18:38 -06:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|----------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_ENABLED</code> |
| YAML | <code>ai_gateway.enabled</code> |
2026-06-11 10:07:32 +02:00
| Default | <code>true</code> |
2025-10-29 06:18:38 -06:00
2026-11-11 11:50:16 +00:00
Whether to enable AI Gateway. Use --ai-gateway-embedded-enabled to control whether coderd also starts an in-memory AI Gateway instance.
### --ai-gateway-embedded-enabled
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_EMBEDDED_ENABLED</code> |
| YAML | <code>ai_gateway.embedded_enabled</code> |
| Default | <code>true</code> |
Whether to start an in-memory AI Gateway instance inside coderd. Has no effect unless --ai-gateway-enabled is true. Set to false when all AI Gateway traffic is served by standalone AI Gateway instances. Coder Agents requires this option to be set to true.
2025-10-29 06:18:38 -06:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-retention
2025-11-21 11:35:36 +02:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_AI_GATEWAY_RETENTION</code> |
| YAML | <code>ai_gateway.retention</code> |
| Default | <code>60d</code> |
2025-11-21 11:35:36 +02:00
Length of time to retain data such as interceptions and all related records (token, prompt, tool use).
2025-12-02 16:04:06 +02:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-max-concurrency
2025-12-11 16:38:54 +01:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_AI_GATEWAY_MAX_CONCURRENCY</code> |
| YAML | <code>ai_gateway.max_concurrency</code> |
| Default | <code>0</code> |
2025-12-11 16:38:54 +01:00
2026-05-21 11:14:11 +02:00
Maximum number of concurrent AI Gateway requests per replica. Set to 0 to disable (unlimited).
2025-12-11 16:38:54 +01:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-rate-limit
2025-12-11 16:38:54 +01:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|-------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_AI_GATEWAY_RATE_LIMIT</code> |
| YAML | <code>ai_gateway.rate_limit</code> |
| Default | <code>0</code> |
2025-12-11 16:38:54 +01:00
2026-05-21 11:14:11 +02:00
Maximum number of AI Gateway requests per second per replica. Set to 0 to disable (unlimited).
2025-12-11 16:38:54 +01:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-structured-logging
2026-01-14 17:26:08 +02:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|---------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_STRUCTURED_LOGGING</code> |
| YAML | <code>ai_gateway.structured_logging</code> |
| Default | <code>false</code> |
2026-01-14 17:26:08 +02:00
2026-05-21 11:14:11 +02:00
Emit structured logs for AI Gateway interception records. Use this for exporting these records to external SIEM or observability systems.
2026-01-14 17:26:08 +02:00
2026-09-29 11:48:52 +02:00
### --ai-gateway-structured-logging-source
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-29 11:48:52 +02:00
|-------------|----------------------------------------------------------|
| Type | <code>coderd\|gateway\|both</code> |
| Environment | <code>$CODER_AI_GATEWAY_STRUCTURED_LOGGING_SOURCE</code> |
| YAML | <code>ai_gateway.structured_logging_source</code> |
| Default | <code>coderd</code> |
2026-09-29 11:48:53 +02:00
Which process emits AI Gateway interception records when structured logging is enabled: coderd, the gateway, or both. The gateway emits records that are never persisted, such as those dropped by --ai-gateway-disable-content-recording, but cannot report thread_parent_id or thread_root_id. Use both to verify a move from one to the other; records reaching coderd are then reported twice. A standalone gateway must be configured to emit its own records, and its logs shipped rather than coderd's.
### --ai-gateway-disable-content-recording
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-29 11:48:53 +02:00
|-------------|----------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_DISABLE_CONTENT_RECORDING</code> |
| YAML | <code>ai_gateway.disable_content_recording</code> |
| Default | <code>false</code> |
Stop recording the content of intercepted conversations. No user prompt, tool call or model reasoning record is stored, including tool names and the arguments they were called with. Interceptions and token usage are still recorded, so cost controls, budget enforcement and spend reporting are unaffected. Sessions show no conversation detail, prompt and tool call telemetry report zero, and interceptions are no longer grouped into threads for clients that do not send their own session ID. Combine with --ai-gateway-structured-logging-source=gateway to keep exporting these records to a SIEM instead.
2026-09-29 11:48:52 +02:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-send-actor-headers
2026-01-26 17:08:17 +02:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|---------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_SEND_ACTOR_HEADERS</code> |
| YAML | <code>ai_gateway.send_actor_headers</code> |
| Default | <code>false</code> |
2026-01-26 17:08:17 +02:00
2026-09-29 20:26:17 +01:00
Add configured headers identifying the authenticated user to intercepted upstream requests. Use this when a proxy between AI Gateway and an upstream AI provider needs user identity. When enabled, removes client-supplied headers at configured actor-header destinations before adding authenticated values. Client headers starting with X-AI-Bridge-Actor are always removed.
2026-09-29 18:22:59 +01:00
### --ai-gateway-actor-header-id
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-29 18:22:59 +01:00
|-------------|------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_ACTOR_HEADER_ID</code> |
| YAML | <code>ai_gateway.actor_header_id</code> |
| Default | <code>X-AI-Bridge-Actor-ID</code> |
Header name for the authenticated user's ID. Empty disables this header. Requires AI Gateway actor headers to be enabled.
### --ai-gateway-actor-header-username
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-29 18:22:59 +01:00
|-------------|------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_ACTOR_HEADER_USERNAME</code> |
| YAML | <code>ai_gateway.actor_header_username</code> |
| Default | <code>X-AI-Bridge-Actor-Metadata-Username</code> |
Header name for the authenticated user's username. Empty disables this header. Requires AI Gateway actor headers to be enabled.
2026-01-26 17:08:17 +02:00
2026-09-29 20:07:49 +01:00
### --ai-gateway-actor-header-email
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-29 20:07:49 +01:00
|-------------|---------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_ACTOR_HEADER_EMAIL</code> |
| YAML | <code>ai_gateway.actor_header_email</code> |
Header name for the authenticated user's email address. Empty disables this header. Requires AI Gateway actor headers to be enabled. Applies to every configured provider; email is personal information.
2026-05-26 15:57:01 +02:00
### --ai-gateway-dump-dir
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-26 15:57:01 +02:00
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_DUMP_DIR</code> |
| YAML | <code>ai_gateway.api_dump_dir</code> |
2026-06-29 14:33:22 +01:00
Base directory for dumping AI Gateway request/response pairs to disk for debugging. When set, each provider writes under a subdirectory named after the provider. Sensitive headers are redacted. Leave empty to disable.
2026-05-26 15:57:01 +02:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-allow-byok
2026-04-15 14:16:49 -04:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_ALLOW_BYOK</code> |
| YAML | <code>ai_gateway.allow_byok</code> |
| Default | <code>true</code> |
2026-04-15 14:16:49 -04:00
Allow users to provide their own LLM API keys or subscriptions. When disabled, only centralized key authentication is permitted.
2026-05-21 11:14:11 +02:00
### --ai-gateway-circuit-breaker-enabled
2026-01-20 14:59:29 +01:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|--------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_CIRCUIT_BREAKER_ENABLED</code> |
| YAML | <code>ai_gateway.circuit_breaker_enabled</code> |
| Default | <code>false</code> |
2026-01-20 14:59:29 +01:00
2026-04-30 09:31:32 +01:00
Enable the circuit breaker to protect against cascading failures from upstream AI provider overload (503, 529).
2026-01-20 14:59:29 +01:00
2026-05-12 10:48:36 -04:00
### --ai-budget-policy
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|---------------------------------------|
| Type | <code>highest</code> |
| Environment | <code>$CODER_AI_BUDGET_POLICY</code> |
| YAML | <code>ai_gateway.budget_policy</code> |
| Default | <code>highest</code> |
2026-05-12 10:48:36 -04:00
Determines the effective group when a user belongs to multiple groups with AI budgets. "highest" selects the group with the largest spend limit, and is currently the only supported value.
### --ai-budget-period
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|---------------------------------------|
| Type | <code>month</code> |
| Environment | <code>$CODER_AI_BUDGET_PERIOD</code> |
| YAML | <code>ai_gateway.budget_period</code> |
| Default | <code>month</code> |
2026-05-12 10:48:36 -04:00
Determines when accumulated AI spend resets to zero, aligned to UTC calendar boundaries. Only "month" is currently supported.
2026-05-21 11:14:11 +02:00
### --ai-gateway-proxy-enabled
2025-12-29 15:31:51 +00:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_ENABLED</code> |
| YAML | <code>ai_gateway_proxy.enabled</code> |
| Default | <code>false</code> |
2025-12-29 15:31:51 +00:00
2026-05-21 11:14:11 +02:00
Enable the AI Gateway MITM Proxy for intercepting and decrypting AI provider requests.
2025-12-29 15:31:51 +00:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-proxy-listen-addr
2026-03-05 09:19:34 +00:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-03-05 09:19:34 +00:00
|-------------|--------------------------------------------------|
| Type | <code>string</code> |
2026-05-21 11:14:11 +02:00
| Environment | <code>$CODER_AI_GATEWAY_PROXY_LISTEN_ADDR</code> |
| YAML | <code>ai_gateway_proxy.listen_addr</code> |
| Default | <code>:8888</code> |
2026-03-05 09:19:34 +00:00
2026-05-21 11:14:11 +02:00
The address the AI Gateway Proxy will listen on.
2026-03-05 09:19:34 +00:00
2026-07-14 18:40:22 +02:00
### --ai-gateway-proxy-target
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-07-14 18:40:22 +02:00
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_TARGET</code> |
| YAML | <code>ai_gateway_proxy.target</code> |
Base URL of the AI Gateway to forward intercepted requests to. Defaults to the embedded AI Gateway address at the Coder access URL plus /api/v2/ai-gateway.
2026-05-21 11:14:11 +02:00
### --ai-gateway-proxy-tls-cert-file
2026-03-05 09:19:34 +00:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_TLS_CERT_FILE</code> |
| YAML | <code>ai_gateway_proxy.tls_cert_file</code> |
2026-03-05 09:19:34 +00:00
2026-05-21 11:14:11 +02:00
Path to the TLS certificate file for the AI Gateway Proxy listener. Must be set together with AI Gateway Proxy TLS Key File.
2026-03-05 09:19:34 +00:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-proxy-tls-key-file
2025-12-29 15:31:51 +00:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|---------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_TLS_KEY_FILE</code> |
| YAML | <code>ai_gateway_proxy.tls_key_file</code> |
2025-12-29 15:31:51 +00:00
2026-05-21 11:14:11 +02:00
Path to the TLS private key file for the AI Gateway Proxy listener. Must be set together with AI Gateway Proxy TLS Certificate File.
2025-12-29 15:31:51 +00:00
2026-05-21 11:14:11 +02:00
### --ai-gateway-proxy-cert-file
2026-01-19 08:50:57 +00:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-01-19 08:50:57 +00:00
|-------------|------------------------------------------------|
| Type | <code>string</code> |
2026-05-21 11:14:11 +02:00
| Environment | <code>$CODER_AI_GATEWAY_PROXY_CERT_FILE</code> |
| YAML | <code>ai_gateway_proxy.cert_file</code> |
Path to the CA certificate file used to intercept (MITM) HTTPS traffic from AI clients. This CA must be trusted by AI clients for the proxy to decrypt their requests.
### --ai-gateway-proxy-key-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_KEY_FILE</code> |
| YAML | <code>ai_gateway_proxy.key_file</code> |
Path to the CA private key file used to intercept (MITM) HTTPS traffic from AI clients.
### --ai-gateway-proxy-upstream
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_UPSTREAM</code> |
| YAML | <code>ai_gateway_proxy.upstream_proxy</code> |
URL of an upstream HTTP proxy to chain tunneled (non-allowlisted) requests through. Format: http://[user:pass@]host:port or https://[user:pass@]host:port.
### --ai-gateway-proxy-upstream-ca
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|--------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_UPSTREAM_CA</code> |
| YAML | <code>ai_gateway_proxy.upstream_proxy_ca</code> |
2026-01-19 08:50:57 +00:00
Path to a PEM-encoded CA certificate to trust for the upstream proxy's TLS connection. Only needed for HTTPS upstream proxies with certificates not trusted by the system. If not provided, the system certificate pool is used.
2026-05-21 11:14:11 +02:00
### --ai-gateway-proxy-allowed-private-cidrs
2026-03-20 09:49:26 +00:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|------------------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_ALLOWED_PRIVATE_CIDRS</code> |
| YAML | <code>ai_gateway_proxy.allowed_private_cidrs</code> |
2026-03-20 09:49:26 +00:00
Comma-separated list of CIDR ranges that are permitted even though they fall within blocked private/reserved IP ranges. By default all private ranges are blocked to prevent SSRF attacks. Use this to allow access to specific internal networks.
2026-05-21 11:14:11 +02:00
### --ai-gateway-proxy-dump-dir
2026-05-11 10:59:26 +02:00
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-21 11:14:11 +02:00
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_PROXY_DUMP_DIR</code> |
| YAML | <code>ai_gateway_proxy.api_dump_dir</code> |
2026-05-11 10:59:26 +02:00
Directory for dumping MITM request/response pairs to disk for debugging. When set, each proxied request produces .req.txt and .resp.txt files organized by provider. Sensitive headers are redacted. Leave empty to disable.
2025-12-02 16:04:06 +02:00
### --audit-logs-retention
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-12-02 16:04:06 +02:00
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_AUDIT_LOGS_RETENTION</code> |
| YAML | <code>retention.audit_logs</code> |
| Default | <code>0</code> |
How long audit log entries are retained. Set to 0 to disable (keep indefinitely). We advise keeping audit logs for at least a year, and in accordance with your compliance requirements.
### --connection-logs-retention
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-12-02 16:04:06 +02:00
|-------------|-----------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_CONNECTION_LOGS_RETENTION</code> |
| YAML | <code>retention.connection_logs</code> |
| Default | <code>0</code> |
How long connection log entries are retained. Set to 0 to disable (keep indefinitely).
### --api-keys-retention
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-12-02 16:04:06 +02:00
|-------------|----------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_API_KEYS_RETENTION</code> |
| YAML | <code>retention.api_keys</code> |
| Default | <code>7d</code> |
How long expired API keys are retained before being deleted. Keeping expired keys allows the backend to return a more helpful error when a user tries to use an expired key. Set to 0 to disable automatic deletion of expired keys.
2025-12-02 18:01:33 +02:00
### --workspace-agent-logs-retention
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-12-02 18:01:33 +02:00
|-------------|----------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_AGENT_LOGS_RETENTION</code> |
| YAML | <code>retention.workspace_agent_logs</code> |
| Default | <code>7d</code> |
How long workspace agent logs are retained. Logs from non-latest builds are deleted if the agent hasn't connected within this period. Logs from the latest build are always retained. Set to 0 to disable automatic deletion.
2026-05-11 09:48:55 -04:00
2026-06-16 14:32:54 +02:00
### --boundary-log-retention
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-06-16 14:32:54 +02:00
|-------------|--------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_BOUNDARY_LOG_RETENTION</code> |
| YAML | <code>retention.boundary_logs</code> |
| Default | <code>0</code> |
How long boundary audit log entries are retained. Boundary logs record HTTP requests processed by a Boundary confinement proxy. Set to 0 to disable automatic deletion (keep indefinitely). Adjust to match your organization's regulatory requirements.
2026-05-11 09:48:55 -04:00
### --disable-template-builder
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-11 09:48:55 -04:00
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_TEMPLATE_BUILDER</code> |
| YAML | <code>templateBuilder.disabled</code> |
Disable the template builder feature for guided template creation. When disabled, all /api/v2/templatebuilder/* endpoints return 404.
### --template-builder-registry-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-05-11 09:48:55 -04:00
|-------------|---------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_BUILDER_REGISTRY_URL</code> |
| YAML | <code>templateBuilder.registryURL</code> |
2026-06-23 09:17:14 -04:00
| Default | <code>registry.coder.com</code> |
2026-05-11 09:48:55 -04:00
2026-08-31 09:32:24 -04:00
The module registry host the template builder uses for module source paths (for example, "registry.coder.com" or "mirror.internal:8443"). An http(s):// scheme and trailing slash are stripped; a path, query, fragment, or credentials is rejected.