mirror of https://github.com/coder/code-server.git
54 lines
2.7 KiB
Markdown
54 lines
2.7 KiB
Markdown
|
# Generate a self-signed certificate 🔒
|
||
|
|
|
||
|
|
code-server has the ability to secure your connection between client and server using SSL/TSL certificates. By default, the server will start with an unencrypted connection. We recommend Self-signed TLS/SSL certificates for personal of code-server or within an organization.
|
||
|
|
|
||
|
|
This guide will show you how to create a self-signed certificate and start code-server using your certificate/key.
|
||
|
|
|
||
|
|
## TLS / HTTPS
|
||
|
|
|
||
|
|
You can specify any location that you want to save the certificate and key. In this example, we will navigate to the root directory, create a folder called `certs` and cd into it.
|
||
|
|
|
||
|
|
```shell
|
||
|
|
mkdir ~/certs && cd ~/certs
|
||
|
|
```
|
||
|
|
|
||
|
|
If you don't already have a TLS certificate and key, you can generate them with the command below. They will be placed in `~/certs`
|
||
|
|
|
||
|
|
```shell
|
||
|
|
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ~/certs/MyKey.key -out ~/certs/MyCertificate.crt
|
||
|
|
```
|
||
|
|
|
||
|
|
You will be prompted to add some identifying information about your organization
|
||
|
|
```shell
|
||
|
|
You are about to be asked to enter information that will be incorporated
|
||
|
|
into your certificate request.
|
||
|
|
What you are about to enter is what is called a Distinguished Name or a DN.
|
||
|
|
There are quite a few fields but you can leave some blank
|
||
|
|
For some fields there will be a default value,
|
||
|
|
If you enter '.', the field will be left blank.
|
||
|
|
-----
|
||
|
|
Country Name (2 letter code) [AU]:US
|
||
|
|
State or Province Name (full name) [Some-State]:TX
|
||
|
|
Locality Name (eg, city) []:Austin
|
||
|
|
Organization Name (eg, company) [Coder Technologies]:Coder
|
||
|
|
Organizational Unit Name (eg, section) []:Docs
|
||
|
|
Common Name (e.g. server FQDN or YOUR name) []:hostname.example.com
|
||
|
|
Email Address []:admin@example.com
|
||
|
|
```
|
||
|
|
>If you already have a TLS certificate and key, you can simply reference them in the `--cert` and `--cert-key` flags when launching code-server
|
||
|
|
|
||
|
|
|
||
|
|
## Starting code-server with certificate and key
|
||
|
|
|
||
|
|
1. At the end of the path to your binary, add the following flags followed by the path to your certificate and key like so. Then press enter to run code-server.
|
||
|
|
```shell
|
||
|
|
./code-server --cert=~/certs/MyCertificate.crt --cert-key=~/certs/MyKey.key
|
||
|
|
```
|
||
|
|
2. After that you will be running a secure code-server.
|
||
|
|
|
||
|
|
> You will know your connection is secure if the lines `WARN No certificate specified. This could be insecure. WARN Documentation on securing your setup: https://coder.com/docs` no longer appear.
|
||
|
|
|
||
|
|
## Other options
|
||
|
|
|
||
|
|
For larger organizations you may wish to rely on a Certificate Authority as opposed to a self-signed certificate. For more information on generating free and open certificates for your site, please check out EFF's [certbot](https://certbot.eff.org/). Certbot is a cli to generate certificates using [LetsEncrypt](https://letsencrypt.org/).
|