1 # Installing on Debian Based Distributions
3 {! installation/otp_vs_from_source_source.include !}
7 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](https://www.digitalocean.com/community/tutorials/how-to-add-delete-and-grant-sudo-privileges-to-users-on-a-debian-vps). 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 akkoma`; in this case, use `su <username> -s $SHELL -c 'command'` instead.
9 {! installation/generic_dependencies.include !}
11 ### Prepare the system
13 * First update the system, if not already done:
20 * Install some of the above mentioned programs:
23 sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev
26 ### Install Elixir and Erlang
28 * Install Elixir and Erlang (you might need to use backports or [asdf](https://github.com/asdf-vm/asdf) on old systems):
32 sudo apt install elixir erlang-dev erlang-nox
36 ### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
39 sudo apt install imagemagick ffmpeg libimage-exiftool-perl
44 * Add a new system user for the Akkoma service:
47 sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
50 **Note**: To execute a single command as the Akkoma system user, use `sudo -Hu akkoma command`. You can also switch to a shell by using `sudo -Hu akkoma $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 akkoma -s $SHELL -c 'command'` and `su -l akkoma -s $SHELL` for starting a shell.
52 * Git clone the AkkomaBE repository from stable-branch and make the Akkoma user the owner of the directory:
55 sudo mkdir -p /opt/akkoma
56 sudo chown -R akkoma:akkoma /opt/akkoma
57 sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git -b stable /opt/akkoma
60 * Change to the new directory:
66 * Install the dependencies for Akkoma and answer with `yes` if it asks you to install `Hex`:
69 sudo -Hu akkoma mix deps.get
72 * Generate the configuration: `sudo -Hu akkoma MIX_ENV=prod mix pleroma.instance gen`
73 * Answer with `yes` if it asks you to install `rebar3`.
74 * This may take some time, because parts of akkoma get compiled first.
75 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
77 * Check the configuration and if all looks right, rename it, so Akkoma will load it (`prod.secret.exs` for productive instances):
80 sudo -Hu akkoma mv config/{generated_config.exs,prod.secret.exs}
84 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
87 sudo -Hu postgres psql -f config/setup_db.psql
90 * Now run the database migration:
93 sudo -Hu akkoma MIX_ENV=prod mix ecto.migrate
96 * Now you can start Akkoma already
99 sudo -Hu akkoma MIX_ENV=prod mix phx.server
102 ### Finalize installation
104 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 a systemd service file for Akkoma.
108 * Install nginx, if not already done:
111 sudo apt install nginx
114 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
117 sudo apt install certbot
123 sudo mkdir -p /var/lib/letsencrypt/
124 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
127 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).
131 * Copy the example nginx configuration and activate it:
134 sudo cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/sites-available/akkoma.nginx
135 sudo ln -s /etc/nginx/sites-available/akkoma.nginx /etc/nginx/sites-enabled/akkoma.nginx
138 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
139 * Enable and start nginx:
142 sudo systemctl enable --now nginx.service
145 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
148 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
151 #### Other webserver/proxies
153 You can find example configurations for them in `/opt/akkoma/installation/`.
157 * Copy example service file
160 sudo cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
163 * Edit the service file and make sure that all paths fit your installation
164 * Enable and start `akkoma.service`:
167 sudo systemctl enable --now akkoma.service
170 #### Create your first user
172 If your instance is up and running, you can create your first user with administrative rights with the following task:
175 sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
178 {! installation/frontends.include !}
182 {! installation/further_reading.include !}
184 {! support.include !}