Skip to content

Add Nginx instructions to guide #1867

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 4 commits into from
Jul 21, 2020
Merged
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
23 changes: 23 additions & 0 deletions doc/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,29 @@ To avoid the warnings, you can use [mkcert](https://mkcert.dev) to create a self
trusted by your OS and then pass it into `code-server` via the `cert` and `cert-key` config
fields.

### Nginx reverse proxy

If you prefer to use Nginx instead of Caddy here is a sample config (put e.g. in
`/etc/nginx/sites-enabled/code-server`):

```nginx
server {
listen 80 [::]:80;
server_name your-domain-name-here.com;

location / {
proxy_pass http://127.0.0.1:8080/;
proxy_set_header Host $host;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection upgrade;
proxy_set_header Accept-Encoding gzip;
}
}
```

It's highly recommended to set up a LetsEncrypt certificate and HTTP->HTTPS redirect as well.
In order to do this run `certbot --nginx -d your-domain-name-here.com`.

### Change the password?

Edit the `password` field in the `code-server` config file at `~/.config/code-server/config.yaml`
Expand Down