Skip to content

Commit 1b525d8

Browse files
matifalimatifali
committedOct 2, 2024
Move reverse-proxy docs from examples to docs
- Relocate Apache, Caddy, and NGINX configuration from examples. - Update internal links for configuration guides to reflect new paths. - Improve documentation structure by centralizing setup resources.
1 parent a5eccec commit 1b525d8

File tree

7 files changed

+11
-11
lines changed

7 files changed

+11
-11
lines changed
 

‎docs/admin/setup/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ The Coder server can directly use TLS certificates with `CODER_TLS_ENABLE` and
6262
accompanying configuration flags. However, Coder can also run behind a
6363
reverse-proxy to terminate TLS certificates from LetsEncrypt, for example.
6464

65-
- [Apache](https://github.com/coder/coder/tree/main/examples/web-server/apache)
66-
- [Caddy](https://github.com/coder/coder/tree/main/examples/web-server/caddy)
67-
- [NGINX](https://github.com/coder/coder/tree/main/examples/web-server/nginx)
65+
- [Apache](./web-server/apache/README.md)
66+
- [Caddy](./web-server/caddy/README.md)
67+
- [NGINX](./web-server/nginx/README.md)
6868

6969
### Kubernetes TLS configuration
7070

‎examples/web-server/apache/README.md renamed to ‎docs/admin/setup/web-server/apache/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Requirements
44

5-
1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/admin/configure):
5+
1. Start a Coder deployment and be sure to set the following [configuration values](../../README.md):
66

77
```env
88
CODER_HTTP_ADDRESS=127.0.0.1:3000

‎examples/web-server/caddy/README.md renamed to ‎docs/admin/setup/web-server/caddy/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
1818

1919
# Clone coder/coder and copy the Caddy example
2020
git clone https://github.com/coder/coder /tmp/coder
21-
mv /tmp/coder/examples/web-server/caddy $(pwd)
21+
mv /tmp/coder/docs/admin/setup/web-server/caddy $(pwd)
2222
```
2323

2424
1. Modify the [Caddyfile](./Caddyfile) and change the following values:
2525

2626
- `localhost:3000`: Change to `coder:7080` (Coder container on Docker network)
2727
- `email@example.com`: Email to request certificates from LetsEncrypt/ZeroSSL (does not have to be Coder admin email)
2828
- `coder.example.com`: Domain name you're using for Coder.
29-
- `*.coder.example.com`: Domain name for wildcard apps, commonly used for [dashboard port forwarding](https://coder.com/docs/networking/port-forwarding#dashboard). This is optional and can be removed.
29+
- `*.coder.example.com`: Domain name for wildcard apps, commonly used for [dashboard port forwarding](../../../networking/port-forwarding.md). This is optional and can be removed.
3030

3131
1. Start Coder. Set `CODER_ACCESS_URL` and `CODER_WILDCARD_ACCESS_URL` to the domain you're using in your Caddyfile.
3232

@@ -38,7 +38,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
3838

3939
### Standalone
4040

41-
1. If you haven't already, [install Coder](https://coder.com/docs/install)
41+
1. If you haven't already, [install Coder](../../../../install/README.md)
4242

4343
2. Install [Caddy Server](https://caddyserver.com/docs/install)
4444

@@ -48,11 +48,11 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
4848
4949
- `email@example.com`: Email to request certificates from LetsEncrypt/ZeroSSL (does not have to be Coder admin email)
5050
- `coder.example.com`: Domain name you're using for Coder.
51-
- `*.coder.example.com`: Domain name for wildcard apps, commonly used for [dashboard port forwarding](https://coder.com/docs/networking/port-forwarding#dashboard). This is optional and can be removed.
51+
- `*.coder.example.com`: Domain name for wildcard apps, commonly used for [dashboard port forwarding](../../../networking/port-forwarding.md). This is optional and can be removed.
5252
- `localhost:3000`: Address Coder is running on. Modify this if you changed `CODER_HTTP_ADDRESS` in the Coder configuration.
5353
- _DO NOT CHANGE the `ask http://example.com` line! Doing so will result in your certs potentially not being generated._
5454

55-
4. [Configure Coder](https://coder.com/docs/admin/configure) and change the following values:
55+
4. [Configure Coder](../../README.md) and change the following values:
5656

5757
- `CODER_ACCESS_URL`: root domain (e.g. `https://coder.example.com`)
5858
- `CODER_WILDCARD_ACCESS_URL`: wildcard domain (e.g. `*.example.com`).
@@ -95,7 +95,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
9595

9696
## Generating wildcard certificates
9797

98-
By default, this configuration uses Caddy's [on-demand TLS](https://caddyserver.com/docs/caddyfile/options#on-demand-tls) to generate a certificate for each subdomain (e.g. `app1.coder.example.com`, `app2.coder.example.com`). When users visit new subdomains, such as accessing [ports on a workspace](../../../docs/networking/port-forwarding.md), the request will take an additional 5-30 seconds since a new certificate is being generated.
98+
By default, this configuration uses Caddy's [on-demand TLS](https://caddyserver.com/docs/caddyfile/options#on-demand-tls) to generate a certificate for each subdomain (e.g. `app1.coder.example.com`, `app2.coder.example.com`). When users visit new subdomains, such as accessing [ports on a workspace](../../../networking/port-forwarding.md), the request will take an additional 5-30 seconds since a new certificate is being generated.
9999

100100
For production deployments, we recommend configuring Caddy to generate a wildcard certificate, which requires an explicit DNS challenge and additional Caddy modules.
101101

‎examples/web-server/nginx/README.md renamed to ‎docs/admin/setup/web-server/nginx/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Requirements
44

5-
1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/admin/configure):
5+
1. Start a Coder deployment and be sure to set the following [configuration values](../../README.md):
66

77
```env
88
CODER_HTTP_ADDRESS=127.0.0.1:3000

0 commit comments

Comments
 (0)