git.squeep.com Git - akkoma/blob - docs/installation/otp_en.md

   1 # Installing on Linux using OTP releases
   2
   3 {! backend/installation/otp_vs_from_source.include !}
   4
   5 This guide covers a installation using an OTP release. To install Akkoma from source, please check out the corresponding guide for your distro.
   6
   7 ## Pre-requisites
   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 * A (sub)domain pointed to the machine
  10
  11 You will be running commands as root. If you aren't root already, please elevate your priviledges by executing `sudo su`/`su`.
  12
  13 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.
  14
  15 ### Detecting flavour
  16
  17 Paste the following into the shell:
  18 ```sh
  19 arch="$(uname -m)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;fi;echo "$arch$libc_postfix"
  20 ```
  21
  22 If your platform is supported the output will contain the flavour string, you will need it later. If not, this just means that we don't build releases for your platform, you can still try installing from source.
  23
  24 ### Installing the required packages
  25
  26 Other than things bundled in the OTP release Akkoma depends on:
  27
  28 * curl (to download the release build)
  29 * unzip (needed to unpack release builds)
  30 * ncurses (ERTS won't run without it)
  31 * PostgreSQL (also utilizes extensions in postgresql-contrib)
  32 * nginx (could be swapped with another reverse proxy but this guide covers only it)
  33 * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
  34 * libmagic/file
  35
  36 === "Alpine"
  37     ```
  38     awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
  39     apk update
  40     apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot file-dev
  41     ```
  42
  43 === "Debian/Ubuntu"
  44     ```
  45     apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot libmagic-dev
  46     ```
  47
  48 ### Installing optional packages
  49
  50 Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_graphics_packages.md):
  51   * ImageMagick
  52   * ffmpeg
  53   * exiftool
  54
  55 === "Alpine"
  56     ```
  57     apk update
  58     apk add imagemagick ffmpeg exiftool
  59     ```
  60
  61 === "Debian/Ubuntu"
  62     ```
  63     apt install imagemagick ffmpeg libimage-exiftool-perl
  64     ```
  65
  66 ## Setup
  67 ### Configuring PostgreSQL
  68 #### (Optional) Installing RUM indexes
  69
  70 !!! warning
  71     It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
  72
  73 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).
  74
  75 === "Alpine"
  76     ```
  77     apk add git build-base postgresql-dev
  78     git clone https://github.com/postgrespro/rum /tmp/rum
  79     cd /tmp/rum
  80     make USE_PGXS=1
  81     make USE_PGXS=1 install
  82     cd
  83     rm -r /tmp/rum
  84     ```
  85
  86 === "Debian/Ubuntu"
  87     ```
  88     # Available only on Buster/19.04
  89     apt install postgresql-11-rum
  90     ```
  91
  92 #### (Optional) Performance configuration
  93 It is encouraged to check [Optimizing your PostgreSQL performance](../configuration/postgresql.md) document, for tips on PostgreSQL tuning.
  94
  95 Restart PostgreSQL to apply configuration changes:
  96
  97 === "Alpine"
  98     ```
  99     rc-service postgresql restart
 100     ```
 101
 102 === "Debian/Ubuntu"
 103     ```
 104     systemctl restart postgresql
 105     ```
 106
 107 ### Installing Akkoma
 108 ```sh
 109 # Create a Akkoma user
 110 adduser --system --shell  /bin/false --home /opt/akkoma akkoma
 111
 112 # Set the flavour environment variable to the string you got in Detecting flavour section.
 113 # For example if the flavour is `amd64-musl` the command will be
 114 export FLAVOUR="amd64-musl"
 115
 116 # Clone the release build into a temporary directory and unpack it
 117 su akkoma -s $SHELL -lc "
 118 curl 'https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-$FLAVOUR.zip' -o /tmp/akkoma.zip
 119 unzip /tmp/akkoma.zip -d /tmp/
 120 "
 121
 122 # Move the release to the home directory and delete temporary files
 123 su akkoma -s $SHELL -lc "
 124 mv /tmp/release/* /opt/akkoma
 125 rmdir /tmp/release
 126 rm /tmp/akkoma.zip
 127 "
 128 # Create uploads directory and set proper permissions (skip if planning to use a remote uploader)
 129 # Note: It does not have to be `/var/lib/akkoma/uploads`, the config generator will ask about the upload directory later
 130
 131 mkdir -p /var/lib/akkoma/uploads
 132 chown -R akkoma /var/lib/akkoma
 133
 134 # Create custom public files directory (custom emojis, frontend bundle overrides, robots.txt, etc.)
 135 # Note: It does not have to be `/var/lib/akkoma/static`, the config generator will ask about the custom public files directory later
 136 mkdir -p /var/lib/akkoma/static
 137 chown -R akkoma /var/lib/akkoma
 138
 139 # Create a config directory
 140 mkdir -p /etc/akkoma
 141 chown -R akkoma /etc/akkoma
 142
 143 # Run the config generator
 144 su akkoma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/akkoma/config.exs --output-psql /tmp/setup_db.psql"
 145
 146 # Create the postgres database
 147 su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
 148
 149 # Create the database schema
 150 su akkoma -s $SHELL -lc "./bin/pleroma_ctl migrate"
 151
 152 # If you have installed RUM indexes uncommend and run
 153 # su akkoma -s $SHELL -lc "./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
 154
 155 # Start the instance to verify that everything is working as expected
 156 su akkoma -s $SHELL -lc "./bin/pleroma daemon"
 157
 158 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
 159 sleep 20 && curl http://localhost:4000/api/v1/instance
 160
 161 # Stop the instance
 162 su akkoma -s $SHELL -lc "./bin/pleroma stop"
 163 ```
 164
 165 ### Setting up nginx and getting Let's Encrypt SSL certificaties
 166
 167 #### Get a Let's Encrypt certificate
 168 ```sh
 169 certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
 170 ```
 171
 172 #### Copy Akkoma nginx configuration to the nginx folder
 173
 174 The location of nginx configs is dependent on the distro
 175
 176 === "Alpine"
 177     ```
 178     cp /opt/akkoma/installation/akkoma.nginx /etc/nginx/conf.d/akkoma.conf
 179     ```
 180
 181 === "Debian/Ubuntu"
 182     ```
 183     cp /opt/akkoma/installation/akkoma.nginx /etc/nginx/sites-available/akkoma.conf
 184     ln -s /etc/nginx/sites-available/akkoma.conf /etc/nginx/sites-enabled/akkoma.conf
 185     ```
 186
 187 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
 188 ```sh
 189 cp /opt/akkoma/installation/akkoma.nginx /etc/nginx/akkoma.conf
 190 ```
 191
 192 #### Edit the nginx config
 193 ```sh
 194 # Replace example.tld with your (sub)domain
 195 $EDITOR path-to-nginx-config
 196
 197 # Verify that the config is valid
 198 nginx -t
 199 ```
 200 #### Start nginx
 201
 202 === "Alpine"
 203     ```
 204     rc-service nginx start
 205     ```
 206
 207 === "Debian/Ubuntu"
 208     ```
 209     systemctl start nginx
 210     ```
 211
 212 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.
 213
 214 ### Setting up a system service
 215
 216 === "Alpine"
 217     ```
 218     # Copy the service into a proper directory
 219     cp /opt/akkoma/installation/init.d/akkoma /etc/init.d/akkoma
 220
 221     # Start akkoma and enable it on boot
 222     rc-service akkoma start
 223     rc-update add akkoma
 224     ```
 225
 226 === "Debian/Ubuntu"
 227     ```
 228     # Copy the service into a proper directory
 229     cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
 230
 231     # Start akkoma and enable it on boot
 232     systemctl start akkoma
 233     systemctl enable akkoma
 234     ```
 235
 236 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.
 237
 238 Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC, you can also [file an issue on our Gitea](https://akkoma.dev/AkkomaGang/akkoma/issues).
 239
 240 ## Post installation
 241
 242 ### Setting up auto-renew of the Let's Encrypt certificate
 243 ```sh
 244 # Create the directory for webroot challenges
 245 mkdir -p /var/lib/letsencrypt
 246
 247 # Uncomment the webroot method
 248 $EDITOR path-to-nginx-config
 249
 250 # Verify that the config is valid
 251 nginx -t
 252 ```
 253
 254 === "Alpine"
 255     ```
 256     # Restart nginx
 257     rc-service nginx restart
 258
 259     # Start the cron daemon and make it start on boot
 260     rc-service crond start
 261     rc-update add crond
 262
 263     # Ensure the webroot menthod and post hook is working
 264     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
 265
 266     # Add it to the daily cron
 267     echo '#!/bin/sh
 268     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "rc-service nginx reload"
 269     ' > /etc/periodic/daily/renew-akkoma-cert
 270     chmod +x /etc/periodic/daily/renew-akkoma-cert
 271
 272     # If everything worked the output should contain /etc/cron.daily/renew-akkoma-cert
 273     run-parts --test /etc/periodic/daily
 274     ```
 275
 276 === "Debian/Ubuntu"
 277     ```
 278     # Restart nginx
 279     systemctl restart nginx
 280
 281     # Ensure the webroot menthod and post hook is working
 282     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl reload nginx'
 283
 284     # Add it to the daily cron
 285     echo '#!/bin/sh
 286     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "systemctl reload nginx"
 287     ' > /etc/cron.daily/renew-akkoma-cert
 288     chmod +x /etc/cron.daily/renew-akkoma-cert
 289
 290     # If everything worked the output should contain /etc/cron.daily/renew-akkoma-cert
 291     run-parts --test /etc/cron.daily
 292     ```
 293
 294 ## Create your first user and set as admin
 295 ```sh
 296 cd /opt/akkoma
 297 su akkoma -s $SHELL -lc "./bin/pleroma_ctl user new joeuser joeuser@sld.tld --admin"
 298 ```
 299 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.
 300
 301 ## Further reading
 302
 303 {! backend/installation/further_reading.include !}
 304
 305 ## Questions
 306
 307 If you encounter any issues or have questions regarding the install process, feel free to ask at [meta.akkoma.dev](https://meta.akkoma.dev/).