Skip to content

Commit ebd6a59

Browse files
matifalimatifali
committed
fixup Links
1 parent 2cfff89 commit ebd6a59

File tree

11 files changed

+69
-68
lines changed

11 files changed

+69
-68
lines changed

‎docs/admin/audit-logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ information about this in our
7777
Audit trails are also dispatched as service logs and can be captured and
7878
categorized using any log management tool such as [Splunk](https://splunk.com).
7979

80-
Example of a [JSON formatted](../cli/server.md#--log-json) audit log entry:
80+
Example of a [JSON formatted](../reference/cli/server.md#--log-json) audit log entry:
8181

8282
```json
8383
{
@@ -112,7 +112,7 @@ Example of a [JSON formatted](../cli/server.md#--log-json) audit log entry:
112112
}
113113
```
114114

115-
Example of a [human readable](../cli/server.md#--log-human) audit log entry:
115+
Example of a [human readable](../reference/cli/server.md#--log-human) audit log entry:
116116

117117
```console
118118
2023-06-13 03:43:29.233 [info] coderd: audit_log ID=95f7c392-da3e-480c-a579-8909f145fbe2 Time="2023-06-13T03:43:29.230422Z" UserID=6c405053-27e3-484a-9ad7-bcb64e7bfde6 OrganizationID=00000000-0000-0000-0000-000000000000 Ip=<nil> UserAgent=<nil> ResourceType=workspace_build ResourceID=988ae133-5b73-41e3-a55e-e1e9d3ef0b66 ResourceTarget="" Action=start Diff="{}" StatusCode=200 AdditionalFields="{\"workspace_name\":\"linux-container\",\"build_number\":\"7\",\"build_reason\":\"initiator\",\"workspace_owner\":\"\"}" RequestID=9682b1b5-7b9f-4bf2-9a39-9463f8e41cd6 ResourceIcon=""

‎docs/admin/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ First,
1919
GitHub will ask you for the following Coder parameters:
2020

2121
- **Homepage URL**: Set to your Coder deployments
22-
[`CODER_ACCESS_URL`](../cli/server.md#--access-url) (e.g.
22+
[`CODER_ACCESS_URL`](../reference/cli/server.md#--access-url) (e.g.
2323
`https://coder.domain.com`)
2424
- **User Authorization Callback URL**: Set to `https://coder.domain.com`
2525

‎docs/admin/automation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
3333
## Documentation
3434

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

3939
## Use cases

‎docs/admin/configure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ If you are providing TLS certificates directly to the Coder server, either
4848
1. Use a single certificate and key for both the root and wildcard domains.
4949
2. Configure multiple certificates and keys via
5050
[`coder.tls.secretNames`](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
51-
in the Helm Chart, or [`--tls-cert-file`](../cli/server.md#--tls-cert-file)
52-
and [`--tls-key-file`](../cli/server.md#--tls-key-file) command line options
51+
in the Helm Chart, or [`--tls-cert-file`](../reference/cli/server.md#--tls-cert-file)
52+
and [`--tls-key-file`](../reference/cli/server.md#--tls-key-file) command line options
5353
(these both take a comma separated list of files; list certificates and their
5454
respective keys in the same order).
5555

‎docs/admin/encryption.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ preventing attackers with database access from using them to impersonate users.
77
## How it works
88

99
Coder allows administrators to specify
10-
[external token encryption keys](../cli/server.md#external-token-encryption-keys).
10+
[external token encryption keys](../reference/cli/server.md#external-token-encryption-keys).
1111
If configured, Coder will use these keys to encrypt external user tokens before
1212
storing them in the database. The encryption algorithm used is AES-256-GCM with
1313
a 32-byte key length.
@@ -90,7 +90,7 @@ if you need to rotate keys, you can perform the following procedure:
9090
- Generate a new encryption key following the same procedure as above.
9191
9292
- Add the above key to the list of
93-
[external token encryption keys](../cli/server.md#--external-token-encryption-keys).
93+
[external token encryption keys](../reference/cli/server.md#--external-token-encryption-keys).
9494
**The new key must appear first in the list**. For example, in the Kubernetes
9595
secret created above:
9696
@@ -142,7 +142,7 @@ To disable encryption, perform the following actions:
142142
> to help prevent accidentally decrypting data.
143143

144144
- Remove all
145-
[external token encryption keys](../cli/server.md#--external-token-encryption-keys)
145+
[external token encryption keys](../reference/cli/server.md#--external-token-encryption-keys)
146146
from Coder's configuration.
147147

148148
- Start coderd. You can now safely delete the encryption keys from your secret
@@ -164,7 +164,7 @@ To delete all encrypted data from your database, perform the following actions:
164164
keys.
165165

166166
- Remove all
167-
[external token encryption keys](../cli/server.md#--external-token-encryption-keys)
167+
[external token encryption keys](../reference/cli/server.md#--external-token-encryption-keys)
168168
from Coder's configuration.
169169

170170
- Start coderd. You can now safely delete the encryption keys from your secret

‎docs/admin/healthcheck.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ query fails.
106106
_Database Latency High_
107107

108108
**Problem:** This code is returned if the median latency is higher than the
109-
[configured threshold](../cli/server.md#--health-check-threshold-database). This
109+
[configured threshold](../reference/cli/server.md#--health-check-threshold-database). This
110110
may not be an error as such, but is an indication of a potential issue.
111111

112112
**Solution:** Investigate the sizing of the configured database with regard to
@@ -117,17 +117,17 @@ configured threshold to a higher value (this will not address the root cause).
117117
> [!TIP]
118118
>
119119
> - You can enable
120-
> [detailed database metrics](../cli/server.md#--prometheus-collect-db-metrics)
120+
> [detailed database metrics](../reference/cli/server.md#--prometheus-collect-db-metrics)
121121
> in Coder's Prometheus endpoint.
122-
> - If you have [tracing enabled](../cli/server.md#--trace), these traces may
122+
> - If you have [tracing enabled](../reference/cli/server.md#--trace), these traces may
123123
> also contain useful information regarding Coder's database activity.
124124
125125
## DERP
126126

127127
Coder workspace agents may use
128128
[DERP (Designated Encrypted Relay for Packets)](https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp)
129129
to communicate with Coder. This requires connectivity to a number of configured
130-
[DERP servers](../cli/server.md#--derp-config-path) which are used to relay
130+
[DERP servers](../reference/cli/server.md#--derp-config-path) which are used to relay
131131
traffic between Coder and workspace agents. Coder periodically queries the
132132
health of its configured DERP servers and may return one or more of the
133133
following:
@@ -146,7 +146,7 @@ misconfigured reverse HTTP proxy. Additionally, while workspace users should
146146
still be able to reach their workspaces, connection performance may be degraded.
147147

148148
> **Note:** This may also be shown if you have
149-
> [forced websocket connections for DERP](../cli/server.md#--derp-force-websockets).
149+
> [forced websocket connections for DERP](../reference/cli/server.md#--derp-force-websockets).
150150
151151
**Solution:** ensure that any proxies you use allow connection upgrade with the
152152
`Upgrade: derp` header.
@@ -179,7 +179,7 @@ to establish [direct connections](../networking/stun.md). Without at least one
179179
working STUN server, direct connections may not be possible.
180180

181181
**Solution:** Ensure that the
182-
[configured STUN severs](../cli/server.md#derp-server-stun-addresses) are
182+
[configured STUN severs](../reference/cli/server.md#derp-server-stun-addresses) are
183183
reachable from Coder and that UDP traffic can be sent/received on the configured
184184
port.
185185

@@ -292,7 +292,7 @@ be built until there is at least one provisioner daemon running.
292292
If you are using
293293
[External Provisioner Daemons](./provisioners.md#external-provisioners), ensure
294294
that they are able to successfully connect to Coder. Otherwise, ensure
295-
[`--provisioner-daemons`](../cli/server.md#provisioner-daemons) is set to a
295+
[`--provisioner-daemons`](../reference/cli/server.md#provisioner-daemons) is set to a
296296
value greater than 0.
297297

298298
> Note: This may be a transient issue if you are currently in the process of

‎docs/admin/provisioners.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# External provisioners
22

33
By default, the Coder server runs
4-
[built-in provisioner daemons](../cli/server.md#provisioner-daemons), which
5-
execute `terraform` during workspace and template builds. However, there are
6-
sometimes benefits to running external provisioner daemons:
4+
[built-in provisioner daemons](../reference/cli/server.md#provisioner-daemons),
5+
which execute `terraform` during workspace and template builds. However, there
6+
are sometimes benefits to running external provisioner daemons:
77

88
- **Secure build environments:** Run build jobs in isolated containers,
99
preventing malicious templates from gaining shell access to the Coder host.
@@ -33,7 +33,7 @@ Provisioners are started with the
3333
The provisioner daemon must authenticate with your Coder deployment.
3434

3535
Set a
36-
[provisioner daemon pre-shared key (PSK)](../cli/server.md#--provisioner-daemon-psk)
36+
[provisioner daemon pre-shared key (PSK)](../reference/cli/server.md#--provisioner-daemon-psk)
3737
on the Coder server and start the provisioner with
3838
`coder provisionerd start --psk <your-psk>`. If you are
3939
[installing with Helm](../install/kubernetes.md#install-coder-with-helm), see
@@ -49,17 +49,17 @@ the [Helm example](#example-running-an-external-provisioner-with-helm) below.
4949

5050
Provisioners can broadly be categorized by scope: `organization` or `user`. The
5151
scope of a provisioner can be specified with
52-
[`-tag=scope=<scope>`](../cli/provisionerd_start.md#t---tag) when starting the
53-
provisioner daemon. Only users with at least the
52+
[`-tag=scope=<scope>`](../reference/cli/provisionerd_start.md#t---tag) when
53+
starting the provisioner daemon. Only users with at least the
5454
[Template Admin](../admin/users.md#roles) role or higher may create
5555
organization-scoped provisioner daemons.
5656

5757
There are two exceptions:
5858

59-
- [Built-in provisioners](../cli/server.md#provisioner-daemons) are always
60-
organization-scoped.
59+
- [Built-in provisioners](../reference/cli/server.md#provisioner-daemons) are
60+
always organization-scoped.
6161
- External provisioners started using a
62-
[pre-shared key (PSK)](../cli/provisionerd_start.md#psk) are always
62+
[pre-shared key (PSK)](../reference/cli/provisionerd_start.md#psk) are always
6363
organization-scoped.
6464

6565
### Organization-Scoped Provisioners
@@ -270,7 +270,7 @@ docker run --rm -it \
270270

271271
As mentioned above, the Coder server will run built-in provisioners by default.
272272
This can be disabled with a server-wide
273-
[flag or environment variable](../cli/server.md#provisioner-daemons).
273+
[flag or environment variable](../reference/cli/server.md#provisioner-daemons).
274274

275275
```shell
276276
coder server --provisioner-daemons=0

‎docs/guides/support-bundle.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -34,32 +34,32 @@ A brief overview of all files contained in the bundle is provided below:
3434
> Note: detailed descriptions of all the information available in the bundle is
3535
> out of scope, as support bundles are primarily intended for internal use.
3636
37-
| Filename | Description |
38-
| --------------------------------- | ------------------------------------------------------------------------------------------------ |
39-
| `agent/agent.json` | The agent used to connect to the workspace with environment variables stripped. |
40-
| `agent/agent_magicsock.html` | The contents of the HTTP debug endpoint of the agent's Tailscale connection. |
41-
| `agent/client_magicsock.html` | The contents of the HTTP debug endpoint of the client's Tailscale connection. |
42-
| `agent/listening_ports.json` | The listening ports detected by the selected agent running in the workspace. |
43-
| `agent/logs.txt` | The logs of the selected agent running in the workspace. |
44-
| `agent/manifest.json` | The manifest of the selected agent with environment variables stripped. |
45-
| `agent/startup_logs.txt` | Startup logs of the workspace agent. |
46-
| `agent/prometheus.txt` | The contents of the agent's Prometheus endpoint. |
47-
| `cli_logs.txt` | Logs from running the `coder support bundle` command. |
48-
| `deployment/buildinfo.json` | Coder version and build information. |
49-
| `deployment/config.json` | Deployment [configuration](../api/general.md#get-deployment-config), with secret values removed. |
50-
| `deployment/experiments.json` | Any [experiments](../cli/server.md#experiments) currently enabled for the deployment. |
51-
| `deployment/health.json` | A snapshot of the [health status](../admin/healthcheck.md) of the deployment. |
52-
| `logs.txt` | Logs from the `codersdk.Client` used to generate the bundle. |
53-
| `network/connection_info.json` | Information used by workspace agents used to connect to Coder (DERP map etc.) |
54-
| `network/coordinator_debug.html` | Peers currently connected to each Coder instance and the tunnels established between peers. |
55-
| `network/netcheck.json` | Results of running `coder netcheck` locally. |
56-
| `network/tailnet_debug.html` | Tailnet coordinators, their heartbeat ages, connected peers, and tunnels. |
57-
| `workspace/build_logs.txt` | Build logs of the selected workspace. |
58-
| `workspace/workspace.json` | Details of the selected workspace. |
59-
| `workspace/parameters.json` | Build parameters of the selected workspace. |
60-
| `workspace/template.json` | The template currently in use by the selected workspace. |
61-
| `workspace/template_file.zip` | The source code of the template currently in use by the selected workspace. |
62-
| `workspace/template_version.json` | The template version currently in use by the selected workspace. |
37+
| Filename | Description |
38+
| --------------------------------- | ---------------------------------------------------------------------------------------------------------- |
39+
| `agent/agent.json` | The agent used to connect to the workspace with environment variables stripped. |
40+
| `agent/agent_magicsock.html` | The contents of the HTTP debug endpoint of the agent's Tailscale connection. |
41+
| `agent/client_magicsock.html` | The contents of the HTTP debug endpoint of the client's Tailscale connection. |
42+
| `agent/listening_ports.json` | The listening ports detected by the selected agent running in the workspace. |
43+
| `agent/logs.txt` | The logs of the selected agent running in the workspace. |
44+
| `agent/manifest.json` | The manifest of the selected agent with environment variables stripped. |
45+
| `agent/startup_logs.txt` | Startup logs of the workspace agent. |
46+
| `agent/prometheus.txt` | The contents of the agent's Prometheus endpoint. |
47+
| `cli_logs.txt` | Logs from running the `coder support bundle` command. |
48+
| `deployment/buildinfo.json` | Coder version and build information. |
49+
| `deployment/config.json` | Deployment [configuration](../reference/api/general.md#get-deployment-config), with secret values removed. |
50+
| `deployment/experiments.json` | Any [experiments](../reference/cli/server.md#experiments) currently enabled for the deployment. |
51+
| `deployment/health.json` | A snapshot of the [health status](../admin/healthcheck.md) of the deployment. |
52+
| `logs.txt` | Logs from the `codersdk.Client` used to generate the bundle. |
53+
| `network/connection_info.json` | Information used by workspace agents used to connect to Coder (DERP map etc.) |
54+
| `network/coordinator_debug.html` | Peers currently connected to each Coder instance and the tunnels established between peers. |
55+
| `network/netcheck.json` | Results of running `coder netcheck` locally. |
56+
| `network/tailnet_debug.html` | Tailnet coordinators, their heartbeat ages, connected peers, and tunnels. |
57+
| `workspace/build_logs.txt` | Build logs of the selected workspace. |
58+
| `workspace/workspace.json` | Details of the selected workspace. |
59+
| `workspace/parameters.json` | Build parameters of the selected workspace. |
60+
| `workspace/template.json` | The template currently in use by the selected workspace. |
61+
| `workspace/template_file.zip` | The source code of the template currently in use by the selected workspace. |
62+
| `workspace/template_version.json` | The template version currently in use by the selected workspace. |
6363

6464
## How do I generate a Support Bundle?
6565

@@ -72,8 +72,8 @@ A brief overview of all files contained in the bundle is provided below:
7272
> Note: It is recommended to generate a support bundle from a location
7373
> experiencing workspace connectivity issues.
7474
75-
3. Ensure you are [logged in](../cli/login.md#login) to your Coder deployment as
76-
a user with the Owner privilege.
75+
3. Ensure you are [logged in](../reference/cli/login.md#login) to your Coder
76+
deployment as a user with the Owner privilege.
7777

7878
4. Run `coder support bundle [owner/workspace]`, and respond `yes` to the
7979
prompt. The support bundle will be generated in the current directory with

0 commit comments

Comments
 (0)