This guide is a step-by-step installation guide for Alpine Linux. The instructions were verified against Alpine v3.10 standard image. You might miss additional dependencies if you use netboot
instead.
It 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 -l <username> -s $SHELL -c 'command'
instead.
{! backend/installation/generic_dependencies.include !}
/etc/apk/repositories
. Depending on which version and mirror you use this looks like http://alpine.42.fr/v3.10/community
. If you autogenerated the mirror during installation:awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
sudo apk update
sudo apk upgrade
sudo apk add git build-base cmake file-dev
sudo apk add erlang erlang-runtime-tools erlang-xmerl elixir
erlang-eldap
if you want to enable ldap authenticatorsudo apk add erlang-eldap
sudo apk add postgresql postgresql-contrib
sudo /etc/init.d/postgresql start
sudo rc-update add postgresql
docs/installation/optional/media_graphics_packages.md
)sudo apk add ffmpeg imagemagick exiftool
sudo addgroup pleroma
sudo adduser -S -s /bin/false -h /opt/pleroma -H -G pleroma 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 an OpenRC service file for Pleroma.
sudo apk add nginx
sudo apk add 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/conf.d/pleroma.conf
server_name
and the paths to the certificates. You can use nano
(install with apk add nano
if missing).server {
server_name your.domain;
listen 80;
...
}
server {
server_name your.domain;
listen 443 ssl http2;
...
ssl_trusted_certificate /etc/letsencrypt/live/your.domain/chain.pem;
ssl_certificate /etc/letsencrypt/live/your.domain/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/your.domain/privkey.pem;
...
}
sudo rc-update add nginx
sudo service nginx start
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/
sudo cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
sudo rc-update add pleroma
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.