1 # Installing on Arch Linux
4 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.
15 #### Optional packages used in this guide
17 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
18 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
20 ### Prepare the system
22 * First update the system, if not already done:
28 * Install some of the above mentioned programs:
31 sudo pacman -S git base-devel elixir cmake file
34 ### Install PostgreSQL
36 [Arch Wiki article](https://wiki.archlinux.org/index.php/PostgreSQL)
38 * Install the `postgresql` package:
41 sudo pacman -S postgresql
44 * Initialize the database cluster:
47 sudo -iu postgres initdb -D /var/lib/postgres/data
50 * Start and enable the `postgresql.service`
53 sudo systemctl enable --now postgresql.service
58 * Add a new system user for the Pleroma service:
61 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
64 **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.
66 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
69 sudo mkdir -p /opt/pleroma
70 sudo chown -R pleroma:pleroma /opt/pleroma
71 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
74 * Change to the new directory:
80 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
83 sudo -Hu pleroma mix deps.get
86 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
87 * Answer with `yes` if it asks you to install `rebar3`.
88 * This may take some time, because parts of pleroma get compiled first.
89 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
91 * 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):
94 mv config/{generated_config.exs,prod.secret.exs}
97 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
100 sudo -Hu postgres psql -f config/setup_db.psql
103 * Now run the database migration:
106 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
109 * Now you can start Pleroma already
112 sudo -Hu pleroma MIX_ENV=prod mix phx.server
115 ### Finalize installation
117 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.
121 * Install nginx, if not already done:
127 * Create directories for available and enabled sites:
130 sudo mkdir -p /etc/nginx/sites-{available,enabled}
133 * Append the following line at the end of the `http` block in `/etc/nginx/nginx.conf`:
136 include sites-enabled/*;
139 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
142 sudo pacman -S certbot certbot-nginx
148 sudo mkdir -p /var/lib/letsencrypt/
149 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
152 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).
156 * Copy the example nginx configuration and activate it:
159 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
160 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
163 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
164 * Enable and start nginx:
167 sudo systemctl enable --now nginx.service
170 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
173 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
176 #### Other webserver/proxies
178 You can find example configurations for them in `/opt/pleroma/installation/`.
182 * Copy example service file
185 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
188 * Edit the service file and make sure that all paths fit your installation
189 * Enable and start `pleroma.service`:
192 sudo systemctl enable --now pleroma.service
195 #### Create your first user
197 If your instance is up and running, you can create your first user with administrative rights with the following task:
200 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
205 {! backend/installation/further_reading.include !}
209 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**.