This guide will assume you are on Debian 11 (“bullseye”) or later. This guide should also work with Ubuntu 18.04 (“Bionic Beaver”) and later. It also assumes that you have administrative rights, either as root or a user with sudo permissions. If you want to run this guide with root, ignore the sudo
at the beginning of the lines, unless it calls a user like sudo -Hu pleroma
; in this case, use su <username> -s $SHELL -c 'command'
instead.
{! backend/installation/generic_dependencies.include !}
sudo apt update
sudo apt full-upgrade
sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev
sudo apt update
sudo apt install elixir erlang-dev erlang-nox
docs/installation/optional/media_graphics_packages.md
sudo apt install imagemagick ffmpeg libimage-exiftool-perl
sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
Note: To execute a single command as the Pleroma system user, use sudo -Hu pleroma command
. You can also switch to a shell by using sudo -Hu pleroma $SHELL
. If you don’t have and want sudo
on your system, you can use su
as root user (UID 0) for a single command by using su -l pleroma -s $SHELL -c 'command'
and su -l pleroma -s $SHELL
for starting a shell.
sudo mkdir -p /opt/pleroma
sudo chown -R pleroma:pleroma /opt/pleroma
sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
cd /opt/pleroma
yes
if it asks you to install Hex
:sudo -Hu pleroma mix deps.get
Generate the configuration: sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen
yes
if it asks you to install rebar3
.config/generated_config.exs
.Check the configuration and if all looks right, rename it, so Pleroma will load it (prod.secret.exs
for productive instance, dev.secret.exs
for development instances):
sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
config/setup_db.psql
, with which you can create the database:sudo -Hu postgres psql -f config/setup_db.psql
sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
sudo -Hu pleroma MIX_ENV=prod mix phx.server
If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Pleroma and you should consider to create a systemd service file for Pleroma.
sudo apt install nginx
sudo apt install certbot
and then set it up:
sudo mkdir -p /var/lib/letsencrypt/
sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
If that doesn’t work, make sure, that nginx is not already running. If it still doesn’t work, try setting up nginx first (change ssl “on” to “off” and try again).
sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
sudo systemctl enable --now nginx.service
If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
You can find example configurations for them in /opt/pleroma/installation/
.
sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
pleroma.service
:sudo systemctl enable --now pleroma.service
If your instance is up and running, you can create your first user with administrative rights with the following task:
sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
{! backend/installation/further_reading.include !}
Questions about the installation or didn’t it work as it should be, ask in #pleroma:libera.chat via Matrix or #pleroma on libera.chat via IRC.