1 # Installing on Linux using OTP releases
3 {! installation/otp_vs_from_source.include !}
5 This guide covers a installation using an OTP release. To install Akkoma from source, please check out the corresponding guide for your distro.
8 * A machine running Linux with GNU (e.g. Debian, Ubuntu) or musl (e.g. Alpine) libc and `x86_64`, `aarch64` or `armv7l` CPU, you have root access to. If you are not sure if it's compatible see [Detecting flavour section](#detecting-flavour) below
9 * For installing OTP releases on RedHat-based distros like Fedora and Centos Stream, please follow [this guide](./otp_redhat_en.md) instead.
10 * A (sub)domain pointed to the machine
12 You will be running commands as root. If you aren't root already, please elevate your priviledges by executing `sudo su`/`su`.
14 While in theory OTP releases are possbile to install on any compatible machine, for the sake of simplicity this guide focuses only on Debian/Ubuntu and Alpine.
18 This is a little more complex than it used to be (thanks ubuntu)
20 Use the following mapping to figure out your flavour:
22 | distribution | flavour |
23 | ------------- | ------------ |
24 | debian stable | amd64 |
25 | ubuntu focal | amd64 |
26 | ubuntu jammy | ubuntu-jammy |
27 | alpine | amd64-musl |
29 Other similar distributions will _probably_ work, but if it is not listed above, there is no official
32 ### Installing the required packages
34 Other than things bundled in the OTP release Akkoma depends on:
36 * curl (to download the release build)
37 * unzip (needed to unpack release builds)
38 * ncurses (ERTS won't run without it)
39 * PostgreSQL (also utilizes extensions in postgresql-contrib)
40 * nginx (could be swapped with another reverse proxy but this guide covers only it)
41 * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
46 awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
48 apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot file-dev
53 apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot libmagic-dev
56 ### Installing optional packages
58 Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_graphics_packages.md):
66 apk add imagemagick ffmpeg exiftool
71 apt install imagemagick ffmpeg libimage-exiftool-perl
75 ### Configuring PostgreSQL
76 #### (Optional) Installing RUM indexes
79 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
81 RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. You can read more about them on the [Configuration page](../configuration/cheatsheet.md#rum-indexing-for-full-text-search). They are completely optional and most of the time are not worth it, especially if you are running a single user instance (unless you absolutely need ordered search results).
85 apk add git build-base postgresql-dev
86 git clone https://github.com/postgrespro/rum /tmp/rum
89 make USE_PGXS=1 install
96 # Available only on Buster/19.04
97 apt install postgresql-11-rum
100 #### (Optional) Performance configuration
101 It is encouraged to check [Optimizing your PostgreSQL performance](../configuration/postgresql.md) document, for tips on PostgreSQL tuning.
103 Restart PostgreSQL to apply configuration changes:
107 rc-service postgresql restart
112 systemctl restart postgresql
115 ### Installing Akkoma
117 # Create a Akkoma user
118 adduser --system --shell /bin/false --home /opt/akkoma akkoma
120 # Set the flavour environment variable to the string you got in Detecting flavour section.
121 # For example if the flavour is `amd64-musl` the command will be
122 export FLAVOUR="amd64-musl"
124 # Clone the release build into a temporary directory and unpack it
125 su akkoma -s $SHELL -lc "
126 curl 'https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-$FLAVOUR.zip' -o /tmp/akkoma.zip
127 unzip /tmp/akkoma.zip -d /tmp/
130 # Move the release to the home directory and delete temporary files
131 su akkoma -s $SHELL -lc "
132 mv /tmp/release/* /opt/akkoma
136 # Create uploads directory and set proper permissions (skip if planning to use a remote uploader)
137 # Note: It does not have to be `/var/lib/akkoma/uploads`, the config generator will ask about the upload directory later
139 mkdir -p /var/lib/akkoma/uploads
140 chown -R akkoma /var/lib/akkoma
142 # Create custom public files directory (custom emojis, frontend bundle overrides, robots.txt, etc.)
143 # Note: It does not have to be `/var/lib/akkoma/static`, the config generator will ask about the custom public files directory later
144 mkdir -p /var/lib/akkoma/static
145 chown -R akkoma /var/lib/akkoma
147 # Create a config directory
149 chown -R akkoma /etc/akkoma
151 # Run the config generator
152 su akkoma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/akkoma/config.exs --output-psql /tmp/setup_db.psql"
154 # Create the postgres database
155 su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
157 # Create the database schema
158 su akkoma -s $SHELL -lc "./bin/pleroma_ctl migrate"
160 # If you have installed RUM indexes uncommend and run
161 # su akkoma -s $SHELL -lc "./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
163 # Start the instance to verify that everything is working as expected
164 su akkoma -s $SHELL -lc "./bin/pleroma daemon"
166 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
167 sleep 20 && curl http://localhost:4000/api/v1/instance
170 su akkoma -s $SHELL -lc "./bin/pleroma stop"
173 ### Setting up nginx and getting Let's Encrypt SSL certificaties
175 #### Get a Let's Encrypt certificate
177 certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
180 #### Copy Akkoma nginx configuration to the nginx folder
182 The location of nginx configs is dependent on the distro
186 cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/conf.d/akkoma.conf
191 cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/sites-available/akkoma.conf
192 ln -s /etc/nginx/sites-available/akkoma.conf /etc/nginx/sites-enabled/akkoma.conf
195 If your distro does not have either of those you can append `include /etc/nginx/akkoma.conf` to the end of the http section in /etc/nginx/nginx.conf and
197 cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/akkoma.conf
200 #### Edit the nginx config
202 # Replace example.tld with your (sub)domain
203 $EDITOR path-to-nginx-config
205 # Verify that the config is valid
212 rc-service nginx start
217 systemctl start nginx
220 At this point if you open your (sub)domain in a browser you should see a 502 error, that's because Akkoma is not started yet.
222 ### Setting up a system service
226 # Copy the service into a proper directory
227 cp /opt/akkoma/installation/init.d/akkoma /etc/init.d/akkoma
229 # Start akkoma and enable it on boot
230 rc-service akkoma start
236 # Copy the service into a proper directory
237 cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
239 # Start akkoma and enable it on boot
240 systemctl start akkoma
241 systemctl enable akkoma
244 If everything worked, you should see Akkoma-FE when visiting your domain. If that didn't happen, try reviewing the installation steps, starting Akkoma in the foreground and seeing if there are any errrors.
246 {! support.include !}
250 ### Setting up auto-renew of the Let's Encrypt certificate
252 # Create the directory for webroot challenges
253 mkdir -p /var/lib/letsencrypt
255 # Uncomment the webroot method
256 $EDITOR path-to-nginx-config
258 # Verify that the config is valid
265 rc-service nginx restart
267 # Start the cron daemon and make it start on boot
268 rc-service crond start
271 # Ensure the webroot menthod and post hook is working
272 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
274 # Add it to the daily cron
276 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "rc-service nginx reload"
277 ' > /etc/periodic/daily/renew-akkoma-cert
278 chmod +x /etc/periodic/daily/renew-akkoma-cert
280 # If everything worked the output should contain /etc/cron.daily/renew-akkoma-cert
281 run-parts --test /etc/periodic/daily
287 systemctl restart nginx
289 # Ensure the webroot menthod and post hook is working
290 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl reload nginx'
292 # Add it to the daily cron
294 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "systemctl reload nginx"
295 ' > /etc/cron.daily/renew-akkoma-cert
296 chmod +x /etc/cron.daily/renew-akkoma-cert
298 # If everything worked the output should contain /etc/cron.daily/renew-akkoma-cert
299 run-parts --test /etc/cron.daily
302 ## Create your first user and set as admin
305 su akkoma -s $SHELL -lc "./bin/pleroma_ctl user new joeuser joeuser@sld.tld --admin"
307 This will create an account withe the username of 'joeuser' with the email address of joeuser@sld.tld, and set that user's account as an admin. This will result in a link that you can paste into the browser, which logs you in and enables you to set the password.
311 {! installation/further_reading.include !}
313 {! support.include !}