Skip to content

chore: rename docker-compose.yaml to compose.yaml #19480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 23, 2025
Merged

chore: rename docker-compose.yaml to compose.yaml #19480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b739a31
chore: rename docker-compose.yaml to compose.yaml
matifali Aug 22, 2025
8618008
Fix links to docker-compose example file
matifali Aug 22, 2025
eb3a123
Rename docker-compose.yaml to compose.yaml in docs
matifali Aug 22, 2025
124e942
Change docker-compose.yml link to compose.yml
matifali Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docker-compose.yaml → compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
version: "3.9"
services:
coder:
# This MUST be stable for our documentation and
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/networking/workspace-proxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ regular Coder server.
#### Docker Compose

Change the provided
[`docker-compose.yml`](https://github.com/coder/coder/blob/main/docker-compose.yaml)
[`compose.yml`](https://github.com/coder/coder/blob/main/compose.yaml)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/blob/main/compose.yaml Status: 404

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will get resolved once merged.

file to include a custom entrypoint:

```diff
Expand Down
4 changes: 2 additions & 2 deletions docs/install/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ docker run --rm -it \
## Install Coder via `docker compose`

Coder's publishes a
[docker-compose example](https://github.com/coder/coder/blob/main/docker-compose.yaml)
[docker compose example](https://github.com/coder/coder/blob/main/compose.yaml)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/blob/main/compose.yaml Status: 404

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/docker-compose.yaml)
[`docker-compose.yaml`](https://github.com/coder/coder/blob/main/compose.yaml)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/blob/main/compose.yaml Status: 404

file.

1. Update `group_add:` in `docker-compose.yaml` with the `gid` of `docker`
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/reverse-proxy-caddy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ certificates, you'll need a domain name that resolves to your Caddy server.

## Getting started

### With docker-compose
### With `docker compose`

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

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

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

- Standalone:
[Download a custom Caddy build](https://caddyserver.com/download) with the
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy