akkoma/docs/installation/alpine_linux_en.md

Installing on Alpine Linux

{! backend/installation/otp_vs_from_source_source.include !}

Installation

This guide is a step-by-step installation guide for Alpine Linux. The instructions were verified against Alpine v3.16 standard image. You might miss additional dependencies if you use netboot instead.

As of Alpine Linux v3.16, doas is the preferred way of running privileged commands, which is what this guide will use. If you are running an earlier version, replace doas with sudo (and use sudo -Hu akkoma instead of doas -u akkoma). If you want to run this guide with root, ignore the doas at the beginning of the lines, unless it calls a user like doas -u akkoma; in this case, use su -l <username> -s $SHELL -c 'command' instead.

{! backend/installation/generic_dependencies.include !}

Prepare the system

• The community repository must be enabled in /etc/apk/repositories. Depending on which version and mirror you use this looks like https://dl-5.alpinelinux.org/alpine/v3.16/community. If you autogenerated the mirror during installation:

awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories

• Then update the system, if not already done:

doas apk update
doas apk upgrade

• Install some tools, which are needed later:

doas apk add git build-base cmake file-dev

Install Elixir and Erlang

• Install Erlang and Elixir:

doas apk add erlang elixir

• Install erlang-eldap if you want to enable ldap authenticator

doas apk add erlang-eldap

Install PostgreSQL

• Install Postgresql server:

doas apk add postgresql postgresql-contrib

• Initialize database:

doas rc-service postgresql start

• Enable and start postgresql server:

doas rc-update add postgresql

Install media / graphics packages (optional, see docs/installation/optional/media_graphics_packages.md)

doas apk add ffmpeg imagemagick exiftool

Install AkkomaBE

• Add a new system user for the Akkoma service:

doas addgroup akkoma
doas adduser -S -s /bin/false -h /opt/akkoma -H -G akkoma akkoma

Note: To execute a single command as the Akkoma system user, use doas -u akkoma command. You can also switch to a shell by using doas -su akkoma. If you don’t have and want doas on your system, you can use su as root user (UID 0) for a single command by using su -l akkoma -s $SHELL -c 'command' and su -l akkoma -s $SHELL for starting a shell.

• Git clone the AkkomaBE repository and make the Akkoma user the owner of the directory:

doas mkdir -p /opt/akkoma
doas chown -R akkoma:akkoma /opt/akkoma
doas -u akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git /opt/akkoma

• Change to the new directory:

cd /opt/akkoma

• Install the dependencies for Akkoma and answer with yes if it asks you to install Hex:

doas -u akkoma mix deps.get

• Generate the configuration: doas -u akkoma env MIX_ENV=prod mix pleroma.instance gen

  • Answer with yes if it asks you to install rebar3.
  • This may take some time, because parts of akkoma get compiled first.
  • After that it will ask you a few questions about your instance and generates a configuration file in config/generated_config.exs.

• Check the configuration and if all looks right, rename it, so Akkoma will load it (prod.secret.exs for productive instance, dev.secret.exs for development instances):

doas -u akkoma mv config/{generated_config.exs,prod.secret.exs}

• The previous command creates also the file config/setup_db.psql, with which you can create the database:

doas -u postgres psql -f config/setup_db.psql

• Now run the database migration:

doas -u akkoma env MIX_ENV=prod mix ecto.migrate

• Now you can start Akkoma already

doas -u akkoma env MIX_ENV=prod mix phx.server

Finalize installation

If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Akkoma and you should consider to create an OpenRC service file for Akkoma.

Nginx

• Install nginx, if not already done:

doas apk add nginx

• Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:

doas apk add certbot

and then set it up:

doas mkdir -p /var/lib/letsencrypt/
doas 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).

• Copy the example nginx configuration to the nginx folder

doas cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/conf.d/akkoma.conf

• Before starting nginx edit the configuration and change it to your needs. You must change change 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;
    ...
}

• Enable and start nginx:

doas rc-update add nginx
doas rc-service nginx start

If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:

doas certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/

OpenRC service

• Copy example service file:

doas cp /opt/akkoma/installation/init.d/akkoma /etc/init.d/akkoma

• Make sure to start it during the boot

doas rc-update add akkoma

Create your first user

If your instance is up and running, you can create your first user with administrative rights with the following task:

doas -u akkoma env MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin

Further reading

{! backend/installation/further_reading.include !}

Questions

If you encounter any issues or have questions regarding the install process, feel free to ask at meta.akkoma.dev.