## 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).
95 lines
2.2 KiB
Markdown
95 lines
2.2 KiB
Markdown
---
|
|
title: Use Coder with an external database
|
|
---
|
|
|
|
## Recommendation
|
|
|
|
For production deployments, we recommend using an external
|
|
[PostgreSQL](https://www.postgresql.org/) database (version 13 or higher).
|
|
|
|
## Basic configuration
|
|
|
|
Before starting the Coder server, prepare the database server by creating a role
|
|
and a database. Remember that the role must have access to the created database.
|
|
|
|
With `psql`:
|
|
|
|
```sql
|
|
CREATE ROLE coder LOGIN SUPERUSER PASSWORD 'secret42';
|
|
```
|
|
|
|
With `psql -U coder`:
|
|
|
|
```sql
|
|
CREATE DATABASE coder;
|
|
```
|
|
|
|
Coder configuration is defined via
|
|
[environment variables](../admin/setup/index.md). The database client requires
|
|
the connection string provided via the `CODER_PG_CONNECTION_URL` variable.
|
|
|
|
```sh
|
|
export CODER_PG_CONNECTION_URL="postgres://coder:secret42@localhost/coder?sslmode=disable"
|
|
```
|
|
|
|
## Custom schema
|
|
|
|
For installations with elevated security requirements, it's advised to use a
|
|
separate [schema](https://www.postgresql.org/docs/current/ddl-schemas.html)
|
|
instead of the public one.
|
|
|
|
With `psql -U coder`:
|
|
|
|
```sql
|
|
CREATE SCHEMA myschema;
|
|
```
|
|
|
|
Once the schema is created, you can list all schemas with `\dn`:
|
|
|
|
```txt
|
|
List of schemas
|
|
Name | Owner
|
|
-----------+----------
|
|
myschema | coder
|
|
public | postgres
|
|
(2 rows)
|
|
```
|
|
|
|
In this case the database client requires the modified connection string:
|
|
|
|
```sh
|
|
export CODER_PG_CONNECTION_URL="postgres://coder:secret42@localhost/coder?sslmode=disable&search_path=myschema"
|
|
```
|
|
|
|
The `search_path` parameter determines the order of schemas in which they are
|
|
visited while looking for a specific table. The first schema named in the search
|
|
path is called the current schema. By default `search_path` defines the
|
|
following schemas:
|
|
|
|
```sql
|
|
SHOW search_path;
|
|
|
|
search_path
|
|
--------------
|
|
"$user", public
|
|
```
|
|
|
|
Using the `search_path` in the connection string corresponds to the following
|
|
`psql` command:
|
|
|
|
```sql
|
|
ALTER ROLE coder SET search_path = myschema;
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Coder server fails startup with "current_schema: converting NULL to string is unsupported"
|
|
|
|
Please make sure that the schema selected in the connection string
|
|
`...&search_path=myschema` exists and the role has granted permissions to access
|
|
it. The schema should be present on this listing:
|
|
|
|
```sh
|
|
psql -U coder -c '\dn'
|
|
```
|