Skip to content

Commit 2b3ae54

Browse files
authored
chore: rename docker-compose.yaml to compose.yaml (#19480)
Docker recommends using a `compose.yaml` file.
1 parent 3b6c85a commit 2b3ae54

File tree

4 files changed

+6
-7
lines changed

4 files changed

+6
-7
lines changed

docker-compose.yaml renamed to compose.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
version: "3.9"
21
services:
32
coder:
43
# This MUST be stable for our documentation and

docs/admin/networking/workspace-proxies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ regular Coder server.
178178
#### Docker Compose
179179

180180
Change the provided
181-
[`docker-compose.yml`](https://github.com/coder/coder/blob/main/docker-compose.yaml)
181+
[`compose.yml`](https://github.com/coder/coder/blob/main/compose.yaml)
182182
file to include a custom entrypoint:
183183

184184
```diff

docs/install/docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ docker run --rm -it \
5050
## Install Coder via `docker compose`
5151

5252
Coder's publishes a
53-
[docker-compose example](https://github.com/coder/coder/blob/main/docker-compose.yaml)
53+
[docker compose example](https://github.com/coder/coder/blob/main/compose.yaml)
5454
which includes an PostgreSQL container and volume.
5555

5656
1. Make sure you have [Docker Compose](https://docs.docker.com/compose/install/)
5757
installed.
5858

5959
1. Download the
60-
[`docker-compose.yaml`](https://github.com/coder/coder/blob/main/docker-compose.yaml)
60+
[`docker-compose.yaml`](https://github.com/coder/coder/blob/main/compose.yaml)
6161
file.
6262

6363
1. Update `group_add:` in `docker-compose.yaml` with the `gid` of `docker`

docs/tutorials/reverse-proxy-caddy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ certificates, you'll need a domain name that resolves to your Caddy server.
66

77
## Getting started
88

9-
### With docker-compose
9+
### With `docker compose`
1010

1111
1. [Install Docker](https://docs.docker.com/engine/install/) and
1212
[Docker Compose](https://docs.docker.com/compose/install/)
1313

14-
2. Create a `docker-compose.yaml` file and add the following:
14+
2. Create a `compose.yaml` file and add the following:
1515

1616
```yaml
1717
services:
@@ -212,7 +212,7 @@ Caddy modules.
212212
- Docker:
213213
[Build an custom Caddy image](https://github.com/docker-library/docs/tree/master/caddy#adding-custom-caddy-modules)
214214
with the module for your DNS provider. Be sure to reference the new image
215-
in the `docker-compose.yaml`.
215+
in the `compose.yaml`.
216216

217217
- Standalone:
218218
[Download a custom Caddy build](https://caddyserver.com/download) with the

0 commit comments

Comments
 (0)