Skip to content

docs: document how to run workspace-proxy as a system service #12810

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
Mar 29, 2024
Merged

docs: document how to run workspace-proxy as a system service #12810

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
471466e
docs: document how to run workspace-proxy as a system service
michaelbrewer Mar 28, 2024
5d2b9fd
Update workspace-proxies.md
michaelbrewer Mar 28, 2024
ff9637c
Update workspace-proxies.md
michaelbrewer Mar 28, 2024
aafc22b
docs: fix duplication
michaelbrewer Mar 28, 2024
f4c670f
Merge branch 'coder:main' into feat/workspace-proxy
michaelbrewer Mar 29, 2024
2c90c4b
`make fmt`
matifali Mar 29, 2024
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
21 changes: 21 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 @@ -147,6 +147,27 @@ and up the deployment's replicas.
coder wsproxy server
```

### Running as a system service

If you've installed Coder via a [system package](../install/index.md) Coder, you
can configure the workspace proxy by settings in `/etc/coder.d/coder-workspace-proxy.env`

To run workspace proxy as a system service on the host:

```bash
# Use systemd to start workspace proxy now and on reboot
sudo systemctl enable --now coder-workspace-proxy

# View the logs to ensure a successful start
journalctl -u coder-workspace-proxy.service -b
```

To restart workspace proxy after applying system changes:

```shell
sudo systemctl restart coder-workspace-proxy
```

### Running in Docker

Modify the default entrypoint to run a workspace proxy server instead of a
Expand Down