Skip to content

docs(admin/workspace-proxies): add instructions to run using the Docker image #7915

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 6 commits into from
Jun 9, 2023
Merged

docs(admin/workspace-proxies): add instructions to run using the Docker image #7915

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0d9fe48
docs(admin/workspace-proxies): add instructions to run using the Dock…
matifali Jun 8, 2023
68f0e86
make fmt
matifali Jun 8, 2023
5855abd
add examples commands different Docker cases
matifali Jun 9, 2023
f136975
Apply suggestions from code review
matifali Jun 9, 2023
e0b47eb
Merge branch 'main' into wsproxy-docker-image-docs
matifali Jun 9, 2023
d88a45d
Merge branch 'wsproxy-docker-image-docs' of https://github.com/coder/…
matifali Jun 9, 2023
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: 26 additions & 0 deletions docs/admin/workspace-proxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,32 @@ CODER_TLS_KEY_FILE="<key_file_location>"
coder wsproxy server
```

### Running in Docker

Modify the default entrypoint to run a workspace proxy server instead of a regular Coder server.

#### Docker Compose

Change the provided [`docker-compose.yml`](https://github.com/coder/coder/blob/main/docker-compose.yaml) file to include a custom entrypoint:

```diff
image: ghcr.io/coder/coder:${CODER_VERSION:-latest}
+ entrypoint: /opt/coder wsproxy server
```

#### Docker run

```bash
docker run --rm -it --entrypoint /opt/coder ghcr.io/coder/coder:latest wsproxy server
```

#### Custom Dockerfile

```Dockerfile
FROM ghcr.io/coder/coder:latest
ENTRYPOINT ["/opt/coder", "wsproxy", "server"]
```

### Selecting a proxy

Users can navigate to their account settings to select a workspace proxy. Workspace proxy preferences are cached by the web browser. If a proxy goes offline, the session will fall back to the primary proxy. This could take up to 60 seconds.
Expand Down