2019-03-28 16:46:30 +00:00
# Installing on Debian Based Distributions
2021-08-10 06:09:31 +00:00
2022-07-15 12:27:16 +00:00
{! installation/otp_vs_from_source_source.include !}
2021-08-10 06:09:31 +00:00
2019-03-28 16:46:30 +00:00
## Installation
2023-08-04 13:19:18 +00:00
This guide will assume you are on Debian 12 (“bookworm”) or later. This guide should also work with Ubuntu 22.04 (“Jammy Jellyfish”) 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.
2019-03-28 16:46:30 +00:00
2022-07-15 12:27:16 +00:00
{! installation/generic_dependencies.include !}
2019-03-28 16:46:30 +00:00
### Prepare the system
* First update the system, if not already done:
```shell
sudo apt update
sudo apt full-upgrade
```
* Install some of the above mentioned programs:
```shell
2020-11-17 13:11:37 +00:00
sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev
2019-03-28 16:46:30 +00:00
```
2023-05-31 01:17:26 +00:00
### Create the akkoma user
* Add a new system user for the Akkoma service:
```shell
sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
```
**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.
2019-03-28 16:46:30 +00:00
### Install Elixir and Erlang
2023-06-11 12:46:56 +00:00
If your distribution packages a recent enough version of Elixir, you can install it directly from the distro repositories and skip to the next section of the guide:
2019-03-28 16:46:30 +00:00
```shell
2020-03-03 03:58:12 +00:00
sudo apt install elixir erlang-dev erlang-nox
2019-03-28 16:46:30 +00:00
```
2023-05-31 01:17:26 +00:00
Otherwise use [asdf ](https://github.com/asdf-vm/asdf ) to install the latest versions of Elixir and Erlang.
2021-06-11 06:44:27 +00:00
2023-05-31 01:17:26 +00:00
First, install some dependencies needed to build Elixir and Erlang:
```shell
2023-05-31 12:59:03 +00:00
sudo apt install curl unzip build-essential autoconf m4 libncurses5-dev libssh-dev unixodbc-dev xsltproc libxml2-utils libncurses-dev
2023-05-31 01:17:26 +00:00
```
2020-09-26 16:32:16 +00:00
2023-05-31 01:17:26 +00:00
Then login to the `akkoma` user and install asdf:
2020-09-26 16:32:16 +00:00
```shell
2023-05-31 01:17:26 +00:00
git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.11.3
2020-09-26 16:32:16 +00:00
```
2023-05-31 01:17:26 +00:00
Add the following lines to `~/.bashrc` :
```shell
. "$HOME/.asdf/asdf.sh"
# asdf completions
. "$HOME/.asdf/completions/asdf.bash"
```
2019-03-28 16:46:30 +00:00
2023-05-31 01:21:44 +00:00
Restart the shell:
```shell
exec $SHELL
```
2023-05-31 01:17:26 +00:00
Next install Erlang:
```shell
asdf plugin add erlang https://github.com/asdf-vm/asdf-erlang.git
2023-05-31 12:46:05 +00:00
export KERL_CONFIGURE_OPTIONS="--disable-debug --without-javac"
2023-08-04 13:19:18 +00:00
asdf install erlang 25.3.2.5
asdf global erlang 25.3.2.5
2023-05-31 01:17:26 +00:00
```
2019-03-28 16:46:30 +00:00
2023-05-31 01:17:26 +00:00
Now install Elixir:
2019-03-28 16:46:30 +00:00
```shell
2023-05-31 01:17:26 +00:00
asdf plugin-add elixir https://github.com/asdf-vm/asdf-elixir.git
2023-08-04 13:19:18 +00:00
asdf install elixir 1.15.4-otp-25
asdf global elixir 1.15.4-otp-25
2019-03-28 16:46:30 +00:00
```
2023-05-31 01:17:26 +00:00
Confirm that Elixir is installed correctly by checking the version:
```shell
elixir --version
```
### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
```shell
sudo apt install imagemagick ffmpeg libimage-exiftool-perl
```
### Install AkkomaBE
2019-03-28 16:46:30 +00:00
2023-05-31 01:17:26 +00:00
* Log into the `akkoma` user and clone the AkkomaBE repository from the stable branch and make the Akkoma user the owner of the directory:
2019-03-28 16:46:30 +00:00
```shell
2022-07-02 21:00:01 +00:00
sudo mkdir -p /opt/akkoma
sudo chown -R akkoma:akkoma /opt/akkoma
2022-12-16 16:23:31 +00:00
sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git -b stable /opt/akkoma
2019-03-28 16:46:30 +00:00
```
* Change to the new directory:
```shell
2022-07-02 21:00:01 +00:00
cd /opt/akkoma
2019-03-28 16:46:30 +00:00
```
2022-07-02 21:00:01 +00:00
* Install the dependencies for Akkoma and answer with `yes` if it asks you to install `Hex` :
2019-03-28 16:46:30 +00:00
```shell
2022-07-02 21:00:01 +00:00
sudo -Hu akkoma mix deps.get
2019-03-28 16:46:30 +00:00
```
2022-07-02 21:00:01 +00:00
* Generate the configuration: `sudo -Hu akkoma MIX_ENV=prod mix pleroma.instance gen`
2019-03-28 16:46:30 +00:00
* Answer with `yes` if it asks you to install `rebar3` .
2022-07-02 21:00:01 +00:00
* This may take some time, because parts of akkoma get compiled first.
2019-03-28 16:46:30 +00:00
* After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs` .
2022-12-16 16:23:31 +00:00
* Check the configuration and if all looks right, rename it, so Akkoma will load it (`prod.secret.exs` for productive instances):
2019-03-28 16:46:30 +00:00
```shell
2022-07-02 21:00:01 +00:00
sudo -Hu akkoma mv config/{generated_config.exs,prod.secret.exs}
2019-03-28 16:46:30 +00:00
```
2020-08-05 16:04:12 +00:00
2019-03-28 16:46:30 +00:00
* The previous command creates also the file `config/setup_db.psql` , with which you can create the database:
```shell
sudo -Hu postgres psql -f config/setup_db.psql
```
* Now run the database migration:
```shell
2022-07-02 21:00:01 +00:00
sudo -Hu akkoma MIX_ENV=prod mix ecto.migrate
2019-03-28 16:46:30 +00:00
```
2022-07-02 21:00:01 +00:00
* Now you can start Akkoma already
2019-03-28 16:46:30 +00:00
```shell
2022-07-02 21:00:01 +00:00
sudo -Hu akkoma MIX_ENV=prod mix phx.server
2019-03-28 16:46:30 +00:00
```
### Finalize installation
2022-07-02 21:00:01 +00:00
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.
2019-03-28 16:46:30 +00:00
#### Nginx
* Install nginx, if not already done:
```shell
sudo apt install nginx
```
* Copy the example nginx configuration and activate it:
```shell
2022-07-06 18:50:01 +00:00
sudo cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/sites-available/akkoma.nginx
2022-07-02 21:00:01 +00:00
sudo ln -s /etc/nginx/sites-available/akkoma.nginx /etc/nginx/sites-enabled/akkoma.nginx
2019-03-28 16:46:30 +00:00
```
* Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
* Enable and start nginx:
```shell
sudo systemctl enable --now nginx.service
```
2024-04-21 01:17:01 +00:00
* Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
2019-03-28 16:46:30 +00:00
```shell
2024-04-21 01:17:01 +00:00
sudo apt install certbot python3-certbot-nginx
2019-03-28 16:46:30 +00:00
```
2024-04-21 01:17:01 +00:00
and then set it up:
```shell
sudo mkdir -p /var/lib/letsencrypt/
sudo certbot --email < your @ emailaddress > -d < yourdomain > -d < media_domain > --nginx
```
If that doesn't work the first time, add `--dry-run` to further attempts to avoid being ratelimited as you identify the issue, and do not remove it until the dry run succeeds. A common source of problems are nginx config syntax errors; this can be checked for by running `nginx -t` .
Certificate renewal should be handled automatically by Certbot from now on.
2019-03-28 16:46:30 +00:00
#### Other webserver/proxies
2022-07-02 21:00:01 +00:00
You can find example configurations for them in `/opt/akkoma/installation/` .
2019-03-28 16:46:30 +00:00
#### Systemd service
* Copy example service file
```shell
2022-07-02 21:00:01 +00:00
sudo cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
2019-03-28 16:46:30 +00:00
```
* Edit the service file and make sure that all paths fit your installation
2022-07-02 21:00:01 +00:00
* Enable and start `akkoma.service` :
2019-03-28 16:46:30 +00:00
```shell
2022-07-02 21:00:01 +00:00
sudo systemctl enable --now akkoma.service
2019-03-28 16:46:30 +00:00
```
#### Create your first user
If your instance is up and running, you can create your first user with administrative rights with the following task:
```shell
2022-07-02 21:00:01 +00:00
sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new < username > < your @ emailaddress > --admin
2019-03-28 16:46:30 +00:00
```
2022-08-30 09:56:33 +00:00
{! installation/frontends.include !}
2019-03-28 16:46:30 +00:00
#### Further reading
2022-07-15 12:27:16 +00:00
{! installation/further_reading.include !}
2019-03-28 16:46:30 +00:00
2022-07-15 12:27:16 +00:00
{! support.include !}