From e01d65e996f05c315e9c39d8708dc076512dc546 Mon Sep 17 00:00:00 2001 From: Ciaran Ainsworth Date: Sat, 29 Jan 2022 13:50:06 +0100 Subject: [PATCH] Rearrange docs, add TLS instructions to each. --- docs/administrator_documentation/index.md | 4 +++ .../{debian/index.md => debian.md} | 0 .../{docker/index.md => docker.md} | 27 +++++++++++++++++++ .../installation_docs/index.md | 6 ++--- .../index.md => quick_install.md} | 0 5 files changed, 34 insertions(+), 3 deletions(-) rename docs/administrator_documentation/installation_docs/{debian/index.md => debian.md} (100%) rename docs/administrator_documentation/installation_docs/{docker/index.md => docker.md} (86%) rename docs/administrator_documentation/installation_docs/{quick_install/index.md => quick_install.md} (100%) diff --git a/docs/administrator_documentation/index.md b/docs/administrator_documentation/index.md index 1da9d443f..3c2eeec63 100644 --- a/docs/administrator_documentation/index.md +++ b/docs/administrator_documentation/index.md @@ -5,3 +5,7 @@ Follow the guides in this section to set up and administrate your pod. ```{contents} :local: ``` + +## Install Funkwhale on your server + +Funkwhale is self-hosted, meaning you run it on your own server. To set up your own Funkwhale pod, check out [our installation guides](installation_docs/index.md). Choose the installation method that works for you! diff --git a/docs/administrator_documentation/installation_docs/debian/index.md b/docs/administrator_documentation/installation_docs/debian.md similarity index 100% rename from docs/administrator_documentation/installation_docs/debian/index.md rename to docs/administrator_documentation/installation_docs/debian.md diff --git a/docs/administrator_documentation/installation_docs/docker/index.md b/docs/administrator_documentation/installation_docs/docker.md similarity index 86% rename from docs/administrator_documentation/installation_docs/docker/index.md rename to docs/administrator_documentation/installation_docs/docker.md index 591282c60..03e7f85f5 100644 --- a/docs/administrator_documentation/installation_docs/docker/index.md +++ b/docs/administrator_documentation/installation_docs/docker.md @@ -198,3 +198,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 ``` + +## 5. 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. diff --git a/docs/administrator_documentation/installation_docs/index.md b/docs/administrator_documentation/installation_docs/index.md index 8100984cd..3cd906433 100644 --- a/docs/administrator_documentation/installation_docs/index.md +++ b/docs/administrator_documentation/installation_docs/index.md @@ -15,8 +15,8 @@ caption: Choose your installation method maxdepth: 1 --- -quick_install/index -docker/index -debian/index +quick_install +docker +debian ``` diff --git a/docs/administrator_documentation/installation_docs/quick_install/index.md b/docs/administrator_documentation/installation_docs/quick_install.md similarity index 100% rename from docs/administrator_documentation/installation_docs/quick_install/index.md rename to docs/administrator_documentation/installation_docs/quick_install.md