1 # Installing on Arch Linux
3 {! backend/installation/otp_vs_from_source_source.include !}
7 This guide will assume that you have administrative rights, either as root or a user with [sudo permissions](https://wiki.archlinux.org/index.php/Sudo). If you want to run this guide with root, ignore the `sudo` at the beginning of the lines, unless it calls a user like `sudo -Hu pleroma`; in this case, use `su <username> -s $SHELL -c 'command'` instead.
18 #### Optional packages used in this guide
20 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
21 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
26 ### Prepare the system
28 * First update the system, if not already done:
34 * Install some of the above mentioned programs:
37 sudo pacman -S git base-devel elixir cmake file
40 ### Install PostgreSQL
42 [Arch Wiki article](https://wiki.archlinux.org/index.php/PostgreSQL)
44 * Install the `postgresql` package:
47 sudo pacman -S postgresql
50 * Initialize the database cluster:
53 sudo -iu postgres initdb -D /var/lib/postgres/data
56 * Start and enable the `postgresql.service`
59 sudo systemctl enable --now postgresql.service
62 ### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md))
65 sudo pacman -S ffmpeg imagemagick perl-image-exiftool
70 * Add a new system user for the Pleroma service:
73 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
76 **Note**: To execute a single command as the Pleroma system user, use `sudo -Hu pleroma command`. You can also switch to a shell by using `sudo -Hu pleroma $SHELL`. If you don’t have and want `sudo` on your system, you can use `su` as root user (UID 0) for a single command by using `su -l pleroma -s $SHELL -c 'command'` and `su -l pleroma -s $SHELL` for starting a shell.
78 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
81 sudo mkdir -p /opt/pleroma
82 sudo chown -R pleroma:pleroma /opt/pleroma
83 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
86 * Change to the new directory:
92 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
95 sudo -Hu pleroma mix deps.get
98 * Generate the configuration: `sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen`
99 * Answer with `yes` if it asks you to install `rebar3`.
100 * This may take some time, because parts of pleroma get compiled first.
101 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
103 * Check the configuration and if all looks right, rename it, so Pleroma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances):
106 sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
109 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
112 sudo -Hu postgres psql -f config/setup_db.psql
115 * Now run the database migration:
118 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
121 * Now you can start Pleroma already
124 sudo -Hu pleroma MIX_ENV=prod mix phx.server
127 ### Finalize installation
129 If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Pleroma and you should consider to create a systemd service file for Pleroma.
133 * Install nginx, if not already done:
139 * Create directories for available and enabled sites:
142 sudo mkdir -p /etc/nginx/sites-{available,enabled}
145 * Append the following line at the end of the `http` block in `/etc/nginx/nginx.conf`:
148 include sites-enabled/*;
151 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
154 sudo pacman -S certbot certbot-nginx
160 sudo mkdir -p /var/lib/letsencrypt/
161 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
164 If that doesn’t work, make sure, that nginx is not already running. If it still doesn’t work, try setting up nginx first (change ssl “on” to “off” and try again).
168 * Copy the example nginx configuration and activate it:
171 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
172 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
175 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
176 * Enable and start nginx:
179 sudo systemctl enable --now nginx.service
182 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
185 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
188 #### Other webserver/proxies
190 You can find example configurations for them in `/opt/pleroma/installation/`.
194 * Copy example service file
197 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
200 * Edit the service file and make sure that all paths fit your installation
201 * Enable and start `pleroma.service`:
204 sudo systemctl enable --now pleroma.service
207 #### Create your first user
209 If your instance is up and running, you can create your first user with administrative rights with the following task:
212 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
217 {! backend/installation/further_reading.include !}
221 Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.