Skip to content

docker quickstart: mention tunnel + troubleshooting #4653

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 1 commit into from
Oct 19, 2022
+22 −4
Merged

docker quickstart: mention tunnel + troubleshooting #4653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 22 additions & 4 deletions docs/quickstart/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,26 @@ Coder with Docker has the following advantages:

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

Use the [Coder tunnel](../admin/configure.md#tunnel) for a public URL:

```bash
coder server
```

Or set an [access URL](../admin/configure.md#access-url) to run entirely locally:

```bash
$ coder server
coder server --access-url=http://localhost:3000 --address=:3000
```

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

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

```bash
$ coder templates init
$ cd docker
coder templates init
cd docker
```

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

## Troubleshooting

### Docker-based workspace is stuck in "Connecting..."

Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates.md#creating-and-troubleshooting-templates) for more steps.

### Permission denied while trying to connect to the Docker daemon socket

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).

## Next Steps

- [Port-forward](../networking/port-forwarding.md)
Expand Down