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