From 5c4548d5e74e40e18d8d1ed98ad256568a063370 Mon Sep 17 00:00:00 2001
From: lain <lain@soykaf.club>
Date: Mon, 10 Aug 2020 13:05:13 +0000
Subject: Revert "Merge branch 'issue/1023' into 'develop'"

This reverts merge request !2763
---
 docs/installation/otp_en.md | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/otp_en.md b/docs/installation/otp_en.md
index 338dfa7d0..e4f822d1c 100644
--- a/docs/installation/otp_en.md
+++ b/docs/installation/otp_en.md
@@ -121,9 +121,6 @@ chown -R pleroma /etc/pleroma
 # Run the config generator
 su pleroma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/pleroma/config.exs --output-psql /tmp/setup_db.psql"
 
-# Run the environment file generator.
-su pleroma -s $SHELL -lc "./bin/pleroma_ctl release_env gen"
-
 # Create the postgres database
 su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
 
@@ -134,7 +131,7 @@ su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
 # 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
-su pleroma -s $SHELL -lc "export $(cat /opt/pleroma/config/pleroma.env); ./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
@@ -203,7 +200,6 @@ rc-update add pleroma
 # Copy the service into a proper directory
 cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 
-
 # Start pleroma and enable it on boot
 systemctl start pleroma
 systemctl enable pleroma
@@ -279,3 +275,4 @@ This will create an account withe the username of 'joeuser' with the email addre
 ## Questions
 
 Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.
+
-- 
cgit v1.2.3


From 4d76c0ec8b24d7bc91a9e432a0cf3be17c6c10b5 Mon Sep 17 00:00:00 2001
From: lain <lain@soykaf.club>
Date: Mon, 10 Aug 2020 15:12:45 +0200
Subject: Docs: Add cmake dependency

---
 docs/installation/debian_based_en.md | 3 ++-
 docs/installation/debian_based_jp.md | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/debian_based_en.md b/docs/installation/debian_based_en.md
index 8ae5044b5..60c2f47e5 100644
--- a/docs/installation/debian_based_en.md
+++ b/docs/installation/debian_based_en.md
@@ -12,6 +12,7 @@ This guide will assume you are on Debian Stretch. This guide should also work wi
 * `erlang-nox`
 * `git`
 * `build-essential`
+* `cmake`
 
 #### Optional packages used in this guide
 
@@ -30,7 +31,7 @@ sudo apt full-upgrade
 * Install some of the above mentioned programs:
 
 ```shell
-sudo apt install git build-essential postgresql postgresql-contrib
+sudo apt install git build-essential postgresql postgresql-contrib cmake
 ```
 
 ### Install Elixir and Erlang
diff --git a/docs/installation/debian_based_jp.md b/docs/installation/debian_based_jp.md
index 42e91cda7..c2dd840d3 100644
--- a/docs/installation/debian_based_jp.md
+++ b/docs/installation/debian_based_jp.md
@@ -16,6 +16,7 @@
 - `erlang-nox`
 - `git`
 - `build-essential`
+- `cmake`
 
 #### このガイドで利用している追加パッケージ
 
@@ -32,7 +33,7 @@ sudo apt full-upgrade
 
 * 上記に挙げたパッケージをインストールしておきます。
 ```
-sudo apt install git build-essential postgresql postgresql-contrib
+sudo apt install git build-essential postgresql postgresql-contrib cmake
 ```
 
 
-- 
cgit v1.2.3


From a2f2ba3fbbc9788b16e7d62044756b99fa0c45e1 Mon Sep 17 00:00:00 2001
From: Alibek Omarov <a1ba.omarov@gmail.com>
Date: Mon, 10 Aug 2020 16:24:45 +0300
Subject: docs: add cmake to other installation guides

---
 docs/installation/alpine_linux_en.md | 3 ++-
 docs/installation/arch_linux_en.md   | 3 ++-
 docs/installation/gentoo_en.md       | 3 ++-
 docs/installation/netbsd_en.md       | 1 +
 docs/installation/openbsd_en.md      | 3 ++-
 docs/installation/openbsd_fi.md      | 2 +-
 6 files changed, 10 insertions(+), 5 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/alpine_linux_en.md b/docs/installation/alpine_linux_en.md
