3 ## OTP releases and RedHat-distributions
5 While the OTP releases of Akkoma work on most Linux distributions, they do not work correctly with RedHat-distributions. Therefore from-source installations are the recommended way to go when trying to install Akkoma on Fedora, Centos Stream or RedHat.
7 However, it is possible to compile your own OTP release of Akkoma for RedHat. Keep in mind that this has a few drawbacks, and has no particular advantage over a from-source installation, since you'll need to install Erlang and Elixir anyway.
9 This guide will cover a from-source installation. For instructions on how to build your own OTP release, please check out [the OTP for RedHat guide](./otp_redhat_en.md).
13 This guide will assume you are on Fedora 36. This guide should also work with current releases of Centos Stream and RedHat, although it has not been tested yet. It also assumes that you have administrative rights, either as root or a user with [sudo permissions](https://docs.fedoraproject.org/en-US/quick-docs/adding_user_to_sudoers_file/). 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.
15 {! installation/generic_dependencies.include !}
17 ### Prepare the system
19 * First update the system, if not already done:
22 sudo dnf upgrade --refresh
25 * Install some of the above mentioned programs:
28 sudo dnf install git gcc g++ make cmake file-devel postgresql postgresql-contrib
31 ### Install Elixir and Erlang
33 * Install Elixir and Erlang:
36 sudo dnf install elixir erlang-os_mon erlang-eldap erlang-xmerl erlang-erl_interface erlang-syntax_tools
40 ### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
42 * Install ffmpeg (requires setting up the RPM-fusion repositories):
45 sudo dnf -y install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
46 sudo dnf -y install https://download1.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
47 sudo dnf install ffmpeg
50 * Install ImageMagick and ExifTool for image manipulation:
53 sudo dnf install Imagemagick perl-Image-ExifTool
60 * Add a new system user for the Akkoma service:
63 sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
66 **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.
68 * Git clone the AkkomaBE repository and make the Akkoma user the owner of the directory:
71 sudo mkdir -p /opt/akkoma
72 sudo chown -R akkoma:akkoma /opt/akkoma
73 sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git /opt/akkoma
76 * Change to the new directory:
82 * Install the dependencies for Akkoma and answer with `yes` if it asks you to install `Hex`:
85 sudo -Hu akkoma mix deps.get
88 * Generate the configuration: `sudo -Hu akkoma MIX_ENV=prod mix pleroma.instance gen`
89 * Answer with `yes` if it asks you to install `rebar3`.
90 * This may take some time, because parts of akkoma get compiled first.
91 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
93 * 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):
96 sudo -Hu akkoma mv config/{generated_config.exs,prod.secret.exs}
100 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
103 sudo -Hu postgres psql -f config/setup_db.psql
106 * Now run the database migration:
109 sudo -Hu akkoma MIX_ENV=prod mix ecto.migrate
112 * Now you can start Akkoma already
115 sudo -Hu akkoma MIX_ENV=prod mix phx.server
118 ### Finalize installation
120 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.
124 * Install nginx, if not already done:
127 sudo dnf install nginx
130 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
133 sudo dnf install certbot
139 sudo mkdir -p /var/lib/letsencrypt/
140 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
143 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).
147 * Copy the example nginx configuration and activate it:
150 sudo cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/conf.d/akkoma.conf
153 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
154 * Enable and start nginx:
157 sudo systemctl enable --now nginx.service
160 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
163 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
166 #### Other webserver/proxies
168 You can find example configurations for them in `/opt/akkoma/installation/`.
172 * Copy example service file
175 sudo cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
178 * Edit the service file and make sure that all paths fit your installation
179 * Enable and start `akkoma.service`:
182 sudo systemctl enable --now akkoma.service
185 #### Create your first user
187 If your instance is up and running, you can create your first user with administrative rights with the following task:
190 sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
195 {! installation/further_reading.include !}
197 {! support.include !}