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

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