server

Start a Coder server

Usage

coder server [flags]

Subcommands

Options

--access-url

The URL that users will use to access the Coder deployment.

--wildcard-access-url

Specifies the wildcard hostname to use for workspace applications in the form "*.example.com".

--docs-url

Specifies the custom docs URL.

--redirect-to-access-url

Specifies whether to redirect requests that do not match the access URL host.

--http-address

HTTP bind address of the server. Unset to disable the HTTP endpoint.

--tls-address

HTTPS bind address of the server.

--tls-enable

Whether TLS will be enabled.

--tls-cert-file

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.

--tls-client-ca-file

PEM-encoded Certificate Authority file used for checking the authenticity of client.

--tls-client-auth

Policy the server will follow for TLS Client Authentication. Accepted values are "none", "request", "require-any", "verify-if-given", or "require-and-verify".

--tls-key-file

Paths to the private keys for each of the certificates. It requires a PEM-encoded file.

--tls-min-version

Minimum supported version of TLS. Accepted values are "tls10", "tls11", "tls12" or "tls13".

--tls-client-cert-file

Path to certificate for client TLS authentication. It requires a PEM-encoded file.

--tls-client-key-file

Path to key for client TLS authentication. It requires a PEM-encoded file.

--tls-ciphers

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

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.

--derp-server-enable

Whether to enable or disable the embedded DERP relay server.

--derp-server-region-name

Region name that for the embedded DERP server.

--derp-server-stun-addresses

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.

--derp-server-relay-url

An HTTP URL that is accessible by other replicas to relay DERP traffic. Required for high availability.

--block-direct-connections

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.

--derp-force-websockets

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.

--derp-config-url

URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/.

--derp-config-path

Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/.

--prometheus-enable

Serve prometheus metrics on the address defined by prometheus address.

--prometheus-address

The bind address to serve prometheus metrics.

--prometheus-collect-agent-stats

Collect agent stats (may increase charges for metrics storage).

--prometheus-aggregate-agent-stats-by

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

Collect database query metrics (may increase charges for metrics storage). If set to false, a reduced set of database metrics are still collected.

--pprof-enable

Serve pprof metrics on the address defined by pprof address.

--pprof-address

The bind address to serve pprof.

--oauth2-github-client-id

Client ID for Login with GitHub.

--oauth2-github-client-secret

Client secret for Login with GitHub.

--oauth2-github-allowed-orgs

Organizations the user must be a member of to Login with GitHub.

--oauth2-github-allowed-teams

Teams inside organizations the user must be a member of to Login with GitHub. Structured as: /.

--oauth2-github-allow-signups

Whether new users can sign up with GitHub.

--oauth2-github-allow-everyone

Allow all logins, setting this option means allowed orgs and teams must be empty.

--oauth2-github-enterprise-base-url

Base URL of a GitHub Enterprise deployment to use for Login with GitHub.

--oidc-allow-signups

Whether new users can sign up with OIDC.

--oidc-client-id

Client ID to use for Login with OIDC.

--oidc-client-secret

Client secret to use for Login with OIDC.

--oidc-client-key-file

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

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

Email domains that clients logging in with OIDC must match.

--oidc-issuer-url

Issuer URL to use for Login with OIDC.

--oidc-scopes

Scopes to grant when authenticating with OIDC.

--oidc-ignore-email-verified

Ignore the email_verified claim from the upstream provider.

--oidc-username-field

OIDC claim field to use as the username.

--oidc-name-field

OIDC claim field to use as the name.

--oidc-email-field

OIDC claim field to use as the email.

--oidc-auth-url-params

OIDC auth URL parameters to pass to the upstream provider.

--oidc-ignore-userinfo

Ignore the userinfo endpoint and only use the ID token for user information.

--oidc-group-field

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.

--oidc-group-mapping

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-group-auto-create

Automatically creates missing groups from a user's groups claim.

--oidc-group-regex-filter

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.

--oidc-allowed-groups

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.

--oidc-user-role-field

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

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.

--oidc-user-role-default

If user role sync is enabled, these roles are always included for all authenticated users. The 'member' role is always assigned.

--oidc-sign-in-text

The text to show on the OpenID Connect sign in button.

--oidc-icon-url

URL pointing to the icon to use on the OpenID Connect login button.

--oidc-signups-disabled-text

The custom text to show on the error page informing about disabled OIDC signups. Markdown format is supported.

--dangerous-oidc-skip-issuer-checks

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.

--telemetry

Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.

--trace

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

Enables trace exporting to Honeycomb.io using the provided API Key.

--trace-logs

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

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

Deprecated and ignored.

--provisioner-daemon-poll-jitter

Deprecated and ignored.

--provisioner-force-cancel-interval

Time to force cancel provisioning tasks that are stuck.

--provisioner-daemon-psk

