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