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.
13 #### Optional packages used in this guide
15 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
16 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
18 ### Prepare the system
20 * First update the system, if not already done:
26 * Install some of the above mentioned programs:
29 sudo pacman -S git base-devel elixir
32 ### Install PostgreSQL
34 [Arch Wiki article](https://wiki.archlinux.org/index.php/PostgreSQL)
36 * Install the `postgresql` package:
39 sudo pacman -S postgresql
42 * Initialize the database cluster:
45 sudo -iu postgres initdb -D /var/lib/postgres/data
48 * Start and enable the `postgresql.service`
51 sudo systemctl enable --now postgresql.service
56 * Add a new system user for the Pleroma service:
59 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
62 **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.
64 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
67 sudo mkdir -p /opt/pleroma
68 sudo chown -R pleroma:pleroma /opt/pleroma
69 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
72 * Change to the new directory:
78 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
81 sudo -Hu pleroma mix deps.get
84 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
85 * Answer with `yes` if it asks you to install `rebar3`.
86 * This may take some time, because parts of pleroma get compiled first.
87 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
89 * 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):
92 mv config/{generated_config.exs,prod.secret.exs}
95 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
98 sudo -Hu postgres psql -f config/setup_db.psql
101 * Now run the database migration:
104 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
107 * Now you can start Pleroma already
110 sudo -Hu pleroma MIX_ENV=prod mix phx.server
113 ### Finalize installation
115 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.
119 * Install nginx, if not already done:
125 * Create directories for available and enabled sites:
128 sudo mkdir -p /etc/nginx/sites-{available,enabled}
131 * Append the following line at the end of the `http` block in `/etc/nginx/nginx.conf`:
134 include sites-enabled/*;
137 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
140 sudo pacman -S certbot certbot-nginx
146 sudo mkdir -p /var/lib/letsencrypt/
147 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
150 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).
154 * Copy the example nginx configuration and activate it:
157 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
158 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
161 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
162 * Enable and start nginx:
165 sudo systemctl enable --now nginx.service
168 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
171 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
174 #### Other webserver/proxies
176 You can find example configurations for them in `/opt/pleroma/installation/`.
180 * Copy example service file
183 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
186 * Edit the service file and make sure that all paths fit your installation
187 * Enable and start `pleroma.service`:
190 sudo systemctl enable --now pleroma.service
193 #### Create your first user
195 If your instance is up and running, you can create your first user with administrative rights with the following task:
198 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
203 {! backend/installation/further_reading.include !}
207 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**.