From 8e2d026d99b8338b76ae15bce1cc853769804cb6 Mon Sep 17 00:00:00 2001 From: Michael Brewer Date: Fri, 29 Mar 2024 08:06:32 -0700 Subject: [PATCH] docs: document how to run workspace-proxy as a system service (#12810) * docs: document how to run workspace-proxy as a system service * Update workspace-proxies.md * Update workspace-proxies.md Co-authored-by: Muhammad Atif Ali * docs: fix duplication --------- Co-authored-by: Muhammad Atif Ali --- docs/admin/configure.md | 4 ++-- docs/admin/workspace-proxies.md | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/admin/configure.md b/docs/admin/configure.md index 10f43dabee..8613658ea3 100644 --- a/docs/admin/configure.md +++ b/docs/admin/configure.md @@ -130,8 +130,8 @@ steps: ## System packages -If you've installed Coder via a [system package](../install/index.md) Coder, you -can configure the server by setting the following variables in +If you've installed Coder via a [system package](../install/index.md), you can +configure the server by setting the following variables in `/etc/coder.d/coder.env`: ```env diff --git a/docs/admin/workspace-proxies.md b/docs/admin/workspace-proxies.md index eb7ac7754f..e9ab16dac6 100644 --- a/docs/admin/workspace-proxies.md +++ b/docs/admin/workspace-proxies.md @@ -147,6 +147,28 @@ 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), 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