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