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/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:
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)
32 apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
36 echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
38 apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
42 ### Configuring PostgreSQL
43 #### (Optional) Installing RUM indexes
44 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](config.html#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).
46 Debian/Ubuntu (available only on Buster/19.04):
48 apt install postgresql-11-rum
52 apk add gcc make git postgresql-dev musl-dev
53 git clone https://github.com/postgrespro/rum /tmp/rum
56 make USE_PGXS=1 install
60 #### (Optional) Performance configuration
61 For optimal performance, you may use [PGTune](https://pgtune.leopard.in.ua), don't forget to restart postgresql after editing the configuration
65 systemctl restart postgresql
69 rc-service postgresql restart
71 ### Installing Pleroma
73 # Create the Pleroma user
74 adduser --system --shell /bin/false --home /opt/pleroma pleroma
76 # Set the flavour environment variable to the string you got in Detecting flavour section.
77 # For example if the flavour is `arm64-musl` the command will be
78 export FLAVOUR="arm64-musl"
80 # Clone the release build into a temporary directory and unpack it
81 su pleroma -s $SHELL -lc "
82 curl 'https://git.pleroma.social/api/v4/projects/2/jobs/artifacts/master/download?job=$FLAVOUR' -o /tmp/pleroma.zip
83 unzip /tmp/pleroma.zip -d /tmp/
86 # Move the release to the home directory and delete temporary files
87 su pleroma -s $SHELL -lc "
88 mv /tmp/release/* /opt/pleroma
92 # Create uploads directory and set proper permissions (skip if planning to use a remote uploader)
93 # Note: It does not have to be `/var/lib/pleroma/uploads`, the config generator will ask about the upload directory later
95 mkdir -p /var/lib/pleroma/uploads
96 chown -R pleroma /var/lib/pleroma
98 # Create custom public files directory (custom emojis, frontend bundle overrides, robots.txt, etc.)
99 # Note: It does not have to be `/var/lib/pleroma/static`, the config generator will ask about the custom public files directory later
100 mkdir -p /var/lib/pleroma/static
101 chown -R pleroma /var/lib/pleroma
103 # Create a config directory
104 mkdir -p /etc/pleroma
105 chown -R pleroma /etc/pleroma
107 # Run the config generator
108 su pleroma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/pleroma/config.exs --output-psql /tmp/setup_db.psql"
110 # Create the postgres database
111 su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
113 # If you have installed RUM indexes add
114 # `config :pleroma, :database, rum_enabled: true`
115 # to the end of /etc/pleroma/config.exs before proceeding
117 # Create the database schema
118 su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
120 # If you have installed RUM indexes uncommend and run
121 # su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
123 # Start the instance to verify that everything is working as expected
124 su pleroma -s $SHELL -lc "./bin/pleroma daemon"
126 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
127 sleep 20 && curl http://localhost:4000/api/v1/instance
130 su pleroma -s $SHELL -lc "./bin/pleroma stop"
133 ### Setting up nginx and getting Let's Encrypt SSL certificaties
136 # Get a Let's Encrypt certificate
137 certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
139 # Copy the Pleroma nginx configuration to the nginx folder
140 # The location of nginx configs is dependent on the distro
143 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
144 ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
146 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
147 # If your distro does not have either of those you can append
148 # `include /etc/nginx/pleroma.conf` to the end of the http section in /etc/nginx/nginx.conf and
149 cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/pleroma.conf
151 # Edit the nginx config replacing example.tld with your (sub)domain
152 $EDITOR path-to-the-config
154 # Verify that the config is valid
159 systemctl start nginx
161 rc-service nginx start
164 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 ### Setting up a system service
169 # Copy the service into a proper directory
170 cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
172 # Start pleroma and enable it on boot
173 systemctl start pleroma
174 systemctl enable pleroma
178 # Copy the service into a proper directory
179 cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
181 # Start pleroma and enable it on boot
182 rc-service pleroma start
183 rc-update add pleroma
186 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 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)
192 ### Setting up auto-renew Let's Encrypt certificate
193 ### Running Mix tasks