/pleroma-setup

Apache License 2.0Apache-2.0

pleroma-setup

What does this look like?

This instance was set up and altered using the instructions in this repo: https://thought.blue/@patricia

It uses a different frontend called Soapbox, but instructions on how to do that are also here.

Instructions

Based on https://docs-develop.pleroma.social/backend/installation/otp_en/

You will need an account on Digital Ocean

In the below there are some instances where you have to fill in your info. These are shown in brackets like this <PUT YOUR TEXT HERE> replace those with your text.

Create a droplet (a VM) on Digital Ocean

  • Region (close to you)
  • Ubuntu 20.04
  • Chose a droplet with at least 1GB of RAM (we can also upgrade it if needed)
  • Setup authentication method (will assume password below)
  • Add metrics and alerting (it's free)
  • Enable backups (+20% of the price of the droplet)
  • Give it a nice name

The IP is in the list of droplets in Digital Ocean

Set up DNS

In your DNS settings for your domain make an A record

  • Name: (sub)domain that you want to use for this (example thought.blue)
  • Time to live (TTL) : 3600
  • Type: A
  • Content: IP address of your droplet on Digital Ocean

Ssh into the droplet

Make a bash variable to hold your IP (replace IP address below)

export IP=<IP ADDRESS>
ssh root@$IP
  • Say yes to if you want to continue connecting
  • Type in the password

Update the droplet

apt update
apt upgrade -y

Install dependencies

apt install -y curl unzip libncurses5 postgresql postgresql-contrib nginx certbot libmagic-dev
apt install -y imagemagick ffmpeg libimage-exiftool-perl
apt install -y postgresql-12-rum
systemctl restart postgresql

Install Pleroma

Create user

adduser --system --shell  /bin/false --home /opt/pleroma pleroma

Installing Pleroma

export FLAVOUR="amd64"
su pleroma -s $SHELL -lc "
curl 'https://git.pleroma.social/api/v4/projects/2/jobs/artifacts/stable/download?job=$FLAVOUR' -o /tmp/pleroma.zip
unzip /tmp/pleroma.zip -d /tmp/
"
su pleroma -s $SHELL -lc "
mv /tmp/release/* /opt/pleroma
rmdir /tmp/release
rm /tmp/pleroma.zip
"
mkdir -p /var/lib/pleroma/uploads
chown -R pleroma /var/lib/pleroma
mkdir -p /var/lib/pleroma/static
chown -R pleroma /var/lib/pleroma
mkdir -p /etc/pleroma
chown -R pleroma /etc/pleroma
su pleroma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/pleroma/config.exs --output-psql /tmp/setup_db.psql"

Enter:

  • domain you used in DNS (example thought.blue)
  • Give it a name (example Turtle Talk)
  • admin email
  • notification email
  • yes to seach engines and storing in database
  • Accept the defaults for hostname, db name, user and password
  • yes to RUM indices
  • Accept default port and ip
  • Accept default dir for media and custom public files
  • yes to stripping location from images
  • yes to anon names of files
  • yes to deduplication

Example:

What domain will your instance use? (e.g pleroma.soykaf.com) [] <DOMAIN>
What is the name of your instance? (e.g. The Corndog Emporium) [<DOMAIN>] <INSTANCE NAME>
What is your admin email address? [] <ADMIN EMAIL>
What email address do you want to use for sending email notifications? [<ADMIN EMAIL>] <NOTIFICATION EMAIL>
Do you want search engines to index your site? (y/n) [y] y
Do you want to store the configuration in the database (allows controlling it from admin-fe)? (y/n) [n] y
What is the hostname of your database? [localhost]
What is the name of your database? [pleroma]
What is the user used to connect to your database? [pleroma]
What is the password used to connect to your database? [autogenerated]
Would you like to use RUM indices? [n] y
What port will the app listen to (leave it if you are using the default setup with nginx)? [4000]
What ip will the app listen to (leave it if you are using the default setup with nginx)? [127.0.0.1]
What directory should media uploads go in (when using the local uploader)? [/var/lib/pleroma/uploads]
What directory should custom public files be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)? [/var/lib/pleroma/static]
Do you want to strip location (GPS) data from uploaded images? This requires exiftool, it was detected as installed. (y/n) [y]
Do you want to anonymize the filenames of uploads? (y/n) [n] y
Do you want to deduplicate uploaded files? (y/n) [n] y

Set up PostgreSQL database

su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
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/"
su pleroma -s $SHELL -lc "./bin/pleroma daemon"

You might try this following one a couple of times, it's just to test that the site is up

sleep 20 && curl http://localhost:4000/api/v1/instance
su pleroma -s $SHELL -lc "./bin/pleroma stop"

Lets do our required reboot here

reboot
ssh root@$IP

Getting Let's Encrypt SSL certificates

systemctl stop nginx

Example thought.blue

export DOMAIN=<DOMAIN FOR YOUR PLEROMA>
certbot certonly --standalone --preferred-challenges http -d $DOMAIN
  • Enter admin email address
  • Accept terms
  • Say no to emails

Example:

Saving debug log to /var/log/letsencrypt/letsencrypt.log
Plugins selected: Authenticator standalone, Installer None
Enter email address (used for urgent renewal and security notices) (Enter 'c' to
cancel): <ADMIN EMAIL>

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Please read the Terms of Service at
https://letsencrypt.org/documents/LE-SA-v1.3-September-21-2022.pdf. You must
agree in order to register with the ACME server at
https://acme-v02.api.letsencrypt.org/directory
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
(A)gree/(C)ancel: A

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Would you be willing to share your email address with the Electronic Frontier
Foundation, a founding partner of the Let's Encrypt project and the non-profit
organization that develops Certbot? We'd like to send you email about our work
encrypting the web, EFF news, campaigns, and ways to support digital freedom.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
(Y)es/(N)o: N
Obtaining a new certificate
Performing the following challenges:
http-01 challenge for thought.blue
Waiting for verification...
Cleaning up challenges

IMPORTANT NOTES:
- Congratulations! Your certificate and chain have been saved at:
  /etc/letsencrypt/live/thought.blue/fullchain.pem
  Your key file has been saved at:
  /etc/letsencrypt/live/thought.blue/privkey.pem
  Your cert will expire on 2023-02-07. To obtain a new or tweaked
  version of this certificate in the future, simply run certbot
  again. To non-interactively renew *all* of your certificates, run
  "certbot renew"
- Your account credentials have been saved in your Certbot
  configuration directory at /etc/letsencrypt. You should make a
  secure backup of this folder now. This configuration directory will
  also contain certificates and private keys obtained by Certbot so
  making regular backups of this folder is ideal.
- If you like Certbot, please consider supporting our work by:

  Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate
  Donating to EFF:                    https://eff.org/donate-le

Setting up nginx

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

We will need to replace all of the example.tld in the config file

grep example.tld /etc/nginx/sites-enabled/pleroma.conf
sed -i "s/example.tld/$DOMAIN/g" /etc/nginx/sites-enabled/pleroma.conf 
grep $DOMAIN /etc/nginx/sites-enabled/pleroma.conf
nginx -t

Setting up a system service

cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
systemctl start pleroma
systemctl enable pleroma

Setting up auto-renew of the Let's Encrypt certificate

mkdir -p /var/lib/letsencrypt

Uncomment this section

    # location ~ /\.well-known/acme-challenge {
    #     root /var/lib/letsencrypt/;
    # }

nano /etc/nginx/sites-enabled/pleroma.conf
nginx -t
systemctl restart nginx

Ensure the webroot menthod and post hook is working

certbot renew --cert-name $DOMAIN --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl reload nginx'

Create a script for a cron job

echo '#!/bin/sh
certbot renew --cert-name example.tld --webroot -w /var/lib/letsencrypt/ --post-hook "systemctl reload nginx"
' > /etc/cron.daily/renew-pleroma-cert

Set the domain right in the script

sed -i "s/example.tld/$DOMAIN/g" /etc/cron.daily/renew-pleroma-cert

Make it executable

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
cd /opt/pleroma

Create your first user and set as admin

export ADMIN_USER=<USER NAME>
export ADMIN_EMAIL=<USER EMAIL ADDRESS>
su pleroma -s $SHELL -lc "./bin/pleroma_ctl user new $ADMIN_USER $ADMIN_EMAIL --admin"

Copy URL, use it to set your password

Where do we go from here?