Skip to content

Add support for coder tunnel in docker-compose #4027

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
Sep 13, 2022
Merged

Add support for coder tunnel in docker-compose #4027

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e5a67b
Add support for `coder tunnel` in docker-compose
bpmct Sep 12, 2022
8a6147c
add docs for docker-compose tunnel
bpmct Sep 12, 2022
53cb35c
Update docs/install/docker.md
bpmct Sep 12, 2022
65642b7
Update docs/install/docker.md
bpmct Sep 12, 2022
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
5 changes: 4 additions & 1 deletion docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ services:
- "7080:7080"
environment:
CODER_PG_CONNECTION_URL: "postgresql://${POSTGRES_USER:-username}:${POSTGRES_PASSWORD:-password}@database/${POSTGRES_DB:-coder}?sslmode=disable"
CODER_ADDRESS: "0.0.0.0:7080"
# You'll need to set CODER_ACCESS_URL to an IP or domain
# that workspaces can reach. This cannot be localhost
# or 127.0.0.1 for non-Docker templates!
CODER_ADDRESS: "0.0.0.0:7080"
CODER_ACCESS_URL: "${CODER_ACCESS_URL}"
# Alternatively, you can enable CODER_TUNNEL for
# proof-of-concept deployments.
CODER_TUNNEL: "${CODER_TUNNEL:-false}"
volumes:
- /var/run/docker.sock:/var/run/docker.sock
depends_on:
Expand Down
2 changes: 2 additions & 0 deletions docs/admin/configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ This is a quick way to allow users and workspaces outside your LAN to connect to
that users and workspaces use to connect to Coder (e.g. https://coder.example.com). This
should not be localhost.

> Access URL should be a external IP address or domain with DNS records pointing to Coder.

## PostgreSQL Database

Coder uses a PostgreSQL database to store users, workspace metadata, and other deployment information.
Expand Down
18 changes: 14 additions & 4 deletions docs/install/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,26 @@ an PostgreSQL container and volume.

3. Start Coder with `docker-compose up`:

In order to use cloud-based templates (e.g. Kubernetes, AWS), you must set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to connect to Coder.
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/configure.md#tunnel):

```console
```sh
cd coder

CODER_TUNNEL=true docker-compose up
```

For production deployments, we recommend setting an [access URL](../admin/configure.md#access-url):

```sh
cd coder

CODER_ACCESS_URL=https://coder.example.com
CODER_ACCESS_URL=https://coder.example.com # URL that
docker-compose up
```

> Without `CODER_ACCESS_URL` set, Coder will bind to `localhost:7080`. This will only work for Docker-based templates.
> Without `CODER_ACCESS_URL` or `CODER_TUNNEL` set, Coder will bind to `localhost:7080`. This will only work for Docker-based templates.

4. Follow the on-screen instructions log in and create your first template and workspace

Expand Down