Skip to content

Commit 487cc0c

Browse files
authored
docker quickstart: mention tunnel + troubleshooting (#4653)
1 parent fbbecf0 commit 487cc0c

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

docs/quickstart/docker.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,26 @@ Coder with Docker has the following advantages:
1717

1818
The Coder server binds to port 3000 by default. Use `--address :<port>` to customize it!
1919

20+
Use the [Coder tunnel](../admin/configure.md#tunnel) for a public URL:
21+
22+
```bash
23+
coder server
24+
```
25+
26+
Or set an [access URL](../admin/configure.md#access-url) to run entirely locally:
27+
2028
```bash
21-
$ coder server
29+
coder server --access-url=http://localhost:3000 --address=:3000
2230
```
2331

24-
1. Run `coder login http://localhost:3000` in a new terminal and follow the
32+
1. Run `coder login <access url>` in a new terminal and follow the
2533
interactive instructions to create your user.
2634

2735
1. Pull the "Docker" example template using the interactive `coder templates init`:
2836

2937
```bash
30-
$ coder templates init
31-
$ cd docker
38+
coder templates init
39+
cd docker
3240
```
3341

3442
1. Push up the template with `coder templates create`
@@ -53,6 +61,16 @@ Coder with Docker has the following advantages:
5361
1. If you want to modify the Docker image or template, edit the files in the
5462
previously created `./docker` directory, then run `coder templates push`.
5563

64+
## Troubleshooting
65+
66+
### Docker-based workspace is stuck in "Connecting..."
67+
68+
Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates.md#creating-and-troubleshooting-templates) for more steps.
69+
70+
### Permission denied while trying to connect to the Docker daemon socket
71+
72+
See Docker's official documentation to [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user).
73+
5674
## Next Steps
5775
5876
- [Port-forward](../networking/port-forwarding.md)

0 commit comments

Comments
 (0)