2023-03-23 22:42:20 +00:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server
Start a Coder server
## Usage
```console
coder server [flags]
```
## Subcommands
2023-04-11 20:05:51 +00:00
| Name | Purpose |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [<code>create-admin-user</code> ](./server_create-admin-user.md ) | Create a new admin user with the given username, email and password and adds it to every organization. |
2023-09-07 14:49:49 +00:00
| [<code>dbcrypt</code> ](./server_dbcrypt.md ) | Manage database encryption. |
2023-04-11 20:05:51 +00:00
| [<code>postgres-builtin-serve</code> ](./server_postgres-builtin-serve.md ) | Run the built-in PostgreSQL deployment. |
| [<code>postgres-builtin-url</code> ](./server_postgres-builtin-url.md ) | Output the connection URL for the built-in PostgreSQL deployment. |
2023-03-23 22:42:20 +00:00
## Options
### --access-url
2023-04-07 22:58:21 +00:00
| | |
| ----------- | --------------------------------- |
| Type | < code > url< / code > |
| Environment | < code > $CODER_ACCESS_URL< / code > |
| YAML | < code > networking.accessURL< / code > |
2023-03-23 22:42:20 +00:00
The URL that users will use to access the Coder deployment.
2023-12-15 09:33:51 +00:00
### --allow-custom-quiet-hours
| | |
| ----------- | --------------------------------------------------------- |
| 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-12-15 18:38:47 +00:00
### --allow-workspace-renames
| | |
| ----------- | ------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_ALLOW_WORKSPACE_RENAMES< / code > |
| YAML | < code > allowWorkspaceRenames< / code > |
| Default | < code > false< / code > |
DEPRECATED: Allow users to rename their workspaces. Use only for temporary compatibility reasons, this will be removed in a future release.
2023-06-21 22:02:05 +00:00
### --block-direct-connections
| | |
| ----------- | ---------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_BLOCK_DIRECT< / code > |
| YAML | < code > networking.derp.blockDirect< / code > |
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-03-23 22:42:20 +00:00
### --browser-only
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ----------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_BROWSER_ONLY< / code > |
| YAML | < code > networking.browserOnly< / code > |
2023-03-23 22:42:20 +00:00
Whether Coder only allows connections to workspaces via the browser.
2024-01-30 23:11:37 +00:00
### --cli-upgrade-message
| | |
| ----------- | --------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_CLI_UPGRADE_MESSAGE< / code > |
| YAML | < code > client.cliUpgradeMessage< / code > |
The upgrade message to display to users when a client/server mismatch is detected. By default it instructs users to update using 'curl -L https://coder.com/install.sh | sh'.
2023-03-23 22:42:20 +00:00
### --cache-dir
| | |
| ----------- | ----------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_CACHE_DIRECTORY< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > cacheDir< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > ~/.cache/coder< / code > |
The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd.
2023-04-07 22:58:21 +00:00
### --trace-logs
| | |
| ----------- | ---------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_TRACE_LOGS< / code > |
| YAML | < code > introspection.tracing.captureLogs< / code > |
2023-07-26 21:46:22 +00:00
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.
2023-04-07 22:58:21 +00:00
### -c, --config
| | |
| ----------- | ------------------------------- |
| Type | < code > yaml-config-path< / code > |
| Environment | < code > $CODER_CONFIG_PATH< / code > |
Specify a YAML file to load configuration from.
2023-03-23 22:42:20 +00:00
### --dangerous-allow-path-app-sharing
| | |
| ----------- | ---------------------------------------------------- |
| 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
| | |
| ----------- | -------------------------------------------------------------- |
| 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.
### --derp-config-path
2023-04-07 22:58:21 +00:00
| | |
| ----------- | --------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_DERP_CONFIG_PATH< / code > |
| YAML | < code > networking.derp.configPath< / code > |
2023-03-23 22:42:20 +00:00
Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/.
### --derp-config-url
| | |
| ----------- | ----------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_DERP_CONFIG_URL< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > networking.derp.url< / code > |
2023-03-23 22:42:20 +00:00
URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/.
2023-08-24 17:22:31 +00:00
### --derp-force-websockets
| | |
| ----------- | -------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_DERP_FORCE_WEBSOCKETS< / code > |
| YAML | < code > networking.derp.forceWebSockets< / code > |
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 22:42:20 +00:00
### --derp-server-enable
| | |
| ----------- | -------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_DERP_SERVER_ENABLE< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > networking.derp.enable< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > true< / code > |
Whether to enable or disable the embedded DERP relay server.
### --derp-server-region-name
| | |
| ----------- | ------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_DERP_SERVER_REGION_NAME< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > networking.derp.regionName< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > Coder Embedded Relay< / code > |
Region name that for the embedded DERP server.
### --derp-server-relay-url
| | |
| ----------- | ----------------------------------------- |
| Type | < code > url< / code > |
| Environment | < code > $CODER_DERP_SERVER_RELAY_URL< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > networking.derp.relayURL< / code > |
2023-03-23 22:42:20 +00:00
An HTTP URL that is accessible by other replicas to relay DERP traffic. Required for high availability.
### --derp-server-stun-addresses
2023-08-10 19:04:17 +00: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 22:42:20 +00:00
2023-08-10 19:04:17 +00: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 22:42:20 +00:00
2023-07-20 13:35:41 +00:00
### --default-quiet-hours-schedule
| | |
| ----------- | ------------------------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_QUIET_HOURS_DEFAULT_SCHEDULE< / code > |
| YAML | < code > userQuietHoursSchedule.defaultQuietHoursSchedule< / code > |
2023-12-15 08:27:56 +00:00
| Default | < code > CRON_TZ=UTC 0 0 \* \* \*</ code > |
2023-07-20 13:35:41 +00:00
2023-12-15 08:27:56 +00: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 round the max deadline up to be within the user's quiet hours window (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).
2023-07-20 13:35:41 +00:00
2023-04-11 13:57:23 +00:00
### --disable-owner-workspace-access
| | |
| ----------- | -------------------------------------------------- |
| 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.
2023-03-23 22:42:20 +00:00
### --disable-password-auth
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------------------ |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_DISABLE_PASSWORD_AUTH< / code > |
| YAML | < code > networking.http.disablePasswordAuth< / code > |
2023-03-23 22:42:20 +00:00
Disable password authentication. This is recommended for security purposes in production deployments that rely on an identity provider. Any user with the owner role will be able to sign in with their password regardless of this setting to avoid potential lock out. If you are locked out of your account, you can use the `coder server create-admin` command to create a new admin user directly in the database.
### --disable-path-apps
| | |
| ----------- | ------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_DISABLE_PATH_APPS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > disablePathApps< / code > |
2023-03-23 22:42:20 +00:00
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-session-expiry-refresh
2023-04-07 22:58:21 +00:00
| | |
| ----------- | -------------------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_DISABLE_SESSION_EXPIRY_REFRESH< / code > |
| YAML | < code > networking.http.disableSessionExpiryRefresh< / code > |
2023-03-23 22:42:20 +00:00
Disable automatic session expiry bumping due to activity. This forces all sessions to become invalid after the session expiry duration has been reached.
2023-07-19 11:31:17 +00:00
### --docs-url
| | |
| ----------- | ------------------------------- |
| Type | < code > url< / code > |
| Environment | < code > $CODER_DOCS_URL< / code > |
| YAML | < code > networking.docsURL< / code > |
Specifies the custom docs URL.
2023-08-08 16:37:49 +00:00
### --oidc-group-auto-create
| | |
| ----------- | ------------------------------------------ |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_OIDC_GROUP_AUTO_CREATE< / code > |
| YAML | < code > oidc.enableGroupAutoCreate< / code > |
| Default | < code > false< / code > |
Automatically creates missing groups from a user's groups claim.
2023-06-29 13:22:21 +00:00
### --enable-terraform-debug-mode
| | |
| ----------- | ----------------------------------------------------------- |
| 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.
2023-04-07 22:58:21 +00:00
### --swagger-enable
| | |
| ----------- | ---------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_SWAGGER_ENABLE< / code > |
| YAML | < code > enableSwagger< / code > |
Expose the swagger endpoint via /swagger.
2023-03-23 22:42:20 +00:00
### --experiments
| | |
| ----------- | ------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_EXPERIMENTS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > experiments< / code > |
2023-03-23 22:42:20 +00:00
Enable one or more experiments. These are not ready for production. Separate multiple experiments with commas, or enter '\*' to opt-in to all available experiments.
2023-09-07 14:49:49 +00:00
### --external-token-encryption-keys
| | |
| ----------- | -------------------------------------------------- |
| 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.
2023-04-07 22:58:21 +00:00
### --provisioner-force-cancel-interval
| | |
| ----------- | ----------------------------------------------------- |
| 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.
2023-03-23 22:42:20 +00:00
### --http-address
2023-04-07 22:58:21 +00: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-03-23 22:42:20 +00:00
HTTP bind address of the server. Unset to disable the HTTP endpoint.
2023-11-13 14:14:43 +00:00
### --health-check-refresh
| | |
| ----------- | ---------------------------------------------- |
| Type | < code > duration< / code > |
| Environment | < code > $CODER_HEALTH_CHECK_REFRESH< / code > |
| YAML | < code > introspection.healthcheck.refresh< / code > |
| Default | < code > 10m0s< / code > |
Refresh interval for healthchecks.
### --health-check-threshold-database
| | |
| ----------- | -------------------------------------------------------- |
| Type | < code > duration< / code > |
| Environment | < code > $CODER_HEALTH_CHECK_THRESHOLD_DATABASE< / code > |
| YAML | < code > introspection.healthcheck.thresholdDatabase< / code > |
| Default | < code > 15ms< / code > |
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.
2023-03-23 22:42:20 +00:00
### --log-human
2023-04-07 22:58:21 +00:00
| | |
| ----------- | -------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_LOGGING_HUMAN< / code > |
| YAML | < code > introspection.logging.humanPath< / code > |
| Default | < code > /dev/stderr< / code > |
2023-03-23 22:42:20 +00:00
Output human-readable logs to a given file.
### --log-json
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_LOGGING_JSON< / code > |
| YAML | < code > introspection.logging.jsonPath< / code > |
2023-03-23 22:42:20 +00:00
Output JSON logs to a given file.
2023-07-26 21:46:22 +00:00
### -l, --log-filter
| | |
| ----------- | ----------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_LOG_FILTER< / code > |
| YAML | < code > introspection.logging.filter< / code > |
Filter debug logs by matching against a given regex. Use .\* to match all debug logs.
2023-03-23 22:42:20 +00:00
### --max-token-lifetime
2023-04-07 22:58:21 +00:00
| | |
| ----------- | --------------------------------------------- |
| Type | < code > duration< / code > |
| Environment | < code > $CODER_MAX_TOKEN_LIFETIME< / code > |
| YAML | < code > networking.http.maxTokenLifetime< / code > |
| Default | < code > 876600h0m0s< / code > |
2023-03-23 22:42:20 +00:00
The maximum lifetime duration users can specify when creating an API token.
### --oauth2-github-allow-everyone
| | |
| ----------- | ------------------------------------------------ |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oauth2.github.allowEveryone< / code > |
2023-03-23 22:42:20 +00:00
Allow all logins, setting this option means allowed orgs and teams must be empty.
### --oauth2-github-allow-signups
| | |
| ----------- | ----------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oauth2.github.allowSignups< / code > |
2023-03-23 22:42:20 +00:00
Whether new users can sign up with GitHub.
### --oauth2-github-allowed-orgs
| | |
| ----------- | ---------------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_OAUTH2_GITHUB_ALLOWED_ORGS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oauth2.github.allowedOrgs< / code > |
2023-03-23 22:42:20 +00:00
Organizations the user must be a member of to Login with GitHub.
### --oauth2-github-allowed-teams
| | |
| ----------- | ----------------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oauth2.github.allowedTeams< / code > |
2023-03-23 22:42:20 +00:00
Teams inside organizations the user must be a member of to Login with GitHub. Structured as: < organization-name > /< team-slug > .
### --oauth2-github-client-id
| | |
| ----------- | ------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OAUTH2_GITHUB_CLIENT_ID< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oauth2.github.clientID< / code > |
2023-03-23 22:42:20 +00:00
Client ID for Login with GitHub.
### --oauth2-github-client-secret
| | |
| ----------- | ----------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OAUTH2_GITHUB_CLIENT_SECRET< / code > |
Client secret for Login with GitHub.
### --oauth2-github-enterprise-base-url
| | |
| ----------- | ----------------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oauth2.github.enterpriseBaseURL< / code > |
2023-03-23 22:42:20 +00:00
Base URL of a GitHub Enterprise deployment to use for Login with GitHub.
### --oidc-allow-signups
| | |
| ----------- | -------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_OIDC_ALLOW_SIGNUPS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.allowSignups< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > true< / code > |
Whether new users can sign up with OIDC.
2023-12-08 16:14:19 +00:00
### --oidc-allowed-groups
| | |
| ----------- | --------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_OIDC_ALLOWED_GROUPS< / code > |
| YAML | < code > oidc.groupAllowed< / code > |
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-03-30 08:36:57 +00:00
### --oidc-auth-url-params
| | |
| ----------- | ---------------------------------------- |
| Type | < code > struct[map[string]string]< / code > |
| Environment | < code > $CODER_OIDC_AUTH_URL_PARAMS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.authURLParams< / code > |
2023-03-30 08:36:57 +00:00
| Default | < code > {"access_type": "offline"}< / code > |
OIDC auth URL parameters to pass to the upstream provider.
2023-08-14 22:33:13 +00:00
### --oidc-client-cert-file
| | |
| ----------- | ----------------------------------------- |
| 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.
2023-03-23 22:42:20 +00:00
### --oidc-client-id
| | |
| ----------- | ---------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OIDC_CLIENT_ID< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.clientID< / code > |
2023-03-23 22:42:20 +00:00
Client ID to use for Login with OIDC.
2023-08-14 22:33:13 +00:00
### --oidc-client-key-file
| | |
| ----------- | ---------------------------------------- |
| 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.
2023-03-23 22:42:20 +00:00
### --oidc-client-secret
| | |
| ----------- | -------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OIDC_CLIENT_SECRET< / code > |
Client secret to use for Login with OIDC.
### --oidc-email-domain
| | |
| ----------- | ------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_OIDC_EMAIL_DOMAIN< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.emailDomain< / code > |
2023-03-23 22:42:20 +00:00
Email domains that clients logging in with OIDC must match.
2023-03-30 08:36:57 +00:00
### --oidc-email-field
| | |
| ----------- | ------------------------------------ |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OIDC_EMAIL_FIELD< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.emailField< / code > |
2023-03-30 08:36:57 +00:00
| Default | < code > email< / code > |
OIDC claim field to use as the email.
2023-03-23 22:42:20 +00:00
### --oidc-group-field
| | |
| ----------- | ------------------------------------ |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OIDC_GROUP_FIELD< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.groupField< / code > |
2023-03-23 22:42:20 +00:00
2023-06-08 13:51:59 +00: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 22:42:20 +00:00
### --oidc-group-mapping
| | |
| ----------- | -------------------------------------- |
| Type | < code > struct[map[string]string]< / code > |
2023-04-05 08:07:43 +00:00
| Environment | < code > $CODER_OIDC_GROUP_MAPPING< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.groupMapping< / code > |
2023-03-23 22:42:20 +00: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.
### --oidc-ignore-email-verified
| | |
| ----------- | ---------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_OIDC_IGNORE_EMAIL_VERIFIED< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.ignoreEmailVerified< / code > |
2023-03-23 22:42:20 +00:00
Ignore the email_verified claim from the upstream provider.
2023-04-05 08:07:43 +00:00
### --oidc-ignore-userinfo
| | |
| ----------- | ---------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_OIDC_IGNORE_USERINFO< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.ignoreUserInfo< / code > |
2023-04-05 08:07:43 +00:00
| Default | < code > false< / code > |
Ignore the userinfo endpoint and only use the ID token for user information.
2023-03-23 22:42:20 +00:00
### --oidc-issuer-url
| | |
| ----------- | ----------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OIDC_ISSUER_URL< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.issuerURL< / code > |
2023-03-23 22:42:20 +00:00
Issuer URL to use for Login with OIDC.
2023-08-08 16:37:49 +00:00
### --oidc-group-regex-filter
| | |
| ----------- | ------------------------------------------- |
| Type | < code > regexp< / code > |
| Environment | < code > $CODER_OIDC_GROUP_REGEX_FILTER< / code > |
| YAML | < code > oidc.groupRegexFilter< / code > |
| Default | < code > .\*</ code > |
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.
2023-03-23 22:42:20 +00:00
### --oidc-scopes
| | |
| ----------- | --------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_OIDC_SCOPES< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.scopes< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > openid,profile,email< / code > |
Scopes to grant when authenticating with OIDC.
2023-07-24 12:34:24 +00:00
### --oidc-user-role-default
| | |
| ----------- | ------------------------------------------ |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_OIDC_USER_ROLE_DEFAULT< / code > |
| YAML | < code > oidc.userRoleDefault< / code > |
If user role sync is enabled, these roles are always included for all authenticated users. The 'member' role is always assigned.
### --oidc-user-role-field
| | |
| ----------- | ---------------------------------------- |
| 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
| | |
| ----------- | ------------------------------------------ |
| 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.
2023-03-23 22:42:20 +00:00
### --oidc-username-field
| | |
| ----------- | --------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_OIDC_USERNAME_FIELD< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > oidc.usernameField< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > preferred_username< / code > |
OIDC claim field to use as the username.
2023-04-07 22:58:21 +00:00
### --oidc-sign-in-text
2023-03-23 22:42:20 +00:00
| | |
| ----------- | ------------------------------------- |
| Type | < code > string< / code > |
2023-04-07 22:58:21 +00:00
| Environment | < code > $CODER_OIDC_SIGN_IN_TEXT< / code > |
| YAML | < code > oidc.signInText< / code > |
| Default | < code > OpenID Connect< / code > |
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
The text to show on the OpenID Connect sign in button.
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
### --oidc-icon-url
2023-03-23 22:42:20 +00:00
| | |
| ----------- | --------------------------------- |
2023-04-07 22:58:21 +00:00
| Type | < code > url< / code > |
| Environment | < code > $CODER_OIDC_ICON_URL< / code > |
| YAML | < code > oidc.iconURL< / code > |
2023-03-23 22:42:20 +00:00
2023-09-05 18:37:21 +00:00
URL pointing to the icon to use on the OpenID Connect login button.
2023-03-23 22:42:20 +00:00
### --provisioner-daemon-poll-interval
| | |
| ----------- | ---------------------------------------------------- |
| Type | < code > duration< / code > |
| Environment | < code > $CODER_PROVISIONER_DAEMON_POLL_INTERVAL< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > provisioning.daemonPollInterval< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > 1s< / code > |
2023-09-19 06:25:57 +00:00
Deprecated and ignored.
2023-03-23 22:42:20 +00:00
### --provisioner-daemon-poll-jitter
| | |
| ----------- | -------------------------------------------------- |
| Type | < code > duration< / code > |
| Environment | < code > $CODER_PROVISIONER_DAEMON_POLL_JITTER< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > provisioning.daemonPollJitter< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > 100ms< / code > |
2023-09-19 06:25:57 +00:00
Deprecated and ignored.
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
### --postgres-url
| | |
| ----------- | ------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_PG_CONNECTION_URL< / code > |
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".
### --prometheus-address
| | |
| ----------- | --------------------------------------------- |
| 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.
2024-03-13 10:03:36 +00:00
### --prometheus-aggregate-agent-stats-by
| | |
| ----------- | -------------------------------------------------------------- |
| 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.
2023-04-14 14:14:52 +00:00
### --prometheus-collect-agent-stats
| | |
| ----------- | --------------------------------------------------------- |
| 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).
2023-06-15 11:34:16 +00:00
### --prometheus-collect-db-metrics
| | |
| ----------- | -------------------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_PROMETHEUS_COLLECT_DB_METRICS< / code > |
| YAML | < code > introspection.prometheus.collect_db_metrics< / code > |
| Default | < code > false< / code > |
Collect database metrics (may increase charges for metrics storage).
2023-04-07 22:58:21 +00:00
### --prometheus-enable
| | |
| ----------- | -------------------------------------------- |
| 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.
2023-08-04 08:32:28 +00:00
### --provisioner-daemon-psk
| | |
| ----------- | ------------------------------------------ |
| Type | < code > string< / code > |
| Environment | < code > $CODER_PROVISIONER_DAEMON_PSK< / code > |
Pre-shared key to authenticate external provisioner daemons to Coder server.
2023-03-23 22:42:20 +00:00
### --provisioner-daemons
| | |
| ----------- | --------------------------------------- |
| Type | < code > int< / code > |
| Environment | < code > $CODER_PROVISIONER_DAEMONS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > provisioning.daemons< / code > |
2023-03-23 22:42:20 +00:00
| 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.
2023-06-08 17:58:24 +00:00
### --proxy-health-interval
| | |
| ----------- | ------------------------------------------------ |
| 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.
2023-03-23 22:42:20 +00:00
### --proxy-trusted-headers
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_PROXY_TRUSTED_HEADERS< / code > |
| YAML | < code > networking.proxyTrustedHeaders< / code > |
2023-03-23 22:42:20 +00:00
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, True-Client-Ip, X-Forwarded-For.
### --proxy-trusted-origins
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_PROXY_TRUSTED_ORIGINS< / code > |
| YAML | < code > networking.proxyTrustedOrigins< / code > |
2023-03-23 22:42:20 +00:00
Origin addresses to respect "proxy-trusted-headers". e.g. 192.168.1.0/24.
### --redirect-to-access-url
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_REDIRECT_TO_ACCESS_URL< / code > |
| YAML | < code > networking.redirectToAccessURL< / code > |
2023-03-23 22:42:20 +00:00
Specifies whether to redirect requests that do not match the access URL host.
### --scim-auth-header
| | |
| ----------- | ------------------------------------ |
| 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.
### --ssh-config-options
| | |
| ----------- | -------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_SSH_CONFIG_OPTIONS< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > client.sshConfigOptions< / code > |
2023-03-23 22:42:20 +00: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.
### --ssh-hostname-prefix
| | |
| ----------- | --------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_SSH_HOSTNAME_PREFIX< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > client.sshHostnamePrefix< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > coder.< / code > |
The SSH deployment prefix is used in the Host of the ssh config.
### --ssh-keygen-algorithm
| | |
| ----------- | ---------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_SSH_KEYGEN_ALGORITHM< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > sshKeygenAlgorithm< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > ed25519< / code > |
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
2023-04-07 22:58:21 +00:00
### --secure-auth-cookie
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ---------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_SECURE_AUTH_COOKIE< / code > |
| YAML | < code > networking.secureAuthCookie< / code > |
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
Controls if the 'Secure' property is set on browser session cookies.
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
### --session-duration
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
| | |
| ----------- | -------------------------------------------- |
| Type | < code > duration< / code > |
| Environment | < code > $CODER_SESSION_DURATION< / code > |
| YAML | < code > networking.http.sessionDuration< / code > |
| Default | < code > 24h0m0s< / code > |
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
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.
2023-03-23 22:42:20 +00:00
2024-02-01 17:01:25 +00:00
### --oidc-signups-disabled-text
| | |
| ----------- | ---------------------------------------------- |
| 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.
2023-04-07 22:58:21 +00:00
### --log-stackdriver
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
| | |
| ----------- | -------------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_LOGGING_STACKDRIVER< / code > |
| YAML | < code > introspection.logging.stackdriverPath< / code > |
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
Output Stackdriver compatible logs to a given file.
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
### --strict-transport-security
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
| | |
| ----------- | --------------------------------------------------- |
| Type | < code > int< / code > |
| Environment | < code > $CODER_STRICT_TRANSPORT_SECURITY< / code > |
| YAML | < code > networking.tls.strictTransportSecurity< / code > |
| Default | < code > 0< / code > |
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
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.
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
### --strict-transport-security-options
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ---------------------------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS< / code > |
| YAML | < code > networking.tls.strictTransportSecurityOptions< / code > |
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
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.
2023-03-23 22:42:20 +00:00
2024-01-19 10:20:36 +00:00
### --support-links
| | |
| ----------- | ------------------------------------------ |
| 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.
2023-03-23 22:42:20 +00:00
### --tls-address
2023-04-07 22:58:21 +00: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 22:42:20 +00:00
HTTPS bind address of the server.
2023-11-07 14:55:39 +00:00
### --tls-allow-insecure-ciphers
| | |
| ----------- | --------------------------------------------------- |
| 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-03-23 22:42:20 +00:00
### --tls-cert-file
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_TLS_CERT_FILE< / code > |
| YAML | < code > networking.tls.certFiles< / code > |
2023-03-23 22:42:20 +00: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-11-07 14:55:39 +00:00
### --tls-ciphers
| | |
| ----------- | -------------------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_TLS_CIPHERS< / code > |
| YAML | < code > networking.tls.tlsCiphers< / code > |
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.
2023-03-23 22:42:20 +00:00
### --tls-client-auth
2023-04-07 22:58:21 +00:00
| | |
| ----------- | -------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_TLS_CLIENT_AUTH< / code > |
| YAML | < code > networking.tls.clientAuth< / code > |
| Default | < code > none< / code > |
2023-03-23 22:42:20 +00:00
Policy the server will follow for TLS Client Authentication. Accepted values are "none", "request", "require-any", "verify-if-given", or "require-and-verify".
### --tls-client-ca-file
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ---------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_TLS_CLIENT_CA_FILE< / code > |
| YAML | < code > networking.tls.clientCAFile< / code > |
2023-03-23 22:42:20 +00:00
PEM-encoded Certificate Authority file used for checking the authenticity of client.
### --tls-client-cert-file
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------------ |
| Type | < code > string< / code > |
| Environment | < code > $CODER_TLS_CLIENT_CERT_FILE< / code > |
| YAML | < code > networking.tls.clientCertFile< / code > |
2023-03-23 22:42:20 +00:00
Path to certificate for client TLS authentication. It requires a PEM-encoded file.
### --tls-client-key-file
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ----------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_TLS_CLIENT_KEY_FILE< / code > |
| YAML | < code > networking.tls.clientKeyFile< / code > |
2023-03-23 22:42:20 +00:00
Path to key for client TLS authentication. It requires a PEM-encoded file.
### --tls-enable
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ---------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_TLS_ENABLE< / code > |
| YAML | < code > networking.tls.enable< / code > |
2023-03-23 22:42:20 +00:00
Whether TLS will be enabled.
### --tls-key-file
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ------------------------------------ |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_TLS_KEY_FILE< / code > |
| YAML | < code > networking.tls.keyFiles< / code > |
2023-03-23 22:42:20 +00:00
Paths to the private keys for each of the certificates. It requires a PEM-encoded file.
### --tls-min-version
2023-04-07 22:58:21 +00:00
| | |
| ----------- | -------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_TLS_MIN_VERSION< / code > |
| YAML | < code > networking.tls.minVersion< / code > |
| Default | < code > tls12< / code > |
Minimum supported version of TLS. Accepted values are "tls10", "tls11", "tls12" or "tls13".
### --telemetry
| | |
| ----------- | ------------------------------------ |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_TELEMETRY_ENABLE< / code > |
| YAML | < code > telemetry.enable< / code > |
| Default | < code > true< / code > |
Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.
2023-03-23 22:42:20 +00:00
### --trace
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ----------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_TRACE_ENABLE< / code > |
| YAML | < code > introspection.tracing.enable< / code > |
2023-03-23 22:42:20 +00: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
| | |
| ----------- | ------------------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_TRACE_HONEYCOMB_API_KEY< / code > |
Enables trace exporting to Honeycomb.io using the provided API Key.
### --update-check
| | |
| ----------- | -------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_UPDATE_CHECK< / code > |
2023-04-07 22:58:21 +00:00
| YAML | < code > updateCheck< / code > |
2023-03-23 22:42:20 +00:00
| Default | < code > false< / code > |
Periodically check for new releases of Coder and inform the owner. The check is performed once per day.
2023-10-10 18:18:02 +00:00
### --web-terminal-renderer
| | |
| ----------- | ----------------------------------------- |
| 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'.
2023-03-23 22:42:20 +00:00
### --wildcard-access-url
2023-04-07 22:58:21 +00:00
| | |
| ----------- | ----------------------------------------- |
2024-01-17 16:41:42 +00:00
| Type | < code > string< / code > |
2023-04-07 22:58:21 +00:00
| Environment | < code > $CODER_WILDCARD_ACCESS_URL< / code > |
| YAML | < code > networking.wildcardAccessURL< / code > |
Specifies the wildcard hostname to use for workspace applications in the form "\*.example.com".
### --write-config
| | |
| ---- | ----------------- |
| Type | < code > bool< / code > |
< br / > Write out the current server config as YAML to stdout.
### --pprof-address
| | |
| ----------- | ---------------------------------------- |
| 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 > |
The bind address to serve pprof.
### --pprof-enable
2023-03-23 22:42:20 +00:00
| | |
| ----------- | --------------------------------------- |
2023-04-07 22:58:21 +00:00
| Type | < code > bool< / code > |
| Environment | < code > $CODER_PPROF_ENABLE< / code > |
| YAML | < code > introspection.pprof.enable< / code > |
2023-03-23 22:42:20 +00:00
2023-04-07 22:58:21 +00:00
Serve pprof metrics on the address defined by pprof address.
