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/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 * curl (to download the release build)
  24 * unzip (needed to unpack release builds)
  25 * ncurses (ERTS won't run without it)
  26 * PostgreSQL (also utilizes extensions in postgresql-contrib)
  27 * nginx (could be swapped with another reverse proxy but this guide covers only it)
  28 * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
  29
  30 Debian/Ubuntu:
  31 ```sh
  32 apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
  33 ```
  34 Alpine:
  35
  36 ```sh
  37 echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
  38 apk update
  39 apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
  40 ```
  41
  42 ## Setup
  43 ### Configuring PostgreSQL
  44 #### (Optional) Installing RUM indexes
  45
  46 !!! warning
  47     It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
  48
  49 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).
  50
  51 Debian/Ubuntu (available only on Buster/19.04):
  52 ```sh
  53 apt install postgresql-11-rum
  54 ```
  55 Alpine:
  56 ```sh
  57 apk add git build-base postgresql-dev
  58 git clone https://github.com/postgrespro/rum /tmp/rum
  59 cd /tmp/rum
  60 make USE_PGXS=1
  61 make USE_PGXS=1 install
  62 cd
  63 rm -r /tmp/rum
  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 Debian/Ubuntu:
  69 ```sh
  70 systemctl restart postgresql
  71 ```
  72 Alpine:
  73 ```sh
  74 rc-service postgresql restart
  75 ```
  76 ### Installing Pleroma
  77 ```sh
  78 # Create the 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 `arm64-musl` the command will be
  83 export FLAVOUR="arm64-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 ```sh
 137 # Get a Let's Encrypt certificate
 138 certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
 139
 140 # Copy the Pleroma nginx configuration to the nginx folder
 141 # The location of nginx configs is dependent on the distro
 142
 143 # For Debian/Ubuntu:
 144 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
 145 ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
 146 # For Alpine:
 147 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
 148 # If your distro does not have either of those you can append
 149 # `include /etc/nginx/pleroma.conf` to the end of the http section in /etc/nginx/nginx.conf and
 150 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/pleroma.conf
 151
 152 # Edit the nginx config replacing example.tld with your (sub)domain
 153 $EDITOR path-to-nginx-config
 154
 155 # Verify that the config is valid
 156 nginx -t
 157
 158 # Start nginx
 159 # For Debian/Ubuntu:
 160 systemctl start nginx
 161 # For Alpine:
 162 rc-service nginx start
 163 ```
 164
 165 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.
 166
 167 ### Setting up a system service
 168 Debian/Ubuntu:
 169 ```sh
 170 # Copy the service into a proper directory
 171 cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 172
 173 # Start pleroma and enable it on boot
 174 systemctl start pleroma
 175 systemctl enable pleroma
 176 ```
 177 Alpine:
 178 ```sh
 179 # Copy the service into a proper directory
 180 cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
 181
 182 # Start pleroma and enable it on boot
 183 rc-service pleroma start
 184 rc-update add pleroma
 185 ```
 186
 187 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.
 188
 189 Still doesn't work? Feel free to contact us on [#pleroma on freenode](https://webchat.freenode.net/?channels=%23pleroma) 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/issues/new)
 190
 191 ## Post installation
 192
 193 ### Setting up auto-renew Let's Encrypt certificate
 194 ```sh
 195 # Create the directory for webroot challenges
 196 mkdir -p /var/lib/letsencrypt
 197
 198 # Uncomment the webroot method
 199 $EDITOR path-to-nginx-config
 200
 201 # Verify that the config is valid
 202 nginx -t
 203 ```
 204 Debian/Ubuntu:
 205 ```sh
 206 # Restart nginx
 207 systemctl restart nginx
 208
 209 # Ensure the webroot menthod and post hook is working
 210 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl nginx reload'
 211
 212 # Add it to the daily cron
 213 echo '#!/bin/sh
 214 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "systemctl reload nginx"
 215 ' > /etc/cron.daily/renew-pleroma-cert
 216 chmod +x /etc/cron.daily/renew-pleroma-cert
 217
 218 # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
 219 run-parts --test /etc/cron.daily
 220 ```
 221 Alpine:
 222 ```sh
 223 # Restart nginx
 224 rc-service nginx restart
 225
 226 # Start the cron daemon and make it start on boot
 227 rc-service crond start
 228 rc-update add crond
 229
 230 # Ensure the webroot menthod and post hook is working
 231 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
 232
 233 # Add it to the daily cron
 234 echo '#!/bin/sh
 235 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "rc-service nginx reload"
 236 ' > /etc/periodic/daily/renew-pleroma-cert
 237 chmod +x /etc/periodic/daily/renew-pleroma-cert
 238
 239 # If everything worked this should output /etc/periodic/daily/renew-pleroma-cert
 240 run-parts --test /etc/periodic/daily
 241 ```
 242 ### Running mix tasks
 243 Throughout the wiki and guides there is a lot of references to mix tasks. Since `mix` is a build tool, you can't just call `mix pleroma.task`, instead you should call `pleroma_ctl` stripping pleroma/ecto namespace.
 244
 245 So for example, if the task is `mix pleroma.user set admin --admin`, you should run it like this:
 246 ```sh
 247 su pleroma -s $SHELL -lc "./bin/pleroma_ctl user set admin --admin"
 248 ```
 249
 250 ## Create your first user and set as admin
 251 ```sh
 252 cd /opt/pleroma/bin
 253 su pleroma -s $SHELL -lc "./bin/pleroma_ctl user new joeuser joeuser@sld.tld --admin"
 254 ```
 255 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.
 256
 257 ### Updating
 258 Generally, doing the following is enough:
 259 ```sh
 260 # Download the new release
 261 su pleroma -s $SHELL -lc "./bin/pleroma_ctl update"
 262
 263 # Migrate the database, you are advised to stop the instance before doing that
 264 su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
 265 ```
 266 But you should **always check the release notes/changelog** in case there are config deprecations, special update steps, etc.
 267
 268 ## Further reading
 269
 270 * [Backup your instance](../administration/backup.md)
 271 * [Hardening your instance](../configuration/hardening.md)
 272 * [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
 273 * [Updating your instance](../administration/updating.md)