@@ -61,7 +61,7 @@ OPTIONS:
61
61
Periodically check for new releases of Coder and inform the owner. The
62
62
check is performed once per day.
63
63
64
- CLIENT OPTIONS:
64
+ CLIENT OPTIONS:
65
65
These options change the behavior of how clients interact with the Coder.
66
66
Clients include the coder cli, vs code extension, and the web UI.
67
67
@@ -83,17 +83,17 @@ Clients include the coder cli, vs code extension, and the web UI.
83
83
The renderer to use when opening a web terminal. Valid values are
84
84
'canvas', 'webgl', or 'dom'.
85
85
86
- CONFIG OPTIONS:
86
+ CONFIG OPTIONS:
87
87
Use a YAML configuration file when your server launch become unwieldy.
88
88
89
89
-c, --config yaml-config-path, $CODER_CONFIG_PATH
90
90
Specify a YAML file to load configuration from.
91
91
92
92
--write-config bool
93
-
93
+
94
94
Write out the current server config as YAML to stdout.
95
95
96
- INTROSPECTION / HEALTH CHECK OPTIONS:
96
+ INTROSPECTION / HEALTH CHECK OPTIONS:
97
97
--health-check-refresh duration, $CODER_HEALTH_CHECK_REFRESH (default: 10m0s)
98
98
Refresh interval for healthchecks.
99
99
@@ -102,7 +102,7 @@ INTROSPECTION / HEALTH CHECK OPTIONS:
102
102
the database exceeds this threshold over 5 attempts, the database is
103
103
considered unhealthy. The default value is 15ms.
104
104
105
- INTROSPECTION / LOGGING OPTIONS:
105
+ INTROSPECTION / LOGGING OPTIONS:
106
106
--enable-terraform-debug-mode bool, $CODER_ENABLE_TERRAFORM_DEBUG_MODE (default: false)
107
107
Allow administrators to enable Terraform debug output.
108
108
@@ -119,7 +119,7 @@ INTROSPECTION / LOGGING OPTIONS:
119
119
--log-stackdriver string, $CODER_LOGGING_STACKDRIVER
120
120
Output Stackdriver compatible logs to a given file.
121
121
122
- INTROSPECTION / PROMETHEUS OPTIONS:
122
+ INTROSPECTION / PROMETHEUS OPTIONS:
123
123
--prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
124
124
The bind address to serve prometheus metrics.
125
125
@@ -132,7 +132,7 @@ INTROSPECTION / PROMETHEUS OPTIONS:
132
132
--prometheus-enable bool, $CODER_PROMETHEUS_ENABLE
133
133
Serve prometheus metrics on the address defined by prometheus address.
134
134
135
- INTROSPECTION / TRACING OPTIONS:
135
+ INTROSPECTION / TRACING OPTIONS:
136
136
--trace-logs bool, $CODER_TRACE_LOGS
137
137
Enables capturing of logs as events in traces. This is useful for
138
138
debugging, but may result in a very large amount of events being sent
@@ -146,14 +146,14 @@ INTROSPECTION / TRACING OPTIONS:
146
146
--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY
147
147
Enables trace exporting to Honeycomb.io using the provided API Key.
148
148
149
- INTROSPECTION / PPROF OPTIONS:
149
+ INTROSPECTION / PPROF OPTIONS:
150
150
--pprof-address host:port, $CODER_PPROF_ADDRESS (default: 127.0.0.1:6060)
151
151
The bind address to serve pprof.
152
152
153
153
--pprof-enable bool, $CODER_PPROF_ENABLE
154
154
Serve pprof metrics on the address defined by pprof address.
155
155
156
- NETWORKING OPTIONS:
156
+ NETWORKING OPTIONS:
157
157
--access-url url, $CODER_ACCESS_URL
158
158
The URL that users will use to access the Coder deployment.
159
159
@@ -179,7 +179,7 @@ NETWORKING OPTIONS:
179
179
Specifies the wildcard hostname to use for workspace applications in
180
180
the form "*.example.com".
181
181
182
- NETWORKING / DERP OPTIONS:
182
+ NETWORKING / DERP OPTIONS:
183
183
Most Coder deployments never have to think about DERP because all connections
184
184
between workspaces and users are peer-to-peer. However, when Coder cannot
185
185
establish a peer to peer connection, Coder uses a distributed relay network
@@ -221,7 +221,7 @@ backed by Tailscale and WireGuard.
221
221
own DERP region, with region IDs starting at `--derp-server-region-id
222
222
+ 1`. Use special value 'disable' to turn off STUN completely.
223
223
224
- NETWORKING / HTTP OPTIONS:
224
+ NETWORKING / HTTP OPTIONS:
225
225
--disable-password-auth bool, $CODER_DISABLE_PASSWORD_AUTH
226
226
Disable password authentication. This is recommended for security
227
227
purposes in production deployments that rely on an identity provider.
@@ -252,7 +252,7 @@ NETWORKING / HTTP OPTIONS:
252
252
longer if they are actively making requests, but this functionality
253
253
can be disabled via --disable-session-expiry-refresh.
254
254
255
- NETWORKING / TLS OPTIONS:
255
+ NETWORKING / TLS OPTIONS:
256
256
Configure TLS / HTTPS for your Coder deployment. If you're running Coder behind
257
257
a TLS-terminating reverse proxy or are accessing Coder over a secure link, you
258
258
can safely ignore these settings.
@@ -314,7 +314,7 @@ can safely ignore these settings.
314
314
Minimum supported version of TLS. Accepted values are "tls10",
315
315
"tls11", "tls12" or "tls13".
316
316
317
- OAUTH2 / GITHUB OPTIONS:
317
+ OAUTH2 / GITHUB OPTIONS:
318
318
--oauth2-github-allow-everyone bool, $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE
319
319
Allow all logins, setting this option means allowed orgs and teams
320
320
must be empty.
@@ -339,7 +339,7 @@ OAUTH2 / GITHUB OPTIONS:
339
339
Base URL of a GitHub Enterprise deployment to use for Login with
340
340
GitHub.
341
341
342
- OIDC OPTIONS:
342
+ OIDC OPTIONS:
343
343
--oidc-group-auto-create bool, $CODER_OIDC_GROUP_AUTO_CREATE (default: false)
344
344
Automatically creates missing groups from a user's groups claim.
345
345
@@ -430,7 +430,7 @@ OIDC OPTIONS:
430
430
The custom text to show on the error page informing about disabled
431
431
OIDC signups.
432
432
433
- PROVISIONING OPTIONS:
433
+ PROVISIONING OPTIONS:
434
434
Tune the behavior of the provisioner, which is responsible for creating,
435
435
updating, and deleting workspace resources.
436
436
@@ -451,7 +451,7 @@ updating, and deleting workspace resources.
451
451
Number of provisioner daemons to create on start. If builds are stuck
452
452
in queued state for a long time, consider increasing this.
453
453
454
- TELEMETRY OPTIONS:
454
+ TELEMETRY OPTIONS:
455
455
Telemetry is critical to our ability to improve Coder. We strip all
456
456
personalinformation before sending data to our servers. Please only disable
457
457
telemetrywhen required by your organization's security policy.
@@ -460,7 +460,7 @@ telemetrywhen required by your organization's security policy.
460
460
Whether telemetry is enabled or not. Coder collects anonymized usage
461
461
data to help improve our product.
462
462
463
- USER QUIET HOURS SCHEDULE OPTIONS:
463
+ USER QUIET HOURS SCHEDULE OPTIONS:
464
464
Allow users to set quiet hours schedules each day for workspaces to avoid
465
465
workspaces stopping during the day due to template max TTL.
466
466
@@ -480,7 +480,7 @@ workspaces stopping during the day due to template max TTL.
480
480
must be *. Only one hour and minute can be specified (ranges or comma
481
481
separated values are not supported).
482
482
483
- ⚠️ DANGEROUS OPTIONS:
483
+ ⚠️ DANGEROUS OPTIONS:
484
484
--dangerous-allow-path-app-sharing bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SHARING
485
485
Allow workspace apps that are not served from subdomains to be shared.
486
486
Path-based app sharing is DISABLED by default for security purposes.
@@ -497,7 +497,7 @@ workspaces stopping during the day due to template max TTL.
497
497
can be disabled entirely with --disable-path-apps for further
498
498
security.
499
499
500
- ENTERPRISE OPTIONS:
500
+ ENTERPRISE OPTIONS:
501
501
These options are only available in the Enterprise Edition.
502
502
503
503
--browser-only bool, $CODER_BROWSER_ONLY
0 commit comments