1 # Installing on Linux using OTP releases
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
7 You will be running commands as root. If you aren't root already, please elevate your priviledges by executing `sudo su`/`su`.
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.
13 Paste the following into the shell:
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"
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.
20 ### Installing the required packages
22 Other than things bundled in the OTP release Pleroma depends on:
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)
34 echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
36 apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot file-dev
41 apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot libmagic-dev
44 ### Installing optional packages
46 Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_graphics_packages.md):
53 echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
55 apk add imagemagick ffmpeg exiftool
60 apt install imagemagick ffmpeg libimage-exiftool-perl
64 ### Configuring PostgreSQL
65 #### (Optional) Installing RUM indexes
68 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
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).
74 apk add git build-base postgresql-dev
75 git clone https://github.com/postgrespro/rum /tmp/rum
78 make USE_PGXS=1 install
85 # Available only on Buster/19.04
86 apt install postgresql-11-rum
89 #### (Optional) Performance configuration
90 It is encouraged to check [Optimizing your PostgreSQL performance](../configuration/postgresql.md) document, for tips on PostgreSQL tuning.
92 Restart PostgreSQL to apply configuration changes:
96 rc-service postgresql restart
101 systemctl restart postgresql
104 ### Installing Pleroma
106 # Create a Pleroma user
107 adduser --system --shell /bin/false --home /opt/pleroma pleroma
109 # Set the flavour environment variable to the string you got in Detecting flavour section.
110 # For example if the flavour is `amd64-musl` the command will be
111 export FLAVOUR="amd64-musl"
113 # Clone the release build into a temporary directory and unpack it
114 su pleroma -s $SHELL -lc "
115 curl 'https://git.pleroma.social/api/v4/projects/2/jobs/artifacts/stable/download?job=$FLAVOUR' -o /tmp/pleroma.zip
116 unzip /tmp/pleroma.zip -d /tmp/
119 # Move the release to the home directory and delete temporary files
120 su pleroma -s $SHELL -lc "
121 mv /tmp/release/* /opt/pleroma
125 # Create uploads directory and set proper permissions (skip if planning to use a remote uploader)
126 # Note: It does not have to be `/var/lib/pleroma/uploads`, the config generator will ask about the upload directory later
128 mkdir -p /var/lib/pleroma/uploads
129 chown -R pleroma /var/lib/pleroma
131 # Create custom public files directory (custom emojis, frontend bundle overrides, robots.txt, etc.)
132 # Note: It does not have to be `/var/lib/pleroma/static`, the config generator will ask about the custom public files directory later
133 mkdir -p /var/lib/pleroma/static
134 chown -R pleroma /var/lib/pleroma
136 # Create a config directory
137 mkdir -p /etc/pleroma
138 chown -R pleroma /etc/pleroma
140 # Run the config generator
141 su pleroma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/pleroma/config.exs --output-psql /tmp/setup_db.psql"
143 # Create the postgres database
144 su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
146 # Create the database schema
147 su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
149 # If you have installed RUM indexes uncommend and run
150 # su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
152 # Start the instance to verify that everything is working as expected
153 su pleroma -s $SHELL -lc "./bin/pleroma daemon"
155 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
156 sleep 20 && curl http://localhost:4000/api/v1/instance
159 su pleroma -s $SHELL -lc "./bin/pleroma stop"
162 ### Setting up nginx and getting Let's Encrypt SSL certificaties
164 #### Get a Let's Encrypt certificate
166 certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
169 #### Copy Pleroma nginx configuration to the nginx folder
171 The location of nginx configs is dependent on the distro
175 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
180 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.conf
181 ln -s /etc/nginx/sites-available/pleroma.conf /etc/nginx/sites-enabled/pleroma.conf
184 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
186 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/pleroma.conf
189 #### Edit the nginx config
191 # Replace example.tld with your (sub)domain
192 $EDITOR path-to-nginx-config
194 # Verify that the config is valid
201 rc-service nginx start
206 systemctl start nginx
209 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.
211 ### Setting up a system service
215 # Copy the service into a proper directory
216 cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
218 # Start pleroma and enable it on boot
219 rc-service pleroma start
220 rc-update add pleroma
225 # Copy the service into a proper directory
226 cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
228 # Start pleroma and enable it on boot
229 systemctl start pleroma
230 systemctl enable pleroma
233 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.
235 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)
239 ### Setting up auto-renew of the Let's Encrypt certificate
241 # Create the directory for webroot challenges
242 mkdir -p /var/lib/letsencrypt
244 # Uncomment the webroot method
245 $EDITOR path-to-nginx-config
247 # Verify that the config is valid
254 rc-service nginx restart
256 # Start the cron daemon and make it start on boot
257 rc-service crond start
260 # Ensure the webroot menthod and post hook is working
261 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
263 # Add it to the daily cron
265 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "rc-service nginx reload"
266 ' > /etc/periodic/daily/renew-pleroma-cert
267 chmod +x /etc/periodic/daily/renew-pleroma-cert
269 # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
270 run-parts --test /etc/periodic/daily
276 systemctl restart nginx
278 # Ensure the webroot menthod and post hook is working
279 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl reload nginx'
281 # Add it to the daily cron
283 certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "systemctl reload nginx"
284 ' > /etc/cron.daily/renew-pleroma-cert
285 chmod +x /etc/cron.daily/renew-pleroma-cert
287 # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
288 run-parts --test /etc/cron.daily
291 ## Create your first user and set as admin
294 su pleroma -s $SHELL -lc "./bin/pleroma_ctl user new joeuser joeuser@sld.tld --admin"
296 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.
300 {! backend/installation/further_reading.include !}
304 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**.