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

Commitcc226a8

Browse files
committed
more fixing
1 parent0e07655 commitcc226a8

File tree

8 files changed

+22
-20
lines changed

8 files changed

+22
-20
lines changed

‎docs/admin/audit-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ audit trails.
7070

7171
Audit logs can be accessed through our REST API. You can find detailed
7272
information about this in our
73-
[endpoint documentation](../api/audit.md#get-audit-logs).
73+
[endpoint documentation](../reference/api/audit.md#get-audit-logs).
7474

7575
##Service Logs
7676

‎docs/admin/automation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
3232

3333
##Documentation
3434

35-
We publish an[API reference](../api/index.md) in our documentation. You can
35+
We publish an[API reference](../reference/api/README.md) in our documentation. You can
3636
also enable a[Swagger endpoint](../reference/cli/server.md#--swagger-enable) on
3737
your Coder deployment.
3838

@@ -52,7 +52,7 @@ payloads, we recommend checking the CLI and API documentation.
5252
Workspace agents have a special token that can send logs, metrics, and workspace
5353
activity.
5454

55-
-[Custom workspace logs](../api/agents.md#patch-workspace-agent-logs): Expose
55+
-[Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs): Expose
5656
messages prior to the Coder init script running (e.g. pulling image, VM
5757
starting, restoring snapshot).
5858
[coder-logstream-kube](https://github.com/coder/coder-logstream-kube) uses
@@ -73,7 +73,7 @@ activity.
7373
}"
7474
```
7575

76-
-[Manually send workspace activity](../api/agents.md#submit-workspace-agent-stats):
76+
-[Manually send workspace activity](../reference/api/agents.md#submit-workspace-agent-stats):
7777
Keep a workspace "active," even if there is not an open connection (e.g. for a
7878
long-running machine learning job).
7979

‎docs/admin/configure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Coder server's primary configuration is done via environment variables. For a
22
full list of the options, run`coder server --help` or see our
3-
[CLI documentation](../cli/server.md).
3+
[CLI documentation](../reference/cli/server.md).
44

55
##Access URL
66

‎docs/admin/encryption.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Additional database fields may be encrypted in the future.
4747
4848
- Ensure you have a valid backup of your database.**Do not skip this step.** If
4949
you are using the built-in PostgreSQL database, you can run
50-
[`coder server postgres-builtin-url`](../cli/server_postgres-builtin-url.md)
50+
[`coder server postgres-builtin-url`](../reference/cli/server_postgres-builtin-url.md)
5151
to get the connection URL.
5252

5353
- Generate a 32-byte random key and base64-encode it. For example:
@@ -110,13 +110,13 @@ data:
110110
encrypted with the old key(s).
111111
112112
- To re-encrypt all encrypted database fields with the new key, run
113-
[`coder server dbcrypt rotate`](../cli/server_dbcrypt_rotate.md). This command
114-
will re-encrypt all tokens with the specified new encryption key. We recommend
115-
performing this action during a maintenance window.
113+
[`coder server dbcrypt rotate`](../reference/cli/server_dbcrypt_rotate.md).
114+
This commandwill re-encrypt all tokens with the specified new encryption key.
115+
We recommendperforming this action during a maintenance window.
116116

117117
> Note: this command requires direct access to the database. If you are using
118118
> the built-in PostgreSQL database, you can run
119-
> [`coder server postgres-builtin-url`](../cli/server_postgres-builtin-url.md)
119+
> [`coder server postgres-builtin-url`](../reference/cli/server_postgres-builtin-url.md)
120120
> to get the connection URL.
121121

122122
-Once the above command completes successfully, remove the old encryption key
@@ -132,8 +132,9 @@ To disable encryption, perform the following actions:
132132
-Stop all active coderd instances. This will prevent new encrypted data from
133133
being written, which may cause the next step to fail.
134134

135-
-Run [`coder server dbcrypt decrypt`](../cli/server_dbcrypt_decrypt.md). This
136-
command will decrypt all encrypted user tokens and revoke all active
135+
-Run
136+
[`coder server dbcrypt decrypt`](../reference/cli/server_dbcrypt_decrypt.md).
137+
This command will decrypt all encrypted user tokens and revoke all active
137138
encryption keys.
138139

139140
> Note: for `decrypt` command, the equivalent environment variable for
@@ -159,9 +160,10 @@ To delete all encrypted data from your database, perform the following actions:
159160
-Stop all active coderd instances. This will prevent new encrypted data from
160161
being written.
161162

162-
-Run [`coder server dbcrypt delete`](../cli/server_dbcrypt_delete.md). This
163-
command will delete all encrypted user tokens and revoke all active encryption
164-
keys.
163+
-Run
164+
[`coder server dbcrypt delete`](../reference/cli/server_dbcrypt_delete.md).
165+
This command will delete all encrypted user tokens and revoke all active
166+
encryption keys.
165167

166168
-Remove all
167169
[external token encryption keys](../reference/cli/server.md#--external-token-encryption-keys)

‎docs/admin/healthcheck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Coder includes an operator-friendly deployment health page that provides a
44
number of details about the health of your Coder deployment.
55

66
You can view it at`https://${CODER_URL}/health`, or you can alternatively view
7-
the[JSON response directly](../api/debug.md#debug-info-deployment-health).
7+
the[JSON response directly](../reference/api/debug.md#debug-info-deployment-health).
88

99
The deployment health page is broken up into the following sections:
1010

‎docs/admin/provisioners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For example, running 30 provisioner containers will allow 30 users to start
2626
workspaces at the same time.
2727

2828
Provisioners are started with the
29-
[coder provisionerd start](../cli/provisionerd_start.md) command.
29+
[coder provisionerd start](../reference/cli/provisionerd_start.md) command.
3030

3131
##Authentication
3232

‎docs/architecture/validated-arch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ could affect workspace users experience once the platform is live.
324324
identify the required values for deployment.
325325
1. Create a`values.yaml` and add it to your version control system.
326326
1. Determine the necessary environment variables. Here is the
327-
[full list of supported server environment variables](../cli/server.md).
327+
[full list of supported server environment variables](../reference/cli/server.md).
328328
1. Follow our documented
329329
[steps for installing Coder via Helm](../install/kubernetes.md).
330330

‎docs/networking/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ In order for clients to be able to establish direct connections:
3333
`coder port-forward`). Note that the
3434
[VSCode extension](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote)
3535
and[JetBrains Plugin](https://plugins.jetbrains.com/plugin/19620-coder/), and
36-
[`ssh coder.<workspace>`](../cli/config-ssh.md) all utilize the CLI to
37-
establish a workspace connection.
36+
[`ssh coder.<workspace>`](../reference/cli/config-ssh.md) all utilize the CLI
37+
toestablish a workspace connection.
3838
- Either the client or workspace agent are able to discover a reachable
3939
`ip:port` of their counterpart. If the agent and client are able to
4040
communicate with each other using their locally assigned IP addresses, then a

0 commit comments

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