Skip to content

Commit 16ebe10

Browse files
authored
docs(admin/workspace-proxies): add instructions to run using the Docker image (#7915)
* docs(admin/workspace-proxies): add instructions to run using the Docker image. * make fmt
1 parent 5396941 commit 16ebe10

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/admin/workspace-proxies.md

+26
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,32 @@ CODER_TLS_KEY_FILE="<key_file_location>"
9090
coder wsproxy server
9191
```
9292

93+
### Running in Docker
94+
95+
Modify the default entrypoint to run a workspace proxy server instead of a regular Coder server.
96+
97+
#### Docker Compose
98+
99+
Change the provided [`docker-compose.yml`](https://github.com/coder/coder/blob/main/docker-compose.yaml) file to include a custom entrypoint:
100+
101+
```diff
102+
image: ghcr.io/coder/coder:${CODER_VERSION:-latest}
103+
+ entrypoint: /opt/coder wsproxy server
104+
```
105+
106+
#### Docker run
107+
108+
```bash
109+
docker run --rm -it --entrypoint /opt/coder ghcr.io/coder/coder:latest wsproxy server
110+
```
111+
112+
#### Custom Dockerfile
113+
114+
```Dockerfile
115+
FROM ghcr.io/coder/coder:latest
116+
ENTRYPOINT ["/opt/coder", "wsproxy", "server"]
117+
```
118+
93119
### Selecting a proxy
94120

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

0 commit comments

Comments
 (0)