Compare commits

...

5 Commits

Author SHA1 Message Date
Atif Ali
295525fb75 docs: move database options outside tabs to fix rendering 2025-12-01 09:00:58 +00:00
Atif Ali
4e85c28abe docs: fix grammar in docker compose instructions 2025-12-01 08:45:07 +00:00
blink-so[bot]
901ba4a0cc docs: use correct tab syntax and move docker compose first
Co-authored-by: M Atif Ali <U04T3LN8ASU+atif@users.noreply.github.com>
2025-12-01 08:43:16 +00:00
blink-so[bot]
dab3d4e306 docs: fix broken link fragment after tab restructure
Co-authored-by: M Atif Ali <U04T3LN8ASU+atif@users.noreply.github.com>
2025-12-01 08:43:16 +00:00
blink-so[bot]
cb4510692e docs: restructure docker installation with tabs, move compose first
Co-authored-by: M Atif Ali <U04T3LN8ASU+atif@users.noreply.github.com>
2025-12-01 08:43:15 +00:00

View File

@@ -13,8 +13,42 @@ You can install and run Coder using the official Docker images published on
- 2 CPU cores and 4 GB memory free on your machine.
<div class="tabs">
## Install Coder via `docker compose`
Coder publishes a
[docker compose example](https://github.com/coder/coder/blob/main/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`](https://github.com/coder/coder/blob/main/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:
```shell
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`
</div>
### Built-in database (quick)
For proof-of-concept deployments, you can run a complete Coder instance with the
@@ -47,36 +81,6 @@ docker run --rm -it \
ghcr.io/coder/coder:latest
```
## Install Coder via `docker compose`
Coder's publishes a
[docker compose example](https://github.com/coder/coder/blob/main/compose.yaml)
which includes an PostgreSQL container and volume.
1. Make sure you have [Docker Compose](https://docs.docker.com/compose/install/)
installed.
1. Download the
[`docker-compose.yaml`](https://github.com/coder/coder/blob/main/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:
```shell
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 the preview release
> [!TIP]