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 #
 105 config :pleroma, Pleroma.Repo,
 106 prepare: :named,
 107 parameters: [
 108   plan_cache_mode: "force_custom_plan"
 109 ]
 110 ```
 111
 112 ### Installing Pleroma
 113 ```sh
 114 # Create a Pleroma user
 115 adduser --system --shell  /bin/false --home /opt/pleroma pleroma
 116
 117 # Set the flavour environment variable to the string you got in Detecting flavour section.
 118 # For example if the flavour is `amd64-musl` the command will be
 119 export FLAVOUR="amd64-musl"
 120
 121 # Clone the release build into a temporary directory and unpack it
 122 su pleroma -s $SHELL -lc "
 123 curl 'https://git.pleroma.social/api/v4/projects/2/jobs/artifacts/stable/download?job=$FLAVOUR' -o /tmp/pleroma.zip
 124 unzip /tmp/pleroma.zip -d /tmp/
 125 "
 126
 127 # Move the release to the home directory and delete temporary files
 128 su pleroma -s $SHELL -lc "
 129 mv /tmp/release/* /opt/pleroma
 130 rmdir /tmp/release
 131 rm /tmp/pleroma.zip
 132 "
 133 # Create uploads directory and set proper permissions (skip if planning to use a remote uploader)
 134 # Note: It does not have to be `/var/lib/pleroma/uploads`, the config generator will ask about the upload directory later
 135
 136 mkdir -p /var/lib/pleroma/uploads
 137 chown -R pleroma /var/lib/pleroma
 138
 139 # Create custom public files directory (custom emojis, frontend bundle overrides, robots.txt, etc.)
 140 # Note: It does not have to be `/var/lib/pleroma/static`, the config generator will ask about the custom public files directory later
 141 mkdir -p /var/lib/pleroma/static
 142 chown -R pleroma /var/lib/pleroma
 143
 144 # Create a config directory
 145 mkdir -p /etc/pleroma
 146 chown -R pleroma /etc/pleroma
 147
 148 # Run the config generator
 149 su pleroma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/pleroma/config.exs --output-psql /tmp/setup_db.psql"
 150
 151 # Create the postgres database
 152 su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
 153
 154 # Create the database schema
 155 su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
 156
 157 # If you have installed RUM indexes uncommend and run
 158 # su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
 159
 160 # Start the instance to verify that everything is working as expected
 161 su pleroma -s $SHELL -lc "./bin/pleroma daemon"
 162
 163 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
 164 sleep 20 && curl http://localhost:4000/api/v1/instance
 165
 166 # Stop the instance
 167 su pleroma -s $SHELL -lc "./bin/pleroma stop"
 168 ```
 169
 170 ### Setting up nginx and getting Let's Encrypt SSL certificaties
 171
 172 #### Get a Let's Encrypt certificate
 173 ```sh
 174 certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
 175 ```
 176
 177 #### Copy Pleroma nginx configuration to the nginx folder
 178
 179 The location of nginx configs is dependent on the distro
 180
 181 === "Alpine"
 182     ```
 183     cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
 184     ```
 185
 186 === "Debian/Ubuntu"
 187     ```
 188     cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.conf
 189     ln -s /etc/nginx/sites-available/pleroma.conf /etc/nginx/sites-enabled/pleroma.conf
 190     ```
 191
 192 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
 193 ```sh
 194 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/pleroma.conf
 195 ```
 196
 197 #### Edit the nginx config
 198 ```sh
 199 # Replace example.tld with your (sub)domain
 200 $EDITOR path-to-nginx-config
 201
 202 # Verify that the config is valid
 203 nginx -t
 204 ```
 205 #### Start nginx
 206
 207 === "Alpine"
 208     ```
 209     rc-service nginx start
 210     ```
 211
 212 === "Debian/Ubuntu"
 213     ```
 214     systemctl start nginx
 215     ```
 216
 217 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.
 218
 219 ### Setting up a system service
 220
 221 === "Alpine"
 222     ```
 223     # Copy the service into a proper directory
 224     cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
 225
 226     # Start pleroma and enable it on boot
 227     rc-service pleroma start
 228     rc-update add pleroma
 229     ```
 230
 231 === "Debian/Ubuntu"
 232     ```
 233     # Copy the service into a proper directory
 234     cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 235
 236     # Start pleroma and enable it on boot
 237     systemctl start pleroma
 238     systemctl enable pleroma
 239     ```
 240
 241 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.
 242
 243 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)
 244
 245 ## Post installation
 246
 247 ### Setting up auto-renew of the Let's Encrypt certificate
 248 ```sh
 249 # Create the directory for webroot challenges
 250 mkdir -p /var/lib/letsencrypt
 251
 252 # Uncomment the webroot method
 253 $EDITOR path-to-nginx-config
 254
 255 # Verify that the config is valid
 256 nginx -t
 257 ```
 258
 259 === "Alpine"
 260     ```
 261     # Restart nginx
 262     rc-service nginx restart
 263
 264     # Start the cron daemon and make it start on boot
 265     rc-service crond start
 266     rc-update add crond
 267
 268     # Ensure the webroot menthod and post hook is working
 269     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
 270
 271     # Add it to the daily cron
 272     echo '#!/bin/sh
 273     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "rc-service nginx reload"
 274     ' > /etc/periodic/daily/renew-pleroma-cert
 275     chmod +x /etc/periodic/daily/renew-pleroma-cert
 276
 277     # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
 278     run-parts --test /etc/periodic/daily
 279     ```
 280
 281 === "Debian/Ubuntu"
 282     ```
 283     # Restart nginx
 284     systemctl restart nginx
 285
 286     # Ensure the webroot menthod and post hook is working
 287     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl reload nginx'
 288
 289     # Add it to the daily cron
 290     echo '#!/bin/sh
 291     certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "systemctl reload nginx"
 292     ' > /etc/cron.daily/renew-pleroma-cert
 293     chmod +x /etc/cron.daily/renew-pleroma-cert
 294
 295     # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
 296     run-parts --test /etc/cron.daily
 297     ```
 298
 299 ## Create your first user and set as admin
 300 ```sh
 301 cd /opt/pleroma/bin
 302 su pleroma -s $SHELL -lc "./bin/pleroma_ctl user new joeuser joeuser@sld.tld --admin"
 303 ```
 304 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.
 305
 306 ## Further reading
 307
 308 {! backend/installation/further_reading.include !}
 309
 310 ## Questions
 311
 312 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**.
 313