## 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).
168 lines
5.8 KiB
Markdown
168 lines
5.8 KiB
Markdown
---
|
|
title: Install Coder via Docker
|
|
---
|
|
|
|
You can install and run Coder using the official Docker images published on
|
|
[GitHub Container Registry](https://github.com/coder/coder/pkgs/container/coder).
|
|
|
|
## Requirements
|
|
|
|
- Docker. See the
|
|
[official installation documentation](https://docs.docker.com/install/).
|
|
|
|
- A Linux host.
|
|
|
|
- 2 CPU cores and 4 GB memory free on your machine.
|
|
|
|
> [!IMPORTANT]
|
|
> This guide is for **Linux** hosts only. The `getent` and `--group-add`
|
|
> Docker socket patterns used below are Linux-specific and do not translate
|
|
> cleanly to macOS Docker runtimes. For macOS, install Coder using the
|
|
> [standalone binary](./cli.md) instead.
|
|
|
|
<div class="tabs">
|
|
|
|
## Install Coder via `docker compose`
|
|
|
|
Coder publishes a
|
|
[docker compose example](../../compose.yaml)
|
|
which includes a PostgreSQL container and volume.
|
|
|
|
1. Make sure you have [Docker Compose](https://docs.docker.com/compose/install/)
|
|
installed.
|
|
|
|
1. Download the
|
|
[`docker-compose.yaml`](../../compose.yaml)
|
|
file.
|
|
|
|
1. Update `group_add:` in `docker-compose.yaml` with the `gid` of `docker`
|
|
group. You can get the `docker` group `gid` by running the below command:
|
|
|
|
```sh
|
|
getent group docker | cut -d: -f3
|
|
```
|
|
|
|
1. Start Coder with `docker compose up`
|
|
|
|
1. Visit the web UI via the configured url.
|
|
|
|
1. Follow the on-screen instructions log in and create your first template and
|
|
workspace
|
|
|
|
Coder configuration is defined via environment variables. Learn more about
|
|
Coder's [configuration options](../admin/setup/index.md).
|
|
|
|
## Install Coder via `docker run`
|
|
|
|
### Built-in database (quick)
|
|
|
|
For proof-of-concept deployments, you can run a complete Coder instance with the
|
|
following command.
|
|
|
|
```sh
|
|
export CODER_DATA=$HOME/.config/coderv2-docker
|
|
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
|
|
mkdir -p $CODER_DATA
|
|
docker run --rm -it \
|
|
-v $CODER_DATA:/home/coder/.config \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
--group-add $DOCKER_GROUP \
|
|
ghcr.io/coder/coder:latest
|
|
```
|
|
|
|
### External database (recommended)
|
|
|
|
For production deployments, we recommend using an external PostgreSQL database
|
|
(version 13 or higher). Set `CODER_ACCESS_URL` to the external URL that users
|
|
and workspaces will use to connect to Coder.
|
|
|
|
```sh
|
|
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
|
|
docker run --rm -it \
|
|
-e CODER_ACCESS_URL="https://coder.example.com" \
|
|
-e CODER_PG_CONNECTION_URL="postgresql://username:password@database/coder" \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
--group-add $DOCKER_GROUP \
|
|
ghcr.io/coder/coder:latest
|
|
```
|
|
|
|
</div>
|
|
|
|
## Install the preview release
|
|
|
|
> [!TIP]
|
|
> We do not recommend using preview releases in production environments.
|
|
|
|
You can install and test a
|
|
[preview release of Coder](https://github.com/coder/coder/pkgs/container/coder-preview)
|
|
by using the `coder-preview:latest` image tag.
|
|
This image is automatically updated with the latest changes from the `main` branch.
|
|
|
|
Replace `ghcr.io/coder/coder:latest` in the `docker run` command in the
|
|
[steps above](#install-coder-via-docker-run) with `ghcr.io/coder/coder-preview:latest`.
|
|
|
|
## Troubleshooting
|
|
|
|
### Cannot connect to the Docker daemon
|
|
|
|
If you see an error like:
|
|
|
|
```txt
|
|
Error: Error pinging Docker server: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
|
|
```
|
|
|
|
Docker is not installed or not running on the host. Install Docker and start the
|
|
daemon before creating a workspace from a Docker-based template. Refer to the
|
|
[Troubleshooting section of the get started guide](../get-started/index.md#cannot-connect-to-the-docker-daemon)
|
|
for platform-specific steps.
|
|
|
|
If Docker is installed and running but Coder still cannot connect, the daemon may expose its socket at a path other than `/var/run/docker.sock`.
|
|
This can happen on any operating system when Docker runs through a tool that uses a per-user socket, such as rootless Docker on Linux, or Colima, Podman, or Rancher Desktop on macOS.
|
|
Point Coder at the right socket with `DOCKER_HOST`.
|
|
|
|
Find the socket path first.
|
|
For example, run `colima status` for Colima, or `docker context inspect` to read the endpoint of the active Docker context.
|
|
Default socket paths vary by tool, so consult your tool's documentation and treat the following as examples only:
|
|
|
|
```sh
|
|
# rootless Docker (Linux)
|
|
export DOCKER_HOST="unix://${XDG_RUNTIME_DIR}/docker.sock"
|
|
|
|
# Colima (macOS)
|
|
export DOCKER_HOST="unix://${HOME}/.colima/default/docker.sock"
|
|
```
|
|
|
|
To persist the setting, add the `export` line to your shell's startup file, such as `~/.bashrc`, `~/.zshrc`, or `~/.config/fish/config.fish`.
|
|
Then restart the Coder server.
|
|
|
|
### Docker-based workspace is stuck in "Connecting..."
|
|
|
|
Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See
|
|
[troubleshooting templates](../admin/templates/troubleshooting.md) for more
|
|
steps.
|
|
|
|
### Permission denied while trying to connect to the Docker daemon socket
|
|
|
|
See Docker's official documentation to
|
|
[Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
|
|
|
|
### I cannot add Docker templates
|
|
|
|
Coder runs as a non-root user, we use `--group-add` to ensure Coder has
|
|
permissions to manage Docker via `docker.sock`. If the host systems
|
|
`/var/run/docker.sock` is not group writable or does not belong to the `docker`
|
|
group, the above may not work as-is.
|
|
|
|
### I cannot add cloud-based templates
|
|
|
|
In order to use cloud-based templates (e.g. Kubernetes, AWS), you must have an
|
|
external URL that users and workspaces will use to connect to Coder. For
|
|
proof-of-concept deployments, you can use
|
|
[Coder's tunnel](../admin/setup/index.md#tunnel). For production deployments, we
|
|
recommend setting an [access URL](../admin/setup/index.md#access-url)
|
|
|
|
## Next steps
|
|
|
|
- [Create your first template](../tutorials/template-from-scratch.md)
|
|
- [Control plane configuration](../admin/setup/index.md)
|