## Summary **Batch B of Phase 3** of the H1 → front-matter migration (`DOCS-484`; parent `DOCS-477`), the editorial follow-up to Batch A (#28030). For the **124** hand-authored pages whose leading body H1 differed from the manifest nav label, this promotes the richer body H1 to the front-matter **page title** and drops the duplicate H1, while keeping the short manifest **label** as the sidebar entry. Policy agreed with the docs owner: - Short sidebar labels win. Duplicate sidebar labels are acceptable. - Identical **page titles** across two pages are not. On a collision, rename the non-generated page's title. ## Page-title collisions resolved Promoting the H1 created 4 page-title collisions; each is disambiguated by renaming the non-generated / secondary page (sidebar labels left unchanged): | page | sidebar label | body H1 | → page title | |------|---------------|---------|--------------| | `install/index.md` | Install | Installing Coder | **Install Coder in your infrastructure** | | `install/cli.md` | Coder CLI | Installing Coder | **Install the Coder CLI** | | `ai-gateway/clients/jetbrains.md` | JetBrains | JetBrains IDEs | **JetBrains** | | `workspace-access/web-ides.md` | Web IDEs and Coder Apps | Web IDEs | Web IDEs *(kept — primary user guide)* | | `extending-templates/web-ides.md` | Web IDEs and Coder Apps | Web IDEs | **Web IDEs in templates** | | `workspace-management.md` | Workspace Management | Workspaces | **Manage workspaces** *(vs generated `api/workspaces.md`)* | These titles are the only non-mechanical editorial calls in this PR. ## Deliberately excluded: generated pages `admin/security/audit-logs.md` and `admin/setup/configuration-reference.md` are `make gen` outputs (`auditdocgen` / `configdocgen`) that Phase 2 did **not** update, so a hand-added title would be reverted on the next generation. They're excluded here and need their generators taught to emit front matter first (Phase 2 pattern), tracked as `DOCS-631`. Batch A (#28030) had the same issue for three other generated pages; it has been corrected there too. ## Verification AI was the primary author of this PR (see disclosure below); per the [AI Contribution Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING) here is the manual verification. - Promote = set front-matter `title` to the body H1 (or the disambiguated title above) and remove that one duplicate H1. No other body prose is reflowed. - Every added front-matter block parses as YAML; all files pass `pnpm check-docs` (markdownlint-cli2 + table formatter): `Summary: 0 error(s)`. - Removing the H1 orphaned one in-page fragment (`[MCP](#mcp)` in `ai-gateway/mcp.md`), now repointed. A cross-file fragment audit into the retitled pages found no real breakage. Anchor-change note Unlike Batch A (title unchanged, a rendered no-op), Batch B changes each page's effective title from the manifest label to the body H1, so the rendered H1 **anchor slug changes**. An audit of cross-file `.md#fragment` links into these pages surfaced no links that break as a result (the only hits were false positives against a still-present `## TLS & Reverse Proxy` heading). Same-file fragments are enforced by markdownlint MD051, which is green. ## Title casing (follow-up, DOCS-742) A follow-up commit puts the promoted titles into sentence case and removes leading gerunds (for example, `Managing workspace schedules` → `Manage workspace schedules`): 57 of the 120 titles changed, the other 63 were already compliant. Proper nouns and branded names (Coder Validated Architecture, JetBrains, File Browser, Dev Containers, Island), acronyms (API, CLI, IDE, MCP, OIDC, URL, UI, CI/CD), the Premium license tier, and maturity labels (Beta, Experimental) are preserved. The four `Nk-users` pages become `Reference architecture: up to N users` (lowercase, matching the CVA landing page's own usage); the CVA landing page keeps its branded title. `pnpm check-docs`: `Summary: 0 error(s)`. Linear: DOCS-484, DOCS-742 > This PR was created with AI assistance (Coder Agents).
175 lines
4.4 KiB
Markdown
175 lines
4.4 KiB
Markdown
---
|
|
title: How to use Apache as a reverse-proxy with LetsEncrypt
|
|
---
|
|
|
|
## Requirements
|
|
|
|
1. Start a Coder deployment and be sure to set the following
|
|
[configuration values](../admin/setup/index.md):
|
|
|
|
```dotenv
|
|
CODER_HTTP_ADDRESS=127.0.0.1:3000
|
|
CODER_ACCESS_URL=https://coder.example.com
|
|
CODER_WILDCARD_ACCESS_URL=*coder.example.com
|
|
```
|
|
|
|
Throughout the guide, be sure to replace `coder.example.com` with the domain
|
|
you intend to use with Coder.
|
|
|
|
2. Configure your DNS provider to point your coder.example.com and
|
|
\*.coder.example.com to your server's public IP address.
|
|
|
|
> For example, to use `coder.example.com` as your subdomain, configure
|
|
> `coder.example.com` and `*.coder.example.com` to point to your server's
|
|
> public ip. This can be done by adding A records in your DNS provider's
|
|
> dashboard.
|
|
|
|
3. Install Apache (assuming you're on Debian/Ubuntu):
|
|
|
|
```sh
|
|
sudo apt install apache2
|
|
```
|
|
|
|
4. Enable the following Apache modules:
|
|
|
|
```sh
|
|
sudo a2enmod proxy
|
|
sudo a2enmod proxy_http
|
|
sudo a2enmod ssl
|
|
sudo a2enmod rewrite
|
|
```
|
|
|
|
5. Stop Apache service and disable default site:
|
|
|
|
```sh
|
|
sudo a2dissite 000-default.conf
|
|
sudo systemctl stop apache2
|
|
```
|
|
|
|
## Install and configure LetsEncrypt Certbot
|
|
|
|
1. Install LetsEncrypt Certbot: Refer to the
|
|
[CertBot documentation](https://certbot.eff.org/instructions?ws=apache&os=ubuntufocal&tab=wildcard).
|
|
Be sure to pick the wildcard tab and select your DNS provider for
|
|
instructions to install the necessary DNS plugin.
|
|
|
|
## Create DNS provider credentials
|
|
|
|
This example assumes you're using CloudFlare as your DNS provider. For other
|
|
providers, refer to the
|
|
[CertBot documentation](https://eff-certbot.readthedocs.io/en/stable/using.html#dns-plugins).
|
|
|
|
1. Create an API token for the DNS provider you're using: e.g.
|
|
[CloudFlare](https://developers.cloudflare.com/fundamentals/api/get-started/create-token)
|
|
with the following permissions:
|
|
|
|
- Zone - DNS - Edit
|
|
|
|
2. Create a file in `.secrets/certbot/cloudflare.ini` with the following
|
|
content:
|
|
|
|
```ini
|
|
dns_cloudflare_api_token = YOUR_API_TOKEN
|
|
```
|
|
|
|
```sh
|
|
mkdir -p ~/.secrets/certbot
|
|
touch ~/.secrets/certbot/cloudflare.ini
|
|
nano ~/.secrets/certbot/cloudflare.ini
|
|
```
|
|
|
|
3. Set the correct permissions:
|
|
|
|
```sh
|
|
sudo chmod 600 ~/.secrets/certbot/cloudflare.ini
|
|
```
|
|
|
|
## Create the certificate
|
|
|
|
1. Create the wildcard certificate:
|
|
|
|
```sh
|
|
sudo certbot certonly --dns-cloudflare --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini -d coder.example.com -d *.coder.example.com
|
|
```
|
|
|
|
## Configure Apache
|
|
|
|
This example assumes Coder is running locally on `127.0.0.1:3000` and that
|
|
you're using `coder.example.com` as your subdomain.
|
|
|
|
1. Create Apache configuration for Coder:
|
|
|
|
```sh
|
|
sudo nano /etc/apache2/sites-available/coder.conf
|
|
```
|
|
|
|
2. Add the following content:
|
|
|
|
```apache
|
|
# Redirect HTTP to HTTPS
|
|
<VirtualHost *:80>
|
|
ServerName coder.example.com
|
|
ServerAlias *.coder.example.com
|
|
Redirect permanent / https://coder.example.com/
|
|
</VirtualHost>
|
|
|
|
<VirtualHost *:443>
|
|
ServerName coder.example.com
|
|
ServerAlias *.coder.example.com
|
|
ErrorLog ${APACHE_LOG_DIR}/error.log
|
|
CustomLog ${APACHE_LOG_DIR}/access.log combined
|
|
|
|
ProxyPass / http://127.0.0.1:3000/ upgrade=any # required for websockets
|
|
ProxyPassReverse / http://127.0.0.1:3000/
|
|
ProxyRequests Off
|
|
ProxyPreserveHost On
|
|
|
|
RewriteEngine On
|
|
# Websockets are required for workspace connectivity
|
|
RewriteCond %{HTTP:Connection} Upgrade [NC]
|
|
RewriteCond %{HTTP:Upgrade} websocket [NC]
|
|
RewriteRule /(.*) ws://127.0.0.1:3000/$1 [P,L]
|
|
|
|
SSLCertificateFile /etc/letsencrypt/live/coder.example.com/fullchain.pem
|
|
SSLCertificateKeyFile /etc/letsencrypt/live/coder.example.com/privkey.pem
|
|
</VirtualHost>
|
|
```
|
|
|
|
> Don't forget to change: `coder.example.com` by your (sub)domain
|
|
|
|
3. Enable the site:
|
|
|
|
```sh
|
|
sudo a2ensite coder.conf
|
|
```
|
|
|
|
4. Restart Apache:
|
|
|
|
```sh
|
|
sudo systemctl restart apache2
|
|
```
|
|
|
|
## Refresh certificates automatically
|
|
|
|
1. Create a new file in `/etc/cron.weekly`:
|
|
|
|
```sh
|
|
sudo touch /etc/cron.weekly/certbot
|
|
```
|
|
|
|
2. Make it executable:
|
|
|
|
```sh
|
|
sudo chmod +x /etc/cron.weekly/certbot
|
|
```
|
|
|
|
3. And add this code:
|
|
|
|
```sh
|
|
#!/bin/sh
|
|
sudo certbot renew -q
|
|
```
|
|
|
|
And that's it, you should now be able to access Coder at your sub(domain) e.g.
|
|
`https://coder.example.com`.
|