Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit4232a2e

Browse files
authored
feat: add custom docs URL to deployment config (#8590)
1 parent164b816 commit4232a2e

File tree

10 files changed

+77
-0
lines changed

10 files changed

+77
-0
lines changed

‎cli/testdata/coder_server_--help.golden

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ Use a YAML configuration file when your server launch become unwieldy.
128128
--access-url url, $CODER_ACCESS_URL
129129
The URL that users will use to access the Coder deployment.
130130

131+
--docs-url url, $CODER_DOCS_URL
132+
Specifies the custom docs URL.
133+
131134
--proxy-trusted-headers string-array, $CODER_PROXY_TRUSTED_HEADERS
132135
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip,
133136
True-Client-Ip, X-Forwarded-For.

‎cli/testdata/server-config.yaml.golden

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ networking:
66
# "*.example.com".
77
# (default: <unset>, type: url)
88
wildcardAccessURL:
9+
# Specifies the custom docs URL.
10+
# (default: <unset>, type: url)
11+
docsURL:
912
# Specifies whether to redirect requests that do not match the access URL host.
1013
# (default: <unset>, type: bool)
1114
redirectToAccessURL: false

‎coderd/apidoc/docs.go

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎codersdk/deployment.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ type DeploymentValues struct {
120120
Verbose clibase.Bool`json:"verbose,omitempty"`
121121
AccessURL clibase.URL`json:"access_url,omitempty"`
122122
WildcardAccessURL clibase.URL`json:"wildcard_access_url,omitempty"`
123+
DocsURL clibase.URL`json:"docs_url,omitempty"`
123124
RedirectToAccessURL clibase.Bool`json:"redirect_to_access_url,omitempty"`
124125
// HTTPAddress is a string because it may be set to zero to disable.
125126
HTTPAddress clibase.String`json:"http_address,omitempty" typescript:",notnull"`
@@ -534,6 +535,16 @@ when required by your organization's security policy.`,
534535
YAML:"wildcardAccessURL",
535536
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies,"true"),
536537
},
538+
{
539+
Name:"Docs URL",
540+
Description:"Specifies the custom docs URL.",
541+
Value:&c.DocsURL,
542+
Flag:"docs-url",
543+
Env:"CODER_DOCS_URL",
544+
Group:&deploymentGroupNetworking,
545+
YAML:"docsURL",
546+
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies,"true"),
547+
},
537548
redirectToAccessURL,
538549
{
539550
Name:"Autobuild Poll Interval",

‎docs/api/general.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,19 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
196196
"disable_password_auth":true,
197197
"disable_path_apps":true,
198198
"disable_session_expiry_refresh":true,
199+
"docs_url": {
200+
"forceQuery":true,
201+
"fragment":"string",
202+
"host":"string",
203+
"omitHost":true,
204+
"opaque":"string",
205+
"path":"string",
206+
"rawFragment":"string",
207+
"rawPath":"string",
208+
"rawQuery":"string",
209+
"scheme":"string",
210+
"user": {}
211+
},
199212
"enable_terraform_debug_mode":true,
200213
"experiments": ["string"],
201214
"git_auth": {

‎docs/api/schemas.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1902,6 +1902,19 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
19021902
"disable_password_auth":true,
19031903
"disable_path_apps":true,
19041904
"disable_session_expiry_refresh":true,
1905+
"docs_url": {
1906+
"forceQuery":true,
1907+
"fragment":"string",
1908+
"host":"string",
1909+
"omitHost":true,
1910+
"opaque":"string",
1911+
"path":"string",
1912+
"rawFragment":"string",
1913+
"rawPath":"string",
1914+
"rawQuery":"string",
1915+
"scheme":"string",
1916+
"user": {}
1917+
},
19051918
"enable_terraform_debug_mode":true,
19061919
"experiments": ["string"],
19071920
"git_auth": {
@@ -2239,6 +2252,19 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
22392252
"disable_password_auth":true,
22402253
"disable_path_apps":true,
22412254
"disable_session_expiry_refresh":true,
2255+
"docs_url": {
2256+
"forceQuery":true,
2257+
"fragment":"string",
2258+
"host":"string",
2259+
"omitHost":true,
2260+
"opaque":"string",
2261+
"path":"string",
2262+
"rawFragment":"string",
2263+
"rawPath":"string",
2264+
"rawQuery":"string",
2265+
"scheme":"string",
2266+
"user": {}
2267+
},
22422268
"enable_terraform_debug_mode":true,
22432269
"experiments": ["string"],
22442270
"git_auth": {
@@ -2438,6 +2464,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
24382464
|`disable_password_auth`| boolean| false|||
24392465
|`disable_path_apps`| boolean| false|||
24402466
|`disable_session_expiry_refresh`| boolean| false|||
2467+
|`docs_url`|[clibase.URL](#clibaseurl)| false|||
24412468
|`enable_terraform_debug_mode`| boolean| false|||
24422469
|`experiments`| array of string| false|||
24432470
|`git_auth`|[clibase.Struct-array_codersdk_GitAuthConfig](#clibasestruct-array_codersdk_gitauthconfig)| false|||

‎docs/cli/server.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,16 @@ Disable workspace apps that are not served from subdomains. Path-based apps can
223223

224224
Disable automatic session expiry bumping due to activity. This forces all sessions to become invalid after the session expiry duration has been reached.
225225

226+
###--docs-url
227+
228+
|||
229+
| -----------| -------------------------------|
230+
| Type| <code>url</code>|
231+
| Environment| <code>$CODER_DOCS_URL</code>|
232+
| YAML| <code>networking.docsURL</code>|
233+
234+
Specifies the custom docs URL.
235+
226236
###--enable-terraform-debug-mode
227237

228238
|||

‎enterprise/cli/testdata/coder_server_--help.golden

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ Use a YAML configuration file when your server launch become unwieldy.
128128
--access-url url, $CODER_ACCESS_URL
129129
The URL that users will use to access the Coder deployment.
130130

131+
--docs-url url, $CODER_DOCS_URL
132+
Specifies the custom docs URL.
133+
131134
--proxy-trusted-headers string-array, $CODER_PROXY_TRUSTED_HEADERS
132135
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip,
133136
True-Client-Ip, X-Forwarded-For.

‎site/src/api/typesGenerated.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,7 @@ export interface DeploymentValues {
332332
readonlyverbose?:boolean
333333
readonlyaccess_url?:string
334334
readonlywildcard_access_url?:string
335+
readonlydocs_url?:string
335336
readonlyredirect_to_access_url?:boolean
336337
readonlyhttp_address?:string
337338
readonlyautobuild_poll_interval?:number

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp