Skip to content

add troubleshooting guide #46

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.

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 1 commit into from
Jul 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 32 additions & 3 deletions deploy-vm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions guides/aws-ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions guides/digitalocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<img src="../img/digitalocean-launch-code-server.gif" alt="DigitalOcean launch code-server" width="800" />

See our [troubleshooting guide](../deploy-vm#troubleshooting) if you are unable to connect after some time.
3 changes: 3 additions & 0 deletions guides/linode.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
<img src="../img/linode-launch-code-server.gif" alt="Linode launch code-server" width="700" />

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.