Commit3ded910

authored

Add support forcoder tunnel in docker-compose (#4027)

1 parent214e594 commit3ded910Copy full SHA for 3ded910

File tree

+20

-6

lines changed

+20

-6

lines changed

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,14 @@ services:`
`8`	`8`	`-"7080:7080"`
`9`	`9`	`environment:`
`10`	`10`	`CODER_PG_CONNECTION_URL:"postgresql://${POSTGRES_USER:-username}:${POSTGRES_PASSWORD:-password}@database/${POSTGRES_DB:-coder}?sslmode=disable"`
	`11`	`+CODER_ADDRESS:"0.0.0.0:7080"`
`11`	`12`	`# You'll need to set CODER_ACCESS_URL to an IP or domain`
`12`	`13`	`# that workspaces can reach. This cannot be localhost`
`13`	`14`	`# or 127.0.0.1 for non-Docker templates!`
`14`		`-CODER_ADDRESS:"0.0.0.0:7080"`
`15`	`15`	`CODER_ACCESS_URL:"${CODER_ACCESS_URL}"`
	`16`	`+# Alternatively, you can enable CODER_TUNNEL for`
	`17`	`+# proof-of-concept deployments.`
	`18`	`+CODER_TUNNEL:"${CODER_TUNNEL:-false}"`
`16`	`19`	`volumes:`
`17`	`20`	`-/var/run/docker.sock:/var/run/docker.sock`
`18`	`21`	`depends_on:`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@ This is a quick way to allow users and workspaces outside your LAN to connect to`
`12`	`12`	`that users and workspaces use to connect to Coder (e.g.https://coder.example.com). This`
`13`	`13`	`should not be localhost.`
`14`	`14`
	`15`	`+>Access URL should be a external IP address or domain with DNS records pointing to Coder.`
	`16`	`+`
`15`	`17`	`##PostgreSQL Database`
`16`	`18`
`17`	`19`	`Coder uses a PostgreSQL database to store users, workspace metadata, and other deployment information.`

Lines changed: 14 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -54,16 +54,25 @@ an PostgreSQL container and volume.`
`54`	`54`
`55`	`55`	3. Start Coder with`docker-compose up`:
`56`	`56`
`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):`
`58`	`60`
`59`		-```console
	`61`	+```sh
	`62`	`+cd coder`
	`63`	`+`
	`64`	`+ CODER_TUNNEL=true docker-compose up`
	`65`	+```
	`66`	`+`
	`67`	`+ For production deployments, we recommend setting an[access URL](../admin/configure.md#access-url):`
	`68`	`+`
	`69`	+```sh
`60`	`70`	`cd coder`
`61`	`71`
`62`		`- CODER_ACCESS_URL=https://coder.example.com`
`63`		`- docker-compose up`
	`72`	`+ CODER_ACCESS_URL=https://coder.example.com docker-compose up`
`64`	`73`	```
`65`	`74`
`66`		->Without`CODER_ACCESS_URL` set, Coder will bind to`localhost:7080`. This will only work for Docker-based templates.
	`75`	+>Without`CODER_ACCESS_URL`or`CODER_TUNNEL`set, Coder will bind to`localhost:7080`. This will only work for Docker-based templates.
`67`	`76`
`68`	`77`	4. Visit the web ui via the configured url. You can add`/login` to the base url to create the first user via the ui.
`69`	`78`

Comments

(0)