Add docs about SSL certificate auto-renew
[akkoma] / docs / installation / releases_en.md
index 10d8879afecafb8fceb6410c8388d4ccd21f6463..30fbf51774b20d33b904a6bf82c0baf60e0a0842 100644 (file)
@@ -12,7 +12,7 @@ While in theory OTP releases are possbile to install on any compatible machine,
 
 Paste the following into the shell:
 ```sh
-arch="$(arch)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;exit 1;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;exit 1;fi;echo "$arch$libc_postfix"
+arch="$(uname -m)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;fi;echo "$arch$libc_postfix"
 ```
 
 If your platform is supported the output will contain the flavour string, you will need it later. If not, this just means that we don't build releases for your platform, you can still try installing from source.
@@ -32,8 +32,12 @@ Debian/Ubuntu:
 apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
 ```
 Alpine:
+
+**Warning:** There has been some changes to musl on Alpine 3.10 which need an Elixir rebuild. Since the build machines are running Alpine 3.9 running the builds on 3.10 will likely fail with "dlsym: Resource temporarily unavailable". If you have not updated yet, replace `latest-stable` with `v3.9` in `/etc/apk/repositories`. If you have, try downgrading `musl` to `1.1.20-r3`
 ```sh
-apk add curl unzip ncurses postgresql posqtgresql-contrib nginx certbot
+echo "http://nl.alpinelinux.org/alpine/v3.9/community" >> /etc/apk/repositories
+apk update
+apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
 ```
 
 ## Setup
@@ -47,12 +51,11 @@ apt install postgresql-11-rum
 ```
 Alpine:
 ```sh
-apk install gcc make
+apk add gcc make git postgresql-dev musl-dev
 git clone https://github.com/postgrespro/rum /tmp/rum
 cd /tmp/rum
 make USE_PGXS=1
 make USE_PGXS=1 install
-make USE_PGXS=1 installcheck
 cd
 rm -r /tmp/rum
 ```
@@ -109,25 +112,20 @@ su pleroma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/pleroma/c
 # Create the postgres database
 su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
 
-# If you have installed RUM indexes add
-# `config :pleroma, :database, rum_enabled: true`
-# to the end of /etc/pleroma/config.exs before proceeding
-
 # Create the database schema
-./bin/pleroma_ctl create
-./bin/pleroma_ctl migrate
+su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
 
-# If you have installed RUM indexes also run
-# ./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/
+# If you have installed RUM indexes uncommend and run
+# su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
 
 # Start the instance to verify that everything is working as expected
-./bin/pleroma daemon
+su pleroma -s $SHELL -lc "./bin/pleroma daemon"
 
 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
 sleep 20 && curl http://localhost:4000/api/v1/instance
 
 # Stop the instance
-./bin/pleroma stop
+su pleroma -s $SHELL -lc "./bin/pleroma stop"
 ```
 
 ### Setting up nginx and getting Let's Encrypt SSL certificaties
@@ -142,14 +140,14 @@ certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
 # For Debian/Ubuntu:
 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
 ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
-# For Alpine
+# For Alpine:
 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
 # If your distro does not have either of those you can append
 # `include /etc/nginx/pleroma.conf` to the end of the http section in /etc/nginx/nginx.conf and
 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/pleroma.conf
 
 # Edit the nginx config replacing example.tld with your (sub)domain
-$EDITOR path-to-the-config
+$EDITOR path-to-nginx-config
 
 # Verify that the config is valid
 nginx -t
@@ -157,7 +155,7 @@ nginx -t
 # Start nginx
 # For Debian/Ubuntu:
 systemctl start nginx
-# For Alpine
+# For Alpine:
 rc-service nginx start
 ```
 
@@ -190,5 +188,53 @@ Still doesn't work? Feel free to contact us on [#pleroma on freenode](https://we
 ## Post installation
 
 ### Setting up auto-renew Let's Encrypt certificate
+```sh
+# Create the directory for webroot challenges
+mkdir -p /var/lib/letsencrypt
+
+# Uncomment the webroot method
+$EDITOR path-to-nginx-config
+
+# Verify that the config is valid
+nginx -t
+```
+Debian/Ubuntu:
+```sh
+# Restart nginx
+systemctl restart nginx
+
+# Ensure the webroot menthod and post hook is working
+certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl nginx reload'
+
+# Add it to the daily cron
+echo '#!/bin/sh
+certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook "systemctl reload nginx"
+' > /etc/cron.daily/renew-pleroma-cert
+chmod +x /etc/cron.daily/renew-pleroma-cert
+
+# If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
+run-parts --test /etc/cron.daily
+```
+Alpine:
+```sh
+# Restart nginx
+rc-service nginx restart
+
+# Start the cron daemon and make it start on boot
+rc-service crond start
+rc-update add crond
+
+# Ensure the webroot menthod and post hook is working
+certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
+
+# Add it to the daily cron
+echo '#!/bin/sh
+certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook "rc-service nginx reload"
+' > /etc/periodic/daily/renew-pleroma-cert
+chmod +x /etc/periodic/daily/renew-pleroma-cert
+
+# If everything worked this should output /etc/periodic/daily/renew-pleroma-cert
+run-parts --test /etc/periodic/daily
+```
 ### Running Mix tasks
 ### Updating