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