From caf856c4c6f985bd7fc45de9fc0116985f8c59b2 Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Tue, 13 Jul 2021 09:56:09 -0400 Subject: [PATCH] add troubleshooting steps --- deploy-vm/README.md | 35 ++++++++++++++++++++++++++++++++--- guides/aws-ec2.md | 2 ++ guides/digitalocean.md | 2 ++ guides/linode.md | 3 +++ 4 files changed, 39 insertions(+), 3 deletions(-) diff --git a/deploy-vm/README.md b/deploy-vm/README.md index 3232fea1..71d2a4e3 100644 --- a/deploy-vm/README.md +++ b/deploy-vm/README.md @@ -4,11 +4,40 @@ A simple startup script to run code-server with --link on a VM, designed to run **Coming soon:** One-click templates in popular marketplaces. -## In this repo: +## In this repo - [launch-code-server.sh](./launch-code-server.sh) - Command tested on Ubuntu machines (uses --link) - [launch-linode.sh](./launch-linode.sh) - launch-code-server.sh adapted for Linode -## Other scripts: +## Troubleshooting -- [code-server, CloudFlare, and Caddy](https://github.com/alec-hs/coder-cloudflare-setup): Sets up code-server and configures CloudFlare DNS +- Ensure you have port 80 open on your server's firewall + +- SSH or use the built-in console to connect to your workspace + + 1. Check the code-server status + + ```console + systemctl status code-server@coder + + # if not working: + systemctl restart code-server@coder + ``` + + 1. Ensure journalctl is capturing logs + + ```console + journalctl -u code-server@coder + ``` + + 1. Ensure the HTTP redirect server is working + + ```console + systemctl status coder-cloud-redirect + + # systemctl restart coder-cloud-redirect + ``` + +## Other scripts + +- [code-server, CloudFlare, and Caddy](https://github.com/alec-hs/coder-cloudflare-setup): Sets up code-server and configures CloudFlare DNS diff --git a/guides/aws-ec2.md b/guides/aws-ec2.md index 9ca1c211..f9361abc 100644 --- a/guides/aws-ec2.md +++ b/guides/aws-ec2.md @@ -28,3 +28,5 @@ sudo hostnamectl set-hostname bens-devbox sudo systemctl restart code-server@coder ``` + +See our [troubleshooting guide](../deploy-vm#troubleshooting) if you are unable to connect after some time. diff --git a/guides/digitalocean.md b/guides/digitalocean.md index f19a35b5..3cad2c97 100644 --- a/guides/digitalocean.md +++ b/guides/digitalocean.md @@ -11,3 +11,5 @@ 1. Once your server starts, you can simply navigate to the IP address and get forwarded to a secure version of code-server, which will be proxied behind your GitHub account. For information on how this works, see [code-server --link](https://github.com/cdr/code-server#cloud-program-%EF%B8%8F). DigitalOcean launch code-server + +See our [troubleshooting guide](../deploy-vm#troubleshooting) if you are unable to connect after some time. diff --git a/guides/linode.md b/guides/linode.md index d4aefd4e..8af0a5c0 100644 --- a/guides/linode.md +++ b/guides/linode.md @@ -13,7 +13,10 @@ Linode launch code-server 1. Optional: To change the URL in the address bar from `linode-[xxxx]` to something more descriptive, you just need to change your hostname and restart code-server: + ```sh sudo hostnamectl set-hostname bens-devbox sudo systemctl restart code-server@coder ``` + +See our [troubleshooting guide](../deploy-vm#troubleshooting) if you are unable to connect after some time.