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

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