Skip to content

Commit 8a6147c

Browse files
authored
add docs for docker-compose tunnel
1 parent 0e5a67b commit 8a6147c

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

docs/admin/configure.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ This is a quick way to allow users and workspaces outside your LAN to connect to
1212
that users and workspaces use to connect to Coder (e.g. https://coder.example.com). This
1313
should not be localhost.
1414

15+
> Access URL should be a external IP address or domain with DNS records pointing to Coder.
16+
1517
## PostgreSQL Database
1618

1719
Coder uses a PostgreSQL database to store users, workspace metadata, and other deployment information.

docs/install/docker.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,27 @@ an PostgreSQL container and volume.
5454

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

57-
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.
57+
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.
58+
59+
For proof-of-concept deployments, you can use [Coder's tunnel](../admin/configure.md#tunnel):
5860

59-
```console
61+
```sh
62+
cd coder
63+
64+
CODER_TUNNEL=true
65+
docker-compose up
66+
```
67+
68+
For production deployments, we recommend setting an [access URL](../admin/configure.md#access-url):
69+
70+
```sh
6071
cd coder
6172

62-
CODER_ACCESS_URL=https://coder.example.com
73+
CODER_ACCESS_URL=https://coder.example.com # URL that
6374
docker-compose up
6475
```
6576

66-
> Without `CODER_ACCESS_URL` set, Coder will bind to `localhost:7080`. This will only work for Docker-based templates.
77+
> Without `CODER_ACCESS_URL` or `CODER_TUNNEL` set, Coder will bind to `localhost:7080`. This will only work for Docker-based templates.
6778
6879
4. Follow the on-screen instructions log in and create your first template and workspace
6980

0 commit comments

Comments
 (0)