index c726d559f..a5683f18c 100644
--- a/docs/installation/alpine_linux_en.md
+++ b/docs/installation/alpine_linux_en.md
@@ -14,6 +14,7 @@ It assumes that you have administrative rights, either as root or a user with [s
 * `erlang-xmerl`
 * `git`
 * Development Tools
+* `cmake`
 
 #### Optional packages used in this guide
 
@@ -39,7 +40,7 @@ sudo apk upgrade
 * Install some tools, which are needed later:
 
 ```shell
-sudo apk add git build-base
+sudo apk add git build-base cmake
 ```
 
 ### Install Elixir and Erlang
diff --git a/docs/installation/arch_linux_en.md b/docs/installation/arch_linux_en.md
index bf9cfb488..7fb69dd60 100644
--- a/docs/installation/arch_linux_en.md
+++ b/docs/installation/arch_linux_en.md
@@ -9,6 +9,7 @@ This guide will assume that you have administrative rights, either as root or a
 * `elixir`
 * `git`
 * `base-devel`
+* `cmake`
 
 #### Optional packages used in this guide
 
@@ -26,7 +27,7 @@ sudo pacman -Syu
 * Install some of the above mentioned programs:
 
 ```shell
-sudo pacman -S git base-devel elixir
+sudo pacman -S git base-devel elixir cmake
 ```
 
 ### Install PostgreSQL
diff --git a/docs/installation/gentoo_en.md b/docs/installation/gentoo_en.md
index 32152aea7..5a676380c 100644
--- a/docs/installation/gentoo_en.md
+++ b/docs/installation/gentoo_en.md
@@ -28,6 +28,7 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * `dev-db/postgresql`
 * `dev-lang/elixir`
 * `dev-vcs/git`
+* `dev-util/cmake`
 
 #### Optional ebuilds used in this guide
 
@@ -46,7 +47,7 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * Emerge all required the required and suggested software in one go:
 
 ```shell
- # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx
+ # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx dev-util/cmake
 ```
 
 If you would not like to install the optional packages, remove them from this line. 
diff --git a/docs/installation/netbsd_en.md b/docs/installation/netbsd_en.md
index 3626acc69..6ad0de2f6 100644
--- a/docs/installation/netbsd_en.md
+++ b/docs/installation/netbsd_en.md
@@ -19,6 +19,7 @@ databases/postgresql11-client
 databases/postgresql11-server
 devel/git-base
 devel/git-docs
+devel/cmake
 lang/elixir
 security/acmesh
 security/sudo
diff --git a/docs/installation/openbsd_en.md b/docs/installation/openbsd_en.md
index 5dbe24f75..eee452845 100644
--- a/docs/installation/openbsd_en.md
+++ b/docs/installation/openbsd_en.md
@@ -14,11 +14,12 @@ The following packages need to be installed:
   * git
   * postgresql-server
   * postgresql-contrib
+  * cmake
 
 To install them, run the following command (with doas or as root):
 
 ```
-pkg_add elixir gmake ImageMagick git postgresql-server postgresql-contrib
+pkg_add elixir gmake ImageMagick git postgresql-server postgresql-contrib cmake
 ```
 
 Pleroma requires a reverse proxy, OpenBSD has relayd in base (and is used in this guide) and packages/ports are available for nginx (www/nginx) and apache (www/apache-httpd). Independently of the reverse proxy, [acme-client(1)](https://man.openbsd.org/acme-client) can be used to get a certificate from Let's Encrypt.
diff --git a/docs/installation/openbsd_fi.md b/docs/installation/openbsd_fi.md
index 272273cff..b5b5056a9 100644
--- a/docs/installation/openbsd_fi.md
+++ b/docs/installation/openbsd_fi.md
@@ -16,7 +16,7 @@ Matrix-kanava #freenode_#pleroma:matrix.org ovat hyviä paikkoja löytää apua
 
 Asenna tarvittava ohjelmisto:
 
-`# pkg_add git elixir gmake postgresql-server-10.3 postgresql-contrib-10.3`
+`# pkg_add git elixir gmake postgresql-server-10.3 postgresql-contrib-10.3 cmake`
 
 Luo postgresql-tietokanta:
 
-- 
cgit v1.2.3


From 07376bd21ae732a00c61ce55be920ddf8ba603ee Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 6 Aug 2020 00:01:57 -0400
Subject: Adding installation documentation for FreeBSD + rc.d script

---
 docs/installation/freebsd_en.md | 201 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 201 insertions(+)
 create mode 100644 docs/installation/freebsd_en.md

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
new file mode 100644
index 000000000..51990c5e4
--- /dev/null
+++ b/docs/installation/freebsd_en.md
@@ -0,0 +1,201 @@
+# Installing on FreeBSD 
+
+This document was written for FreeBSD 12.1, but should be trivially trailerable to future releases.
+Additionally, this guide document can be modified to 
+
+## Required software 
+
+This assumes the target system has `pkg(8)`.
+
+`# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh`
+
+Copy the rc.d scripts to the right directory:
+
+Setup the required services to automatically start at boot, using `sysrc(8)`.
+
+```
+# sysrc nginx_enable=YES
+# sysrc postgresql_enable=YES
+```
+
+## Initialize postgres
+
+```
+# service postgresql initdb
+# service postgresql start
+```
+
+## Configuring Pleroma
+
+Create a user for Pleroma:
+
+```
+# pw add user pleroma -m
+# echo 'export LC_ALL="en_US.UTF-8"' >> /home/pleroma/.profile
+# su -l pleroma
+```
+
+Clone the repository:
+
+```
+$ cd $HOME # Should be the same as /home/pleroma
+$ git clone -b stable https://git.pleroma.social/pleroma/pleroma.git
+```
+
+Configure Pleroma. Note that you need a domain name at this point:
+
+```
+$ cd /home/pleroma/pleroma
+$ mix deps.get
+$ mix pleroma.instance gen # You will be asked a few questions here.
+$ cp config/generated_config.exs config/prod.secret.exs # The default values should be sufficient but you should edit it and check that everything seems OK.
+```
+
+Since Postgres is configured, we can now initialize the database. There should
+now be a file in `config/setup_db.psql` that makes this easier. Edit it, and
+*change the password* to a password of your choice. Make sure it is secure, since
+it'll be protecting your database. As root, you can now initialize the database:
+
+```
+# cd /home/pleroma/pleroma
+# sudo -Hu postgres -g postgres psql -f config/setup_db.psql
+```
+
+Postgres allows connections from all users without a password by default. To
+fix this, edit `/var/db/postgres/data12/pg_hba.conf`. Change every `trust` to
+`password`.
+
+Once this is done, restart Postgres with `# service postgresql restart`.
+
+Run the database migrations.
+
+Back as the pleroma user, you will need to do this whenever you update with `git pull`:
+
+```
+# su -l pleroma
+$ cd /home/pleroma/pleroma
+$ MIX_ENV=prod mix ecto.migrate
+```
+
+## Configuring nginx
+
+Install the example configuration file
+`/home/pleroma/pleroma/installation/pleroma.nginx` to
+`/usr/local/etc/nginx/nginx.conf`.
+
+Note that it will need to be wrapped in a `http {}` block. You should add
+settings for the nginx daemon outside of the http block, for example:
+
+```
+user                    nginx  nginx;
+error_log               /var/log/nginx/error.log;
+worker_processes        4;
+
+events {
+}
+```
+
+Edit the defaults:
+
+* Change `ssl_certificate` and `ssl_trusted_certificate` to
+`/etc/ssl/example.tld/fullchain`.
+* Change `ssl_certificate_key` to `/etc/ssl/example.tld/key`.
+* Change `example.tld` to your instance's domain name.
+
+## Configuring acme.sh
+
+We'll be using acme.sh in Stateless Mode for TLS certificate renewal.
+
+First, get your account fingerprint:
+
+```
+$ sudo -Hu nginx -g nginx acme.sh --register-account
+```
+
+You need to add the following to your nginx configuration for the server
+running on port 80:
+
+```
+  location ~ ^/\.well-known/acme-challenge/([-_a-zA-Z0-9]+)$ {
+    default_type text/plain;
+    return 200 "$1.6fXAG9VyG0IahirPEU2ZerUtItW2DHzDzD9wZaEKpqd";
+  }
+```
+
+Replace the string after after `$1.` with your fingerprint.
+
+Start nginx:
+
+```
+# service nginx start
+```
+
+It should now be possible to issue a cert (replace `example.com`
+with your domain name):
+
+```
+$ sudo -Hu nginx -g nginx acme.sh --issue -d example.com --stateless
+$ acme.sh --install-cert -d example.com \
+	--key-file       /path/to/keyfile/in/nginx/key.pem  \
+	--fullchain-file /path/to/fullchain/nginx/cert.pem \
+```
+
+Let's add auto-renewal to `/etc/daily.local`
+(replace `example.com` with your domain):
+
+```
+/usr/pkg/bin/sudo -Hu nginx -g nginx \
+    /usr/pkg/sbin/acme.sh -r \
+    -d example.com \
+    --cert-file /etc/nginx/tls/cert \
+    --key-file /etc/nginx/tls/key \
+    --ca-file /etc/nginx/tls/ca \
+    --fullchain-file /etc/nginx/tls/fullchain \
+    --stateless
+```
+
+## Creating a startup script for Pleroma
+
+Pleroma will need to compile when it initially starts, which typically takes a longer
+period of time. Therefore, it is good practice to initially run pleroma from the
+command-line before utilizing the rc.d script. That is done as follows:
+
+```
+# su -l pleroma
+$ cd $HOME/pleroma
+$ MIX_ENV=prod mix phx.server
+```
+
+Copy the startup script to the correct location and make sure it's executable:
+
+```
+# cp /home/pleroma/pleroma/installation/freebsd/rc.d/pleroma /usr/local/etc/rc.d/pleroma
+# chmod +x /etc/rc.d/pleroma
+```
+
+Add the following to `/etc/rc.conf`:
+
+```
+pleroma=YES
+pleroma_home="/home/pleroma"
+pleroma_user="pleroma"
+```
+
+Run `# /etc/rc.d/pleroma start` to start Pleroma.
+
+## Conclusion
+
+Restart nginx with `# /etc/rc.d/nginx restart` and you should be up and running.
+
+If you need further help, contact niaa on freenode.
+
+Make sure your time is in sync, or other instances will receive your posts with
+incorrect timestamps. You should have ntpd running.
+
+#### Further reading
+
+{! backend/installation/further_reading.include !}
+
+## Questions
+
+Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.
-- 
cgit v1.2.3


From da5aca27a8c79edcb4577c3a9f05cfa5d0463e83 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 6 Aug 2020 23:24:12 +0000
Subject: Minor reorganization

---
 docs/installation/freebsd_en.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 51990c5e4..c98992fe5 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -69,7 +69,7 @@ Once this is done, restart Postgres with `# service postgresql restart`.
 
 Run the database migrations.
 
-Back as the pleroma user, you will need to do this whenever you update with `git pull`:
+Back as the pleroma user, run the following to implement any database migrations.
 
 ```
 # su -l pleroma
@@ -77,9 +77,11 @@ $ cd /home/pleroma/pleroma
 $ MIX_ENV=prod mix ecto.migrate
 ```
 
+You will need to do this whenever you update with `git pull`:
+
 ## Configuring nginx
 
-Install the example configuration file
+As root, install the example configuration file
 `/home/pleroma/pleroma/installation/pleroma.nginx` to
 `/usr/local/etc/nginx/nginx.conf`.
 
-- 
cgit v1.2.3


From f6686a64afceb775d775e623c847d413fecf65f8 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 6 Aug 2020 23:35:33 +0000
Subject: Updated ssl and domain name updates Removed the reference to niaa

---
 docs/installation/freebsd_en.md | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index c98992fe5..9c5caa4d3 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -97,12 +97,12 @@ events {
 }
 ```
 
-Edit the defaults:
+Edit the defaults of `/usr/local/etc/nginx/nginx.conf`:
 
-* Change `ssl_certificate` and `ssl_trusted_certificate` to
-`/etc/ssl/example.tld/fullchain`.
-* Change `ssl_certificate_key` to `/etc/ssl/example.tld/key`.
-* Change `example.tld` to your instance's domain name.
+* Change `ssl_trusted_certificate` to `/etc/ssl/example.tld/chain.pem`.
+* Change `ssl_certificate` to `/etc/ssl/example.tld/fullchain.pem`.
+* Change `ssl_certificate_key` to `/etc/ssl/example.tld/privkey.pem`.
+* Change all references of `example.tld` to your instance's domain name.
 
 ## Configuring acme.sh
 
@@ -189,8 +189,6 @@ Run `# /etc/rc.d/pleroma start` to start Pleroma.
 
 Restart nginx with `# /etc/rc.d/nginx restart` and you should be up and running.
 
-If you need further help, contact niaa on freenode.
-
 Make sure your time is in sync, or other instances will receive your posts with
 incorrect timestamps. You should have ntpd running.
 
-- 
cgit v1.2.3


From 53c4215ef1d65300ffbf8d47cdb5a713558df528 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Fri, 7 Aug 2020 01:04:33 +0000
Subject: Updated some more instruction specifics.

---
 docs/installation/freebsd_en.md | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 9c5caa4d3..ee42b9427 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -172,18 +172,16 @@ Copy the startup script to the correct location and make sure it's executable:
 
 ```
 # cp /home/pleroma/pleroma/installation/freebsd/rc.d/pleroma /usr/local/etc/rc.d/pleroma
-# chmod +x /etc/rc.d/pleroma
+# chmod +x /usr/local/etc/rc.d/pleroma
 ```
 
-Add the following to `/etc/rc.conf`:
+Update the `/etc/rc.conf` file with the following command:
 
 ```
-pleroma=YES
-pleroma_home="/home/pleroma"
-pleroma_user="pleroma"
+# sysrc pleroma_enable=YES
 ```
 
-Run `# /etc/rc.d/pleroma start` to start Pleroma.
+Now you can start pleroma with `# service pleroma start`.
 
 ## Conclusion
 
-- 
cgit v1.2.3


From 33ea430f3b026f4e9b353b74bcc60846c67a5a69 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Fri, 7 Aug 2020 01:52:39 +0000
Subject: acme.sh and netbsd to freebsd updates

---
 docs/installation/freebsd_en.md | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index ee42b9427..b5c62bee6 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -146,8 +146,8 @@ Let's add auto-renewal to `/etc/daily.local`
 (replace `example.com` with your domain):
 
 ```
-/usr/pkg/bin/sudo -Hu nginx -g nginx \
-    /usr/pkg/sbin/acme.sh -r \
+/usr/pkg/bin/sudo -Hu www -g www \
+    /usr/local/sbin/acme.sh -r \
     -d example.com \
     --cert-file /etc/nginx/tls/cert \
     --key-file /etc/nginx/tls/key \
@@ -175,25 +175,22 @@ Copy the startup script to the correct location and make sure it's executable:
 # chmod +x /usr/local/etc/rc.d/pleroma
 ```
 
-Update the `/etc/rc.conf` file with the following command:
+Update the `/etc/rc.conf` and start pleroma with the following commands:
 
 ```
 # sysrc pleroma_enable=YES
+# service pleroma start
 ```
 
 Now you can start pleroma with `# service pleroma start`.
 
 ## Conclusion
 
-Restart nginx with `# /etc/rc.d/nginx restart` and you should be up and running.
+Restart nginx with `# service nginx restart` and you should be up and running.
 
 Make sure your time is in sync, or other instances will receive your posts with
 incorrect timestamps. You should have ntpd running.
 
-#### Further reading
-
-{! backend/installation/further_reading.include !}
-
 ## Questions
 
 Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.
-- 
cgit v1.2.3


From b5f48275c5a0802ac5e7da0caf3d3af0bfbb7c6c Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 13 Aug 2020 19:08:13 -0400
Subject: Minor patch update

---
 docs/installation/freebsd_en.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index b5c62bee6..12c870322 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -108,10 +108,10 @@ Edit the defaults of `/usr/local/etc/nginx/nginx.conf`:
 
 We'll be using acme.sh in Stateless Mode for TLS certificate renewal.
 
-First, get your account fingerprint:
+First, as root, get your account fingerprint:
 
 ```
-$ sudo -Hu nginx -g nginx acme.sh --register-account
+# sudo -Hu acme -g acme acme.sh --register-account
 ```
 
 You need to add the following to your nginx configuration for the server
@@ -136,7 +136,7 @@ It should now be possible to issue a cert (replace `example.com`
 with your domain name):
 
 ```
-$ sudo -Hu nginx -g nginx acme.sh --issue -d example.com --stateless
+$ sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
 $ acme.sh --install-cert -d example.com \
 	--key-file       /path/to/keyfile/in/nginx/key.pem  \
 	--fullchain-file /path/to/fullchain/nginx/cert.pem \
@@ -146,7 +146,7 @@ Let's add auto-renewal to `/etc/daily.local`
 (replace `example.com` with your domain):
 
 ```
-/usr/pkg/bin/sudo -Hu www -g www \
+/usr/local/bin/sudo -Hu acme -g acme \
     /usr/local/sbin/acme.sh -r \
     -d example.com \
     --cert-file /etc/nginx/tls/cert \
-- 
cgit v1.2.3


From cba9f368af13768f7c0161074ab3f25deae5b5a6 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 13 Aug 2020 19:34:04 -0400
Subject: Added comment

---
 docs/installation/freebsd_en.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 12c870322..38afd76e4 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -46,7 +46,7 @@ Configure Pleroma. Note that you need a domain name at this point:
 
 ```
 $ cd /home/pleroma/pleroma
-$ mix deps.get
+$ mix deps.get # Enter "y" when asked to install Hex
 $ mix pleroma.instance gen # You will be asked a few questions here.
 $ cp config/generated_config.exs config/prod.secret.exs # The default values should be sufficient but you should edit it and check that everything seems OK.
 ```
-- 
cgit v1.2.3


From 24eb917dbc752a81716699ebd23ad9ff9cbd6a24 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 13 Aug 2020 20:58:46 -0400
Subject: Rearranging acme

---
 docs/installation/freebsd_en.md | 63 +++++++++++++++++++++++++----------------
 1 file changed, 39 insertions(+), 24 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 38afd76e4..a8741e565 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -79,36 +79,19 @@ $ MIX_ENV=prod mix ecto.migrate
 
 You will need to do this whenever you update with `git pull`:
 
-## Configuring nginx
+## Configuring acme.sh
 
-As root, install the example configuration file
-`/home/pleroma/pleroma/installation/pleroma.nginx` to
-`/usr/local/etc/nginx/nginx.conf`.
+We'll be using acme.sh in Stateless Mode for TLS certificate renewal.
 
-Note that it will need to be wrapped in a `http {}` block. You should add
-settings for the nginx daemon outside of the http block, for example:
+First, as root, allow the user `acme` to have access to the acme log file, as follows:
 
 ```
-user                    nginx  nginx;
-error_log               /var/log/nginx/error.log;
-worker_processes        4;
-
-events {
-}
+# touch /var/log/acme.sh.log
+# chown acme:acme /var/log/acme.sh.log
+# chmod 600 /var/log/acme.sh.log
 ```
 
-Edit the defaults of `/usr/local/etc/nginx/nginx.conf`:
-
-* Change `ssl_trusted_certificate` to `/etc/ssl/example.tld/chain.pem`.
-* Change `ssl_certificate` to `/etc/ssl/example.tld/fullchain.pem`.
-* Change `ssl_certificate_key` to `/etc/ssl/example.tld/privkey.pem`.
-* Change all references of `example.tld` to your instance's domain name.
-
-## Configuring acme.sh
-
-We'll be using acme.sh in Stateless Mode for TLS certificate renewal.
-
-First, as root, get your account fingerprint:
+Next, obtain your account fingerprint:
 
 ```
 # sudo -Hu acme -g acme acme.sh --register-account
@@ -156,6 +139,38 @@ Let's add auto-renewal to `/etc/daily.local`
     --stateless
 ```
 
+### Configuring nginx
+
+FreeBSD's default nginx configuration does not contain an include directive, which is
+typically used for multiple sites. Therefore, you will need to first create the required
+directory as follows:
+
+
+```
+# mkdir -p /usr/local/etc/nginx/sites-available
+```
+
+Next, add an `include` directive to `/usr/local/etc/nginx/nginx.conf`, within the `http {}`
+block, as follows:
+
+
+```
+http {
+...
+	include /usr/local/etc/nginx/sites-available/*.conf;
+}
+```
+
+As root, copy `/home/pleroma/pleroma/installation/pleroma.nginx` to
+`/usr/local/etc/nginx/sites-available/pleroma.conf`.
+
+Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.conf`:
+
+* Change `ssl_trusted_certificate` to `/etc/ssl/example.tld/chain.pem`.
+* Change `ssl_certificate` to `/etc/ssl/example.tld/fullchain.pem`.
+* Change `ssl_certificate_key` to `/etc/ssl/example.tld/privkey.pem`.
+* Change all references of `example.tld` to your instance's domain name.
+
 ## Creating a startup script for Pleroma
 
 Pleroma will need to compile when it initially starts, which typically takes a longer
-- 
cgit v1.2.3


From f2665547f59a7043cf8bac9d39c56a9b717d5099 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 13 Aug 2020 21:24:08 -0400
Subject: acme updates

---
 docs/installation/freebsd_en.md | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index a8741e565..386a0ae10 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -119,10 +119,11 @@ It should now be possible to issue a cert (replace `example.com`
 with your domain name):
 
 ```
-$ sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
-$ acme.sh --install-cert -d example.com \
-	--key-file       /path/to/keyfile/in/nginx/key.pem  \
-	--fullchain-file /path/to/fullchain/nginx/cert.pem \
+# mkdir -p /etc/ssl/example.com
+# sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
+# acme.sh --home /var/db/acme/.acme.sh/ --install-cert -d example.com \
+	--key-file /etc/ssl/example.com/key.pem
+	--fullchain-file /etc/ssl/example.com/fullchain.pem
 ```
 
 Let's add auto-renewal to `/etc/daily.local`
-- 
cgit v1.2.3


From b0c456d18d3b4e20233a7dbaef3c55d0586a1946 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 13 Aug 2020 22:18:33 -0400
Subject: more acme.sh updates

---
 docs/installation/freebsd_en.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 386a0ae10..458b8032d 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -122,22 +122,22 @@ with your domain name):
 # mkdir -p /etc/ssl/example.com
 # sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
 # acme.sh --home /var/db/acme/.acme.sh/ --install-cert -d example.com \
-	--key-file /etc/ssl/example.com/key.pem
+	--ca-file /etc/ssl/example.com/ca.pem \
+	--key-file /etc/ssl/example.com/key.pem \
+	--cert-file /etc/ssl/example.com/cert.pem \
 	--fullchain-file /etc/ssl/example.com/fullchain.pem
 ```
 
-Let's add auto-renewal to `/etc/daily.local`
+Let's add auto-renewal to `/etc/crontab`
 (replace `example.com` with your domain):
 
 ```
-/usr/local/bin/sudo -Hu acme -g acme \
-    /usr/local/sbin/acme.sh -r \
-    -d example.com \
-    --cert-file /etc/nginx/tls/cert \
-    --key-file /etc/nginx/tls/key \
-    --ca-file /etc/nginx/tls/ca \
-    --fullchain-file /etc/nginx/tls/fullchain \
-    --stateless
+/usr/local/bin/sudo -Hu acme -g acme /usr/local/sbin/acme.sh -r -d example.com --stateless
+/usr/local/sbin/acme.sh --home /var/db/acme/.acme.sh/ --install-cert -d example.com \
+	--ca-file /etc/ssl/example.com/ca.pem \
+	--key-file /etc/ssl/example.com/key.pem \
+	--cert-file /etc/ssl/test-app.mailchar.com/cert.pem \
+	--fullchain-file /etc/ssl/example.com/fullchain.pem
 ```
 
 ### Configuring nginx
-- 
cgit v1.2.3


From 816c04abdc2e8045f3fa52071b953c5ac608d0bd Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 13 Aug 2020 22:38:23 -0400
Subject: Updates

---
 docs/installation/freebsd_en.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 458b8032d..f1e06892c 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -123,8 +123,8 @@ with your domain name):
 # sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
 # acme.sh --home /var/db/acme/.acme.sh/ --install-cert -d example.com \
 	--ca-file /etc/ssl/example.com/ca.pem \
-	--key-file /etc/ssl/example.com/key.pem \
-	--cert-file /etc/ssl/example.com/cert.pem \
+	--key-file /etc/ssl/example.com/privkey.pem \
+	--cert-file /etc/ssl/example.com/chain.pem \
 	--fullchain-file /etc/ssl/example.com/fullchain.pem
 ```
 
@@ -135,8 +135,8 @@ Let's add auto-renewal to `/etc/crontab`
 /usr/local/bin/sudo -Hu acme -g acme /usr/local/sbin/acme.sh -r -d example.com --stateless
 /usr/local/sbin/acme.sh --home /var/db/acme/.acme.sh/ --install-cert -d example.com \
 	--ca-file /etc/ssl/example.com/ca.pem \
-	--key-file /etc/ssl/example.com/key.pem \
-	--cert-file /etc/ssl/test-app.mailchar.com/cert.pem \
+	--key-file /etc/ssl/example.com/privkey.pem \
+	--cert-file /etc/ssl/example.com/chain.pem \
 	--fullchain-file /etc/ssl/example.com/fullchain.pem
 ```
 
@@ -158,7 +158,7 @@ block, as follows:
 ```
 http {
 ...
-	include /usr/local/etc/nginx/sites-available/*.conf;
+	include /usr/local/etc/nginx/sites-available/*;
 }
 ```
 
-- 
cgit v1.2.3


From a5144f05c2245c5043f2469955e8960b5d80b48e Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Thu, 13 Aug 2020 22:49:50 -0400
Subject: Removed a trailing comment

---
 docs/installation/freebsd_en.md | 2 --
 1 file changed, 2 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index f1e06892c..ce0cdead6 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -198,8 +198,6 @@ Update the `/etc/rc.conf` and start pleroma with the following commands:
 # service pleroma start
 ```
 
-Now you can start pleroma with `# service pleroma start`.
-
 ## Conclusion
 
 Restart nginx with `# service nginx restart` and you should be up and running.
-- 
cgit v1.2.3


From e8c20c42cd02cc4dcbcb420cec98f68951a1609d Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Fri, 14 Aug 2020 00:21:42 -0400
Subject: minor changes

---
 docs/installation/freebsd_en.md | 42 ++++++++++++++++++++---------------------
 1 file changed, 21 insertions(+), 21 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index ce0cdead6..130d68766 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -1,13 +1,14 @@
 # Installing on FreeBSD 
 
-This document was written for FreeBSD 12.1, but should be trivially trailerable to future releases.
-Additionally, this guide document can be modified to 
+This document was written for FreeBSD 12.1, but should be work on future releases.
 
 ## Required software 
 
 This assumes the target system has `pkg(8)`.
 
-`# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh`
+```
+# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh
+```
 
 Copy the rc.d scripts to the right directory:
 
@@ -48,7 +49,7 @@ Configure Pleroma. Note that you need a domain name at this point:
 $ cd /home/pleroma/pleroma
 $ mix deps.get # Enter "y" when asked to install Hex
 $ mix pleroma.instance gen # You will be asked a few questions here.
-$ cp config/generated_config.exs config/prod.secret.exs # The default values should be sufficient but you should edit it and check that everything seems OK.
+$ cp config/generated_config.exs config/prod.secret.exs
 ```
 
 Since Postgres is configured, we can now initialize the database. There should
@@ -65,7 +66,10 @@ Postgres allows connections from all users without a password by default. To
 fix this, edit `/var/db/postgres/data12/pg_hba.conf`. Change every `trust` to
 `password`.
 
-Once this is done, restart Postgres with `# service postgresql restart`.
+Once this is done, restart Postgres with:
+```
+# service postgresql restart
+```
 
 Run the database migrations.
 
@@ -119,13 +123,7 @@ It should now be possible to issue a cert (replace `example.com`
 with your domain name):
 
 ```
-# mkdir -p /etc/ssl/example.com
 # sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
-# acme.sh --home /var/db/acme/.acme.sh/ --install-cert -d example.com \
-	--ca-file /etc/ssl/example.com/ca.pem \
-	--key-file /etc/ssl/example.com/privkey.pem \
-	--cert-file /etc/ssl/example.com/chain.pem \
-	--fullchain-file /etc/ssl/example.com/fullchain.pem
 ```
 
 Let's add auto-renewal to `/etc/crontab`
@@ -133,11 +131,6 @@ Let's add auto-renewal to `/etc/crontab`
 
 ```
 /usr/local/bin/sudo -Hu acme -g acme /usr/local/sbin/acme.sh -r -d example.com --stateless
-/usr/local/sbin/acme.sh --home /var/db/acme/.acme.sh/ --install-cert -d example.com \
-	--ca-file /etc/ssl/example.com/ca.pem \
-	--key-file /etc/ssl/example.com/privkey.pem \
-	--cert-file /etc/ssl/example.com/chain.pem \
-	--fullchain-file /etc/ssl/example.com/fullchain.pem
 ```
 
 ### Configuring nginx
@@ -163,13 +156,13 @@ http {
 ```
 
 As root, copy `/home/pleroma/pleroma/installation/pleroma.nginx` to
-`/usr/local/etc/nginx/sites-available/pleroma.conf`.
+`/usr/local/etc/nginx/sites-available/pleroma.nginx`.
 
-Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.conf`:
+Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.nginx`:
 
-* Change `ssl_trusted_certificate` to `/etc/ssl/example.tld/chain.pem`.
-* Change `ssl_certificate` to `/etc/ssl/example.tld/fullchain.pem`.
-* Change `ssl_certificate_key` to `/etc/ssl/example.tld/privkey.pem`.
+* Change `ssl_trusted_certificate` to `/var/db/acme/certs/example.tld/example.tld.cer`.
+* Change `ssl_certificate` to `/var/db/acme/certs/example.tld/fullchain.cer`.
+* Change `ssl_certificate_key` to `/var/db/acme/certs/example.tld/example.tld.key`.
 * Change all references of `example.tld` to your instance's domain name.
 
 ## Creating a startup script for Pleroma
@@ -198,6 +191,13 @@ Update the `/etc/rc.conf` and start pleroma with the following commands:
 # service pleroma start
 ```
 
+#### Create your first user
+
+If your instance is up and running, you can create your first user with administrative rights with the following task:
+
+```shell
+sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
+```
 ## Conclusion
 
 Restart nginx with `# service nginx restart` and you should be up and running.
-- 
cgit v1.2.3


From 4fcf272717bf2d8f582720de69fa9e50cab1b66a Mon Sep 17 00:00:00 2001
From: rinpatch <rinpatch@sdf.org>
Date: Sat, 15 Aug 2020 09:49:12 +0300
Subject: Docs: Fix the way tabs are declared

Since python doesn't have a way to lock deps for a particlar project
by default, I didn't bother with it. This resulted in mkdocs updating at
some point, bringing a breaking change to how tabs are declared and
broken tabs on docs-develop.pleroma.social. I've learned my lesson
and locked deps with pipenv in pleroma/docs!5. This MR updates Pleroma
docs to use the new tab style, fortunately my editor did most of it.

Closes #2045
---
 docs/installation/migrating_from_source_otp_en.md |  48 +++---
 docs/installation/otp_en.md                       | 200 ++++++++++++----------
 2 files changed, 133 insertions(+), 115 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/migrating_from_source_otp_en.md b/docs/installation/migrating_from_source_otp_en.md
index 31c2f1294..d303a6daf 100644
--- a/docs/installation/migrating_from_source_otp_en.md
+++ b/docs/installation/migrating_from_source_otp_en.md
@@ -8,13 +8,15 @@ You will be running commands as root. If you aren't root already, please elevate
 
 The system needs to have `curl` and `unzip` installed for downloading and unpacking release builds.
 
-```sh tab="Alpine"
-apk add curl unzip
-```
+=== "Alpine"
+    ```sh
+    apk add curl unzip
+    ```
 
-```sh tab="Debian/Ubuntu"
-apt install curl unzip
-```
+=== "Debian/Ubuntu"
+    ```sh
+    apt install curl unzip
+    ```
 
 ## Moving content out of the application directory
 When using OTP releases the application directory changes with every version so it would be a bother to keep content there (and also dangerous unless `--no-rm` option is used when updating). Fortunately almost all paths in Pleroma are configurable, so it is possible to move them out of there.
@@ -110,27 +112,29 @@ OTP releases have different service files than from-source installs so they need
 
 **Warning:** The service files assume pleroma user's home directory is `/opt/pleroma`, please make sure all paths fit your installation.
 
-```sh tab="Alpine"
-# Copy the service into a proper directory
-cp -f ~pleroma/installation/init.d/pleroma /etc/init.d/pleroma
+=== "Alpine"
+    ```sh
+    # Copy the service into a proper directory
+    cp -f ~pleroma/installation/init.d/pleroma /etc/init.d/pleroma
 
-# Start pleroma
-rc-service pleroma start
-```
+    # Start pleroma
+    rc-service pleroma start
+    ```
 
-```sh tab="Debian/Ubuntu"
-# Copy the service into a proper directory
-cp ~pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
+=== "Debian/Ubuntu"
+    ```sh
+    # Copy the service into a proper directory
+    cp ~pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 
-# Reload service files
-systemctl daemon-reload
+    # Reload service files
+    systemctl daemon-reload
 
-# Reenable pleroma to start on boot
-systemctl reenable pleroma
+    # Reenable pleroma to start on boot
+    systemctl reenable pleroma
 
-# Start pleroma
-systemctl start pleroma
-```
+    # Start pleroma
+    systemctl start pleroma
+    ```
 
 ## Running mix tasks
 Refer to [Running mix tasks](otp_en.md#running-mix-tasks) section from OTP release installation guide.
diff --git a/docs/installation/otp_en.md b/docs/installation/otp_en.md
index e4f822d1c..b7e3bb2ac 100644
--- a/docs/installation/otp_en.md
+++ b/docs/installation/otp_en.md
@@ -28,15 +28,17 @@ Other than things bundled in the OTP release Pleroma depends on:
 * nginx (could be swapped with another reverse proxy but this guide covers only it)
 * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
 
-```sh tab="Alpine"
-echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
-apk update
-apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
-```
-
-```sh tab="Debian/Ubuntu"
-apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
-```
+=== "Alpine"
+    ```
+    echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
+    apk update
+    apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
+    ```
+
+=== "Debian/Ubuntu"
+    ```
+    apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
+    ```
 
 ## Setup
 ### Configuring PostgreSQL
@@ -47,31 +49,35 @@ apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
 
 RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. You can read more about them on the [Configuration page](../configuration/cheatsheet.md#rum-indexing-for-full-text-search). They are completely optional and most of the time are not worth it, especially if you are running a single user instance (unless you absolutely need ordered search results).
 
-```sh tab="Alpine"
-apk add git build-base postgresql-dev
-git clone https://github.com/postgrespro/rum /tmp/rum
-cd /tmp/rum
-make USE_PGXS=1
-make USE_PGXS=1 install
-cd
-rm -r /tmp/rum
-```
-
-```sh tab="Debian/Ubuntu"
-# Available only on Buster/19.04
-apt install postgresql-11-rum
-```
+=== "Alpine"
+    ```
+    apk add git build-base postgresql-dev
+    git clone https://github.com/postgrespro/rum /tmp/rum
+    cd /tmp/rum
+    make USE_PGXS=1
+    make USE_PGXS=1 install
+    cd
+    rm -r /tmp/rum
+    ```
+
+=== "Debian/Ubuntu"
+    ```
+    # Available only on Buster/19.04
+    apt install postgresql-11-rum
+    ```
 
 #### (Optional) Performance configuration
 It is encouraged to check [Optimizing your PostgreSQL performance](../configuration/postgresql.md) document, for tips on PostgreSQL tuning.
 
-```sh tab="Alpine"
-rc-service postgresql restart
-```
+=== "Alpine"
+    ```
+    rc-service postgresql restart
+    ```
 
-```sh tab="Debian/Ubuntu"
-systemctl restart postgresql
-```
+=== "Debian/Ubuntu"
+    ```
+    systemctl restart postgresql
+    ```
 
 If you are using PostgreSQL 12 or higher, add this to your Ecto database configuration
 
@@ -151,14 +157,16 @@ certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
 
 The location of nginx configs is dependent on the distro
 
-```sh tab="Alpine"
-cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
-```
+=== "Alpine"
+    ```
+    cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
+    ```
 
-```sh tab="Debian/Ubuntu"
-cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.conf
-ln -s /etc/nginx/sites-available/pleroma.conf /etc/nginx/sites-enabled/pleroma.conf
-```
+=== "Debian/Ubuntu"
+    ```
+    cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.conf
+    ln -s /etc/nginx/sites-available/pleroma.conf /etc/nginx/sites-enabled/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
 ```sh
@@ -175,35 +183,39 @@ nginx -t
 ```
 #### Start nginx
 
-```sh tab="Alpine"
-rc-service nginx start
-```
+=== "Alpine"
+    ```
+    rc-service nginx start
+    ```
 
-```sh tab="Debian/Ubuntu"
-systemctl start nginx
-```
+=== "Debian/Ubuntu"
+    ```
+    systemctl start nginx
+    ```
 
 At this point if you open your (sub)domain in a browser you should see a 502 error, that's because Pleroma is not started yet.
 
 ### Setting up a system service
 
-```sh tab="Alpine"
-# Copy the service into a proper directory
-cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
+=== "Alpine"
+    ```
+    # Copy the service into a proper directory
+    cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
 
-# Start pleroma and enable it on boot
-rc-service pleroma start
-rc-update add pleroma
-```
+    # Start pleroma and enable it on boot
+    rc-service pleroma start
+    rc-update add pleroma
+    ```
 
-```sh tab="Debian/Ubuntu"
-# Copy the service into a proper directory
-cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
+=== "Debian/Ubuntu"
+    ```
+    # Copy the service into a proper directory
+    cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 
-# Start pleroma and enable it on boot
-systemctl start pleroma
-systemctl enable pleroma
-```
+    # Start pleroma and enable it on boot
+    systemctl start pleroma
+    systemctl enable pleroma
+    ```
 
 If everything worked, you should see Pleroma-FE when visiting your domain. If that didn't happen, try reviewing the installation steps, starting Pleroma in the foreground and seeing if there are any errrors.
 
@@ -223,43 +235,45 @@ $EDITOR path-to-nginx-config
 nginx -t
 ```
 
-```sh tab="Alpine"
-# 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/ --post-hook "rc-service nginx reload"
-' > /etc/periodic/daily/renew-pleroma-cert
-chmod +x /etc/periodic/daily/renew-pleroma-cert
-
-# If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
-run-parts --test /etc/periodic/daily
-```
-
-```sh tab="Debian/Ubuntu"
-# 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 reload nginx'
-
-# Add it to the daily cron
-echo '#!/bin/sh
-certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --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"
+    ```
+    # 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/ --post-hook "rc-service nginx reload"
+    ' > /etc/periodic/daily/renew-pleroma-cert
+    chmod +x /etc/periodic/daily/renew-pleroma-cert
+
+    # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
+    run-parts --test /etc/periodic/daily
+    ```
+
+=== "Debian/Ubuntu"
+    ```
+    # 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 reload nginx'
+
+    # Add it to the daily cron
+    echo '#!/bin/sh
+    certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --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
+    ```
 
 ## Create your first user and set as admin
 ```sh
-- 
cgit v1.2.3


From 173b04df48abf1b40aa0aa4ba5de50c370687f56 Mon Sep 17 00:00:00 2001
From: Farhan Khan <farhan@farhan.codes>
Date: Fri, 4 Sep 2020 18:03:58 +0000
Subject: Added cmake

---
 docs/installation/freebsd_en.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/installation')

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 130d68766..ca2575d9b 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -7,7 +7,7 @@ This document was written for FreeBSD 12.1, but should be work on future release
 This assumes the target system has `pkg(8)`.
 
 ```
-# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh
+# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake
 ```
 
 Copy the rc.d scripts to the right directory:
-- 
cgit v1.2.3


From 7cd662f18c202ee2b099305e990d15a01370d6f9 Mon Sep 17 00:00:00 2001
From: Ivan Tashkinov <ivantashkinov@gmail.com>
Date: Thu, 24 Sep 2020 18:02:50 +0300
Subject: Added documentation on installation of `ffmpeg` and `ImageMagick`
 dependencies.

---
 docs/installation/alpine_linux_en.md | 9 +++++++++
 docs/installation/arch_linux_en.md   | 4 +++-
 docs/installation/debian_based_en.md | 4 +++-
 docs/installation/debian_based_jp.md | 4 +++-
 docs/installation/freebsd_en.md      | 2 +-
 docs/installation/gentoo_en.md       | 4 +++-
 docs/installation/netbsd_en.md       | 2 +-
 docs/installation/openbsd_en.md      | 5 +++--
 docs/installation/openbsd_fi.md      | 2 +-
 docs/installation/otp_en.md          | 6 ++++--
 10 files changed, 31 insertions(+), 11 deletions(-)

(limited to 'docs/installation')

diff --git a/docs/installation/alpine_linux_en.md b/docs/installation/alpine_linux_en.md
index a5683f18c..0b9f5cdae 100644
--- a/docs/installation/alpine_linux_en.md
+++ b/docs/installation/alpine_linux_en.md
@@ -13,6 +13,8 @@ It assumes that you have administrative rights, either as root or a user with [s
 * `erlang-parsetools`
 * `erlang-xmerl`
 * `git`
+* `ffmpeg`
+* `ImageMagick`
 * Development Tools
 * `cmake`
 
@@ -56,6 +58,13 @@ sudo apk add erlang erlang-runtime-tools erlang-xmerl elixir
 ```shell
 sudo apk add erlang-eldap
 ```
+
+### Install ffmpeg and ImageMagick
+
+```shell
+sudo apk add ffmpeg imagemagick
+```
+
 ### Install PostgreSQL
 
 * Install Postgresql server:
diff --git a/docs/installation/arch_linux_en.md b/docs/installation/arch_linux_en.md
index 7fb69dd60..38bb82432 100644
--- a/docs/installation/arch_linux_en.md
+++ b/docs/installation/arch_linux_en.md
@@ -10,6 +10,8 @@ This guide will assume that you have administrative rights, either as root or a
 * `git`
 * `base-devel`
 * `cmake`
+* `ffmpeg`
+* `ImageMagick`
 
 #### Optional packages used in this guide
 
@@ -27,7 +29,7 @@ sudo pacman -Syu
 * Install some of the above mentioned programs:
 
 ```shell
-sudo pacman -S git base-devel elixir cmake
+sudo pacman -S git base-devel elixir cmake ffmpeg imagemagick
 ```
 
 ### Install PostgreSQL
diff --git a/docs/installation/debian_based_en.md b/docs/installation/debian_based_en.md
index 60c2f47e5..30ee64c01 100644
--- a/docs/installation/debian_based_en.md
+++ b/docs/installation/debian_based_en.md
@@ -13,6 +13,8 @@ This guide will assume you are on Debian Stretch. This guide should also work wi
 * `git`
 * `build-essential`
 * `cmake`
+* `ffmpeg`
+* `ImageMagick`
 
 #### Optional packages used in this guide
 
@@ -31,7 +33,7 @@ sudo apt full-upgrade
 * Install some of the above mentioned programs:
 
 ```shell
-sudo apt install git build-essential postgresql postgresql-contrib cmake
+sudo apt install git build-essential postgresql postgresql-contrib cmake ffmpeg imagemagick
 ```
 
 ### Install Elixir and Erlang
diff --git a/docs/installation/debian_based_jp.md b/docs/installation/debian_based_jp.md
index c2dd840d3..219f40525 100644
--- a/docs/installation/debian_based_jp.md
+++ b/docs/installation/debian_based_jp.md
@@ -17,6 +17,8 @@
 - `git`
 - `build-essential`
 - `cmake`
+- `ffmpeg`
+- `ImageMagick`
 
 #### このガイドで利用している追加パッケージ
 
@@ -33,7 +35,7 @@ sudo apt full-upgrade
 
 * 上記に挙げたパッケージをインストールしておきます。
 ```
-sudo apt install git build-essential postgresql postgresql-contrib cmake
+sudo apt install git build-essential postgresql postgresql-contrib cmake ffmpeg imagemagick
 ```
 
 
diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index ca2575d9b..01b410a46 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -7,7 +7,7 @@ This document was written for FreeBSD 12.1, but should be work on future release
 This assumes the target system has `pkg(8)`.
 
 ```
-# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake
+# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake ffmpeg imagemagick
 ```
 
 Copy the rc.d scripts to the right directory:
diff --git a/docs/installation/gentoo_en.md b/docs/installation/gentoo_en.md
index 5a676380c..9a8b54ece 100644
--- a/docs/installation/gentoo_en.md
+++ b/docs/installation/gentoo_en.md
@@ -29,6 +29,8 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * `dev-lang/elixir`
 * `dev-vcs/git`
 * `dev-util/cmake`
+* `media-video/ffmpeg`
+* `media-gfx/imagemagick`
 
 #### Optional ebuilds used in this guide
 
@@ -47,7 +49,7 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * Emerge all required the required and suggested software in one go:
 
 ```shell
- # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx dev-util/cmake
+ # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx dev-util/cmake media-video/ffmpeg media-gfx/imagemagick
 ```
 
 If you would not like to install the optional packages, remove them from this line. 
diff --git a/docs/installation/netbsd_en.md b/docs/installation/netbsd_en.md
index 6ad0de2f6..8cf2e4682 100644
--- a/docs/installation/netbsd_en.md
+++ b/docs/installation/netbsd_en.md
@@ -10,7 +10,7 @@ Pleroma uses.
 
 The `mksh` shell is needed to run the Elixir `mix` script.
 
-`# pkgin install acmesh elixir git-base git-docs mksh nginx postgresql11-server postgresql11-client postgresql11-contrib sudo`
+`# pkgin install acmesh elixir git-base git-docs mksh nginx postgresql11-server postgresql11-client postgresql11-contrib sudo ffmpeg4 ImageMagick`
 
 You can also build these packages using pkgsrc:
 ```
diff --git a/docs/installation/openbsd_en.md b/docs/installation/openbsd_en.md
index eee452845..277e5ec43 100644
--- a/docs/installation/openbsd_en.md
+++ b/docs/installation/openbsd_en.md
@@ -10,16 +10,17 @@ The following packages need to be installed:
 
   * elixir
   * gmake
-  * ImageMagick
   * git
   * postgresql-server
   * postgresql-contrib
   * cmake
+  * ffmpeg
+  * ImageMagick
 
 To install them, run the following command (with doas or as root):
 
 ```
-pkg_add elixir gmake ImageMagick git postgresql-server postgresql-contrib cmake
+pkg_add elixir gmake git postgresql-server postgresql-contrib cmake ffmpeg ImageMagick
 ```
 
 Pleroma requires a reverse proxy, OpenBSD has relayd in base (and is used in this guide) and packages/ports are available for nginx (www/nginx) and apache (www/apache-httpd). Independently of the reverse proxy, [acme-client(1)](https://man.openbsd.org/acme-client) can be used to get a certificate from Let's Encrypt.
diff --git a/docs/installation/openbsd_fi.md b/docs/installation/openbsd_fi.md
index b5b5056a9..2cb03e73e 100644
--- a/docs/installation/openbsd_fi.md
+++ b/docs/installation/openbsd_fi.md
@@ -16,7 +16,7 @@ Matrix-kanava #freenode_#pleroma:matrix.org ovat hyviä paikkoja löytää apua
 
 Asenna tarvittava ohjelmisto:
 
-`# pkg_add git elixir gmake postgresql-server-10.3 postgresql-contrib-10.3 cmake`
+`# pkg_add git elixir gmake postgresql-server-10.3 postgresql-contrib-10.3 cmake ffmpeg ImageMagick`
 
 Luo postgresql-tietokanta:
 
diff --git a/docs/installation/otp_en.md b/docs/installation/otp_en.md
index b7e3bb2ac..8fdf6b5b5 100644
--- a/docs/installation/otp_en.md
+++ b/docs/installation/otp_en.md
@@ -27,17 +27,19 @@ Other than things bundled in the OTP release Pleroma depends on:
 * PostgreSQL (also utilizes extensions in postgresql-contrib)
 * nginx (could be swapped with another reverse proxy but this guide covers only it)
 * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
+* ffmpeg (needed for media preview proxy)
+* ImageMagick (needed for media preview proxy)
 
 === "Alpine"
     ```
     echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
     apk update
-    apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
+    apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot ffmpeg imagemagick
     ```
 
 === "Debian/Ubuntu"
     ```
-    apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
+    apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot ffmpeg imagemagick
     ```
 
 ## Setup
-- 
cgit v1.2.3


From 4e4f77108207157a49a627edb03951e2f15b62f1 Mon Sep 17 00:00:00 2001
From: Ivan Tashkinov <ivantashkinov@gmail.com>
Date: Sat, 26 Sep 2020 19:32:16 +0300
Subject: Adjusted MediaProxyControllerTest to gracefully fail on missing
 dependencies. Installation docs update. Added ffmpeg/imagemagick checks to
 launch checks (if media preview proxy is enabled). Added documentation on
 installing optional media / graphics packages (imagemagick, ffmpeg,
 exiftool).

---
 docs/installation/alpine_linux_en.md               | 18 ++++++------
 docs/installation/arch_linux_en.md                 | 13 +++++++--
 docs/installation/debian_based_en.md               | 13 +++++++--
 docs/installation/debian_based_jp.md               | 12 ++++++--
 docs/installation/freebsd_en.md                    |  8 +++++-
 docs/installation/gentoo_en.md                     | 13 +++++++--
 docs/installation/netbsd_en.md                     |  4 +++
 docs/installation/openbsd_en.md                    | 13 +++++++++
 docs/installation/openbsd_fi.md                    | 11 ++++++++
 .../optional/media_graphics_packages.md            | 32 ++++++++++++++++++++++
 docs/installation/otp_en.md                        | 25 ++++++++++++++---
 11 files changed, 136 insertions(+), 26 deletions(-)
 create mode 100644 docs/installation/optional/media_graphics_packages.md

(limited to 'docs/installation')

diff --git a/docs/installation/alpine_linux_en.md b/docs/installation/alpine_linux_en.md
index 0b9f5cdae..d89c7f46f 100644
--- a/docs/installation/alpine_linux_en.md
+++ b/docs/installation/alpine_linux_en.md
@@ -13,8 +13,6 @@ It assumes that you have administrative rights, either as root or a user with [s
 * `erlang-parsetools`
 * `erlang-xmerl`
 * `git`
-* `ffmpeg`
-* `ImageMagick`
 * Development Tools
 * `cmake`
 
@@ -22,6 +20,9 @@ It assumes that you have administrative rights, either as root or a user with [s
 
 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
+* `ImageMagick`
+* `ffmpeg`
+* `exiftool`
 
 ### Prepare the system
 
@@ -31,7 +32,6 @@ It assumes that you have administrative rights, either as root or a user with [s
 awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
 ```
 
-
 * Then update the system, if not already done:
 
 ```shell
@@ -59,12 +59,6 @@ sudo apk add erlang erlang-runtime-tools erlang-xmerl elixir
 sudo apk add erlang-eldap
 ```
 
-### Install ffmpeg and ImageMagick
-
-```shell
-sudo apk add ffmpeg imagemagick
-```
-
 ### Install PostgreSQL
 
 * Install Postgresql server:
@@ -85,6 +79,12 @@ sudo /etc/init.d/postgresql start
 sudo rc-update add postgresql
 ```
 
+### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
+
+```shell
+sudo apk add ffmpeg imagemagick exiftool
+```
+
 ### Install PleromaBE
 
 * Add a new system user for the Pleroma service:
diff --git a/docs/installation/arch_linux_en.md b/docs/installation/arch_linux_en.md
index 38bb82432..724b4660a 100644
--- a/docs/installation/arch_linux_en.md
+++ b/docs/installation/arch_linux_en.md
@@ -10,13 +10,14 @@ This guide will assume that you have administrative rights, either as root or a
 * `git`
 * `base-devel`
 * `cmake`
-* `ffmpeg`
-* `ImageMagick`
 
 #### Optional packages used in this guide
 
 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
+* `ImageMagick`
+* `ffmpeg`
+* `exiftool`
 
 ### Prepare the system
 
@@ -29,7 +30,7 @@ sudo pacman -Syu
 * Install some of the above mentioned programs:
 
 ```shell
-sudo pacman -S git base-devel elixir cmake ffmpeg imagemagick
+sudo pacman -S git base-devel elixir cmake
 ```
 
 ### Install PostgreSQL
@@ -54,6 +55,12 @@ sudo -iu postgres initdb -D /var/lib/postgres/data
 sudo systemctl enable --now postgresql.service
 ```
 
+### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
+
+```shell
+sudo pacman -S ffmpeg imagemagick perl-image-exiftool
+```
+
 ### Install PleromaBE
 
 * Add a new system user for the Pleroma service:
diff --git a/docs/installation/debian_based_en.md b/docs/installation/debian_based_en.md
index 30ee64c01..eac499a29 100644
--- a/docs/installation/debian_based_en.md
+++ b/docs/installation/debian_based_en.md
@@ -13,13 +13,14 @@ This guide will assume you are on Debian Stretch. This guide should also work wi
 * `git`
 * `build-essential`
 * `cmake`
-* `ffmpeg`
-* `ImageMagick`
 
 #### Optional packages used in this guide
 
 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
+* `ImageMagick`
+* `ffmpeg`
+* `exiftool`
 
 ### Prepare the system
 
@@ -33,7 +34,7 @@ sudo apt full-upgrade
 * Install some of the above mentioned programs:
 
 ```shell
-sudo apt install git build-essential postgresql postgresql-contrib cmake ffmpeg imagemagick
+sudo apt install git build-essential postgresql postgresql-contrib cmake
 ```
 
 ### Install Elixir and Erlang
@@ -52,6 +53,12 @@ sudo apt update
 sudo apt install elixir erlang-dev erlang-nox
 ```
 
+### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md)
+
+```shell
+sudo apt install imagemagick ffmpeg libimage-exiftool-perl
+```
+
 ### Install PleromaBE
 
 * Add a new system user for the Pleroma service:
diff --git a/docs/installation/debian_based_jp.md b/docs/installation/debian_based_jp.md
index 219f40525..764afbe1a 100644
--- a/docs/installation/debian_based_jp.md
+++ b/docs/installation/debian_based_jp.md
@@ -17,13 +17,14 @@
 - `git`
 - `build-essential`
 - `cmake`
-- `ffmpeg`
-- `ImageMagick`
 
 #### このガイドで利用している追加パッケージ
 
 - `nginx` (おすすめです。他のリバースプロキシを使う場合は、参考となる設定をこのリポジトリから探してください)
 - `certbot` (または何らかのLet's Encrypt向けACMEクライアント)
+- `ImageMagick`
+- `ffmpeg`
+- `exiftool`
 
 ### システムを準備する
 
@@ -38,7 +39,6 @@ sudo apt full-upgrade
 sudo apt install git build-essential postgresql postgresql-contrib cmake ffmpeg imagemagick
 ```
 
-
 ### ElixirとErlangをインストールします
 
 * Erlangのリポジトリをダウンロードおよびインストールします。
@@ -53,6 +53,12 @@ sudo apt update
 sudo apt install elixir erlang-dev erlang-nox
 ```
 
+### オプションパッケージ: [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md)
+
+```shell
+sudo apt install imagemagick ffmpeg libimage-exiftool-perl
+```
+
 ### Pleroma BE (バックエンド) をインストールします
 
 *  Pleroma用に新しいユーザーを作ります。
diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 01b410a46..fdcb06c53 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -7,7 +7,7 @@ This document was written for FreeBSD 12.1, but should be work on future release
 This assumes the target system has `pkg(8)`.
 
 ```
-# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake ffmpeg imagemagick
+# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake
 ```
 
 Copy the rc.d scripts to the right directory:
@@ -26,6 +26,12 @@ Setup the required services to automatically start at boot, using `sysrc(8)`.
 # service postgresql start
 ```
 
+### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
+
+```shell
+# pkg install imagemagick ffmpeg p5-Image-ExifTool
+```
+
 ## Configuring Pleroma
 
 Create a user for Pleroma:
diff --git a/docs/installation/gentoo_en.md b/docs/installation/gentoo_en.md
index 9a8b54ece..638fc4e47 100644
--- a/docs/installation/gentoo_en.md
+++ b/docs/installation/gentoo_en.md
@@ -29,14 +29,15 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * `dev-lang/elixir`
 * `dev-vcs/git`
 * `dev-util/cmake`
-* `media-video/ffmpeg`
-* `media-gfx/imagemagick`
 
 #### Optional ebuilds used in this guide
 
 * `www-servers/nginx` (preferred, example configs for other reverse proxies can be found in the repo)
 * `app-crypt/certbot` (or any other ACME client for Let’s Encrypt certificates)
 * `app-crypt/certbot-nginx` (nginx certbot plugin that allows use of the all-powerful `--nginx` flag on certbot)
+* `media-gfx/imagemagick`
+* `media-video/ffmpeg`
+* `media-libs/exiftool`
 
 ### Prepare the system
 
@@ -49,7 +50,7 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * Emerge all required the required and suggested software in one go:
 
 ```shell
- # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx dev-util/cmake media-video/ffmpeg media-gfx/imagemagick
+ # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx dev-util/cmake
 ```
 
 If you would not like to install the optional packages, remove them from this line. 
@@ -89,6 +90,12 @@ If you do not plan to make any modifications to your Pleroma instance, cloning d
 
 Not only does this make it much easier to deploy changes you make, as you can commit and pull from upstream and all that good stuff from the comfort of your local machine then simply `git pull` on your instance server when you're ready to deploy, it also ensures you are compliant with the Affero General Public Licence that Pleroma is licenced under, which stipulates that all network services provided with modified AGPL code must publish their changes on a publicly available internet service and for free. It also makes it much easier to ask for help from and provide help to your fellow Pleroma admins if your public repo always reflects what you are running because it is part of your deployment procedure.
 
+### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
+
+```shell
+# emerge --ask media-video/ffmpeg media-gfx/imagemagick media-libs/exiftool
+```
+
 ### Install PleromaBE
 
 * Add a new system user for the Pleroma service and set up default directories:
diff --git a/docs/installation/netbsd_en.md b/docs/installation/netbsd_en.md
index 8cf2e4682..d5fa04fdf 100644
--- a/docs/installation/netbsd_en.md
+++ b/docs/installation/netbsd_en.md
@@ -44,6 +44,10 @@ pgsql=YES
 
 First, run `# /etc/rc.d/pgsql start`. Then, `$ sudo -Hu pgsql -g pgsql createdb`.
 
+### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
+
+`# pkgin install ImageMagick ffmpeg4 p5-Image-ExifTool`
+
 ## Configuring Pleroma
 
 Create a user for Pleroma:
diff --git a/docs/installation/openbsd_en.md b/docs/installation/openbsd_en.md
index 277e5ec43..8092ac379 100644
--- a/docs/installation/openbsd_en.md
+++ b/docs/installation/openbsd_en.md
@@ -25,6 +25,19 @@ pkg_add elixir gmake git postgresql-server postgresql-contrib cmake ffmpeg Image
 
 Pleroma requires a reverse proxy, OpenBSD has relayd in base (and is used in this guide) and packages/ports are available for nginx (www/nginx) and apache (www/apache-httpd). Independently of the reverse proxy, [acme-client(1)](https://man.openbsd.org/acme-client) can be used to get a certificate from Let's Encrypt.
 
+#### Optional software
+
+Per [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md):
+  * ImageMagick
+  * ffmpeg
+  * exiftool
+
+To install the above:
+
+```
+pkg_add ImageMagick ffmpeg p5-Image-ExifTool
+```
+
 #### Creating the pleroma user
 Pleroma will be run by a dedicated user, \_pleroma. Before creating it, insert the following lines in login.conf:
 ```
diff --git a/docs/installation/openbsd_fi.md b/docs/installation/openbsd_fi.md
index 2cb03e73e..01cf34ab4 100644
--- a/docs/installation/openbsd_fi.md
+++ b/docs/installation/openbsd_fi.md
@@ -18,6 +18,17 @@ Asenna tarvittava ohjelmisto:
 
 `# pkg_add git elixir gmake postgresql-server-10.3 postgresql-contrib-10.3 cmake ffmpeg ImageMagick`
 
+#### Optional software
+
+[`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md):
+  * ImageMagick
+  * ffmpeg
+  * exiftool
+
+Asenna tarvittava ohjelmisto:
+
+`# pkg_add ImageMagick ffmpeg p5-Image-ExifTool`
+
 Luo postgresql-tietokanta:
 
 `# su - _postgresql`
diff --git a/docs/installation/optional/media_graphics_packages.md b/docs/installation/optional/media_graphics_packages.md
new file mode 100644
index 000000000..cb3d71188
--- /dev/null
+++ b/docs/installation/optional/media_graphics_packages.md
@@ -0,0 +1,32 @@
+# Optional software packages needed for specific functionality
+
+For specific Pleroma functionality (which is disabled by default) some or all of the below packages are required:
+  * `ImageMagic`
+  * `ffmpeg`
+  * `exiftool`
+  
+Please refer to documentation in `docs/installation` on how to install them on specific OS.
+  
+Note: the packages are not required with the current default settings of Pleroma.
+
+## `ImageMagick`
+
+`ImageMagick` is a set of tools to create, edit, compose, or convert bitmap images.
+
+It is required for the following Pleroma features:
+  * `Pleroma.Upload.Filters.Mogrify`, `Pleroma.Upload.Filters.Mogrifun` upload filters (related config: `Plaroma.Upload/filters` in `config/config.exs`)
+  * Media preview proxy for still images (related config: `media_preview_proxy/enabled` in `config/config.exs`)
+  
+## `ffmpeg`
+
+`ffmpeg` is software to record, convert and stream audio and video.
+
+It is required for the following Pleroma features:
+  * Media preview proxy for videos (related config: `media_preview_proxy/enabled` in `config/config.exs`)
+
+## `exiftool`
+
+`exiftool` is media files metadata reader/writer.
+
+It is required for the following Pleroma features:
+  * `Pleroma.Upload.Filters.Exiftool` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)
diff --git a/docs/installation/otp_en.md b/docs/installation/otp_en.md
index 8fdf6b5b5..f6b05c887 100644
--- a/docs/installation/otp_en.md
+++ b/docs/installation/otp_en.md
@@ -27,19 +27,36 @@ Other than things bundled in the OTP release Pleroma depends on:
 * PostgreSQL (also utilizes extensions in postgresql-contrib)
 * nginx (could be swapped with another reverse proxy but this guide covers only it)
 * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
-* ffmpeg (needed for media preview proxy)
-* ImageMagick (needed for media preview proxy)
 
 === "Alpine"
     ```
     echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
     apk update
-    apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot ffmpeg imagemagick
+    apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
     ```
 
 === "Debian/Ubuntu"
     ```
-    apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot ffmpeg imagemagick
+    apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
+    ```
+
+### Installing optional packages
+
+Per [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md):
+  * ImageMagick
+  * ffmpeg
+  * exiftool
+
+=== "Alpine"
+    ```
+    echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
+    apk update
+    apk add imagemagick ffmpeg exiftool
+    ```
+
+=== "Debian/Ubuntu"
+    ```
+    apt install imagemagick ffmpeg libimage-exiftool-perl
     ```
 
 ## Setup
-- 
cgit v1.2.3


From 8d093a68a6b54eff232566dfd7f52e9c8682398a Mon Sep 17 00:00:00 2001
From: lain <lain@soykaf.club>
Date: Mon, 5 Oct 2020 13:58:12 +0200
Subject: Docs: Modify docs so the postgres config is harder to get wrong.

---
 docs/installation/otp_en.md | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'docs/installation')

diff --git a/docs/installation/otp_en.md b/docs/installation/otp_en.md
index f6b05c887..92584d80d 100644
--- a/docs/installation/otp_en.md
+++ b/docs/installation/otp_en.md
@@ -101,6 +101,8 @@ It is encouraged to check [Optimizing your PostgreSQL performance](../configurat
 If you are using PostgreSQL 12 or higher, add this to your Ecto database configuration
 
 ```elixir
+#
+config :pleroma, Pleroma.Repo,
 prepare: :named,
 parameters: [
   plan_cache_mode: "force_custom_plan"
-- 
cgit v1.2.3