diff --git a/docs/administrator_documentation/index.md b/docs/administrator_documentation/index.md index 59db87073..1da9d443f 100644 --- a/docs/administrator_documentation/index.md +++ b/docs/administrator_documentation/index.md @@ -1 +1,7 @@ # Get started + +Follow the guides in this section to set up and administrate your pod. + +```{contents} +:local: +``` diff --git a/docs/administrator_documentation/installation_docs/debian/index.md b/docs/administrator_documentation/installation_docs/debian/index.md index 924a01391..87ce48c2c 100644 --- a/docs/administrator_documentation/installation_docs/debian/index.md +++ b/docs/administrator_documentation/installation_docs/debian/index.md @@ -357,3 +357,30 @@ That's it! You've created your Nginx file. Run the following command to check th ```{code} bash grep '${' /etc/nginx/sites-enabled/funkwhale.conf ``` + +## 10. Set up TLS + +To enable your users to connect to your pod securely, you need to set up {abbr}`TLS (Transport Layer Security)`. To do this, we recommend using the script. + +1. Download and run `acme.sh`. Replace `my@example.com` with your email address. + + ```{code} bash + curl https://get.acme.sh | sh -s email=my@example.com + ``` + +2. Generate a certificate. Replace `example.com` with your Funkwhale pod name. + + ```{code} bash + acme.sh --issue -d example.com -w /home/funkwhale/public_html + ``` + +3. Install the certificate to your Nginx config. Replace `example.com` with your Funkwhale pod name. + + ```{code} bash + acme.sh --install-cert -d example.com \ + --key-file /path/to/keyfile/in/nginx/key.pem \ + --fullchain-file /path/to/fullchain/nginx/cert.pem \ + --reloadcmd "service nginx force-reload" + ``` + +That's it! acme.sh renews your certificate every 60 days, so you don't need to about renewing it.