create-admin-user Create a new admin user with the given username,

email and password and adds it to every

organization.

postgres-builtin-serve Run the built-in PostgreSQL deployment.

postgres-builtin-url Output the connection URL for the built-in

PostgreSQL deployment.

Periodically check for new releases of Coder and inform the owner. The

check is performed once per day.

These options change the behavior of how clients interact with the Coder.

Clients include the coder cli, vs code extension, and the web UI.

The renderer to use when opening a web terminal. Valid values are

'canvas', 'webgl', or 'dom'.

Use a YAML configuration file when your server launch become unwieldy.

-c, --config yaml-config-path, $CODER_CONFIG_PATH

Specify a YAML file to load configuration from.

--write-config bool

Write out the current server config as YAML to stdout.

--health-check-refresh duration, $CODER_HEALTH_CHECK_REFRESH (default: 10m0s)

Refresh interval for healthchecks.

the database exceeds this threshold over 5 attempts, the database is

considered unhealthy. The default value is 15ms.

--enable-terraform-debug-mode bool, $CODER_ENABLE_TERRAFORM_DEBUG_MODE (default: false)

Allow administrators to enable Terraform debug output.

--log-stackdriver string, $CODER_LOGGING_STACKDRIVER

Output Stackdriver compatible logs to a given file.

--prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)

The bind address to serve prometheus metrics.

--prometheus-enable bool, $CODER_PROMETHEUS_ENABLE

Serve prometheus metrics on the address defined by prometheus address.

--trace-logs bool, $CODER_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

--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY

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

--pprof-address host:port, $CODER_PPROF_ADDRESS (default: 127.0.0.1:6060)

The bind address to serve pprof.

--pprof-enable bool, $CODER_PPROF_ENABLE

Serve pprof metrics on the address defined by pprof address.

--access-url url, $CODER_ACCESS_URL

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

Specifies the wildcard hostname to use for workspace applications in

the form "*.example.com".

Most Coder deployments never have to think about DERP because all connections

between workspaces and users are peer-to-peer. However, when Coder cannot

establish a peer to peer connection, Coder uses a distributed relay network

own DERP region, with region IDs starting at `--derp-server-region-id

+ 1`. Use special value 'disable' to turn off STUN completely.

--disable-password-auth bool, $CODER_DISABLE_PASSWORD_AUTH

Disable password authentication. This is recommended for security

purposes in production deployments that rely on an identity provider.

longer if they are actively making requests, but this functionality

can be disabled via --disable-session-expiry-refresh.

Configure TLS / HTTPS for your Coder deployment. If you're running Coder behind

a TLS-terminating reverse proxy or are accessing Coder over a secure link, you

can safely ignore these settings.

Minimum supported version of TLS. Accepted values are "tls10",

"tls11", "tls12" or "tls13".

--oauth2-github-allow-everyone bool, $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE

Allow all logins, setting this option means allowed orgs and teams

must be empty.

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

GitHub.

--oidc-group-auto-create bool, $CODER_OIDC_GROUP_AUTO_CREATE (default: false)

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

The custom text to show on the error page informing about disabled

OIDC signups.

Tune the behavior of the provisioner, which is responsible for creating,

updating, and deleting workspace resources.

Number of provisioner daemons to create on start. If builds are stuck

in queued state for a long time, consider increasing this.

Telemetry is critical to our ability to improve Coder. We strip all

personalinformation before sending data to our servers. Please only disable

telemetrywhen required by your organization's security policy.

Whether telemetry is enabled or not. Coder collects anonymized usage

data to help improve our product.

Allow users to set quiet hours schedules each day for workspaces to avoid

workspaces stopping during the day due to template max TTL.

must be *. Only one hour and minute can be specified (ranges or comma

separated values are not supported).

--dangerous-allow-path-app-sharing bool, $CODER_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.

can be disabled entirely with --disable-path-apps for further

security.

These options are only available in the Enterprise Edition.

--browser-only bool, $CODER_BROWSER_ONLY