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