2026-09-30 12:39:06 -04:00
---
# Code generated by make gen. DO NOT EDIT.
title : "`coder workspace-proxy server`"
2026-10-20 18:51:44 -04:00
description : Start a workspace proxy server.
2026-09-30 12:39:06 -04:00
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Start a workspace proxy server
## Usage
```console
coder workspace-proxy server [flags]
```
## Options
### --access-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-----------------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_ACCESS_URL</code> |
| YAML | <code>networking.accessURL</code> |
The URL that users will use to access the Coder deployment.
### --wildcard-access-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-------------------------------------------|
| Type | <code>string</code> |
| 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".
### --docs-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-------------------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_DOCS_URL</code> |
| YAML | <code>networking.docsURL</code> |
| Default | <code>https://coder.com/docs</code> |
Specifies the custom docs URL.
### --http-address
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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> |
HTTP bind address of the server. Unset to disable the HTTP endpoint.
### --tls-address
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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> |
HTTPS bind address of the server.
### --tls-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_TLS_ENABLE</code> |
| YAML | <code>networking.tls.enable</code> |
Whether TLS will be enabled.
### --tls-cert-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|---------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_TLS_CERT_FILE</code> |
| YAML | <code>networking.tls.certFiles</code> |
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
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_CA_FILE</code> |
| YAML | <code>networking.tls.clientCAFile</code> |
PEM-encoded Certificate Authority file used for checking the authenticity of client.
### --tls-client-auth
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_AUTH</code> |
| YAML | <code>networking.tls.clientAuth</code> |
| Default | <code>none</code> |
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
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|--------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_TLS_KEY_FILE</code> |
| YAML | <code>networking.tls.keyFiles</code> |
Paths to the private keys for each of the certificates. It requires a PEM-encoded file.
### --tls-min-version
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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".
### --tls-client-cert-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_CERT_FILE</code> |
| YAML | <code>networking.tls.clientCertFile</code> |
Path to certificate for client TLS authentication. It requires a PEM-encoded file.
### --tls-client-key-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_KEY_FILE</code> |
| YAML | <code>networking.tls.clientKeyFile</code> |
Path to key for client TLS authentication. It requires a PEM-encoded file.
### --tls-ciphers
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|----------------------------------------|
| 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.
### --tls-allow-insecure-ciphers
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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.
### --derp-server-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|----------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DERP_SERVER_ENABLE</code> |
| YAML | <code>networking.derp.enable</code> |
| Default | <code>true</code> |
Whether to enable or disable the embedded DERP relay server.
### --derp-server-relay-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-------------------------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_DERP_SERVER_RELAY_URL</code> |
| YAML | <code>networking.derp.relayURL</code> |
An HTTP URL that is accessible by other replicas to relay DERP traffic. Required for high availability.
### --block-direct-connections
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|------------------------------------------|
| 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.
### --prometheus-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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 |
2026-09-30 12:39:06 -04: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.
### --pprof-enable
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-----------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PPROF_ENABLE</code> |
| YAML | <code>introspection.pprof.enable</code> |
Serve pprof metrics on the address defined by pprof address.
### --pprof-address
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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> |
The bind address to serve pprof.
### --trace
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_TRACE_ENABLE</code> |
| YAML | <code>introspection.tracing.enable</code> |
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 |
2026-09-30 12:39:06 -04:00
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TRACE_HONEYCOMB_API_KEY</code> |
Enables trace exporting to Honeycomb.io using the provided API Key.
### --trace-logs
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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.
### --log-human
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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 |
2026-09-30 12:39:06 -04: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 |
2026-09-30 12:39:06 -04: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.
### --experiments
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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.
2026-09-30 12:39:06 -04:00
### --proxy-trusted-headers
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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 |
2026-09-30 12:39:06 -04:00
|-------------|---------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROXY_TRUSTED_ORIGINS</code> |
| YAML | <code>networking.proxyTrustedOrigins</code> |
Origin addresses to respect "proxy-trusted-headers" and X-Forwarded-Host for subdomain app routing. e.g. 192.168.1.0/24.
### --secure-auth-cookie
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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.
### --samesite-auth-cookie
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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.
### --host-prefix-cookie
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_HOST_PREFIX_COOKIE</code> |
| YAML | <code>networking.hostPrefixCookie</code> |
| Default | <code>false</code> |
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.
### --strict-transport-security
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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 |
2026-09-30 12:39:06 -04: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.
### --disable-path-apps
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04: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 |
2026-09-30 12:39:06 -04: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.
### --write-config
2026-10-21 10:58:04 -07:00
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
2026-09-30 12:39:06 -04:00
<br/>Write out the current server config as YAML to stdout.
### --proxy-session-token
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|-------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROXY_SESSION_TOKEN</code> |
| YAML | <code>externalWorkspaceProxy.proxySessionToken</code> |
Authentication token for the workspace proxy to communicate with coderd.
### --primary-access-url
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|------------------------------------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_PRIMARY_ACCESS_URL</code> |
| YAML | <code>externalWorkspaceProxy.primaryAccessURL</code> |
URL to communicate with coderd. This should match the access URL of the Coder deployment.
### --derp-only
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-09-30 12:39:06 -04:00
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROXY_DERP_ONLY</code> |
| YAML | <code>externalWorkspaceProxy.derpOnly</code> |
Run a proxy server that only supports DERP connections and does not proxy workspace app/terminal traffic.