Pre-shared key to authenticate external provisioner daemons to Coder server.

-l, --log-filter

Filter debug logs by matching against a given regex. Use .* to match all debug logs.

--log-human

Output human-readable logs to a given file.

--log-json

Output JSON logs to a given file.

--log-stackdriver

Output Stackdriver compatible logs to a given file.

--enable-terraform-debug-mode

Allow administrators to enable Terraform debug output.

--additional-csp-policy

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".

--dangerous-allow-path-app-sharing

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

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

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.

--update-check

Periodically check for new releases of Coder and inform the owner. The check is performed once per day.

--max-token-lifetime

The maximum lifetime duration users can specify when creating an API token.

--default-token-lifetime

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.

--swagger-enable

Expose the swagger endpoint via /swagger.

--proxy-trusted-headers

Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, True-Client-Ip, X-Forwarded-For.

--proxy-trusted-origins

Origin addresses to respect "proxy-trusted-headers". e.g. 192.168.1.0/24.

--cache-dir

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.

--postgres-url

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".

--postgres-auth

Type of auth to use when connecting to postgres.

--secure-auth-cookie

Controls if the 'Secure' property is set on browser session cookies.

--terms-of-service-url

A URL to an external Terms of Service that must be accepted by users when logging in.

--strict-transport-security

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

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

The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".

--browser-only

Whether Coder only allows connections to workspaces via the browser.

--scim-auth-header

Enables SCIM and sets the authentication header for the built-in SCIM server. New users are automatically created with OIDC authentication.

--external-token-encryption-keys

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

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

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.

--session-duration

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

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

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.

-c, --config

Specify a YAML file to load configuration from.

--ssh-hostname-prefix

The SSH deployment prefix is used in the Host of the ssh config.

--ssh-config-options

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.

--cli-upgrade-message

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'.

--write-config

Write out the current server config as YAML to stdout.

--support-links

Support links to display in the top right drop down menu.

--proxy-health-interval

The interval in which coderd should be checking the status of workspace proxies.

--default-quiet-hours-schedule

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).

--allow-custom-quiet-hours

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.

--web-terminal-renderer

The renderer to use when opening a web terminal. Valid values are 'canvas', 'webgl', or 'dom'.

--allow-workspace-renames

DEPRECATED: Allow users to rename their workspaces. Use only for temporary compatibility reasons, this will be removed in a future release.

--health-check-refresh

Refresh interval for healthchecks.

--health-check-threshold-database

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.

--email-from

The sender's address to use.

--email-smarthost

The intermediary SMTP host through which emails are sent.

--email-hello

The hostname identifying the SMTP server.

--email-force-tls

Force a TLS connection to the configured SMTP smarthost.

--email-auth-identity

Identity to use with PLAIN authentication.

--email-auth-username

Username to use with PLAIN/LOGIN authentication.

--email-auth-password

Password to use with PLAIN/LOGIN authentication.

--email-auth-password-file

File from which to load password for use with PLAIN/LOGIN authentication.

--email-tls-starttls

Enable STARTTLS to upgrade insecure SMTP connections using TLS.

--email-tls-server-name

Server name to verify against the target certificate.

--email-tls-skip-verify

Skip verification of the target server's certificate (insecure).

--email-tls-ca-cert-file

CA certificate file to use.

--email-tls-cert-file

Certificate file to use.

--email-tls-cert-key-file

Certificate key file to use.

--notifications-method

Which delivery method to use (available options: 'smtp', 'webhook').

--notifications-dispatch-timeout

How long to wait while a notification is being sent before giving up.

--notifications-email-from

The sender's address to use.

--notifications-email-smarthost

The intermediary SMTP host through which emails are sent.

--notifications-email-hello

The hostname identifying the SMTP server.

--notifications-email-force-tls

Force a TLS connection to the configured SMTP smarthost.

--notifications-email-auth-identity

Identity to use with PLAIN authentication.

--notifications-email-auth-username

Username to use with PLAIN/LOGIN authentication.

--notifications-email-auth-password

Password to use with PLAIN/LOGIN authentication.

--notifications-email-auth-password-file

File from which to load password for use with PLAIN/LOGIN authentication.

--notifications-email-tls-starttls

Enable STARTTLS to upgrade insecure SMTP connections using TLS.

--notifications-email-tls-server-name

Server name to verify against the target certificate.

--notifications-email-tls-skip-verify

Skip verification of the target server's certificate (insecure).

--notifications-email-tls-ca-cert-file

CA certificate file to use.

--notifications-email-tls-cert-file

Certificate file to use.

--notifications-email-tls-cert-key-file

Certificate key file to use.

--notifications-webhook-endpoint

The endpoint to which to send webhooks.

--notifications-max-send-attempts

The upper limit of attempts to send a notification.