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.
14 #### Optional packages used in this guide
16 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
17 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
22 ### Prepare the system
24 * First update the system, if not already done:
30 * Install some of the above mentioned programs:
33 sudo pacman -S git base-devel elixir cmake
36 ### Install PostgreSQL
38 [Arch Wiki article](https://wiki.archlinux.org/index.php/PostgreSQL)
40 * Install the `postgresql` package:
43 sudo pacman -S postgresql
46 * Initialize the database cluster:
49 sudo -iu postgres initdb -D /var/lib/postgres/data
52 * Start and enable the `postgresql.service`
55 sudo systemctl enable --now postgresql.service
58 ### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
61 sudo pacman -S ffmpeg imagemagick perl-image-exiftool
66 * Add a new system user for the Pleroma service:
69 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
72 **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.
74 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
77 sudo mkdir -p /opt/pleroma
78 sudo chown -R pleroma:pleroma /opt/pleroma
79 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
82 * Change to the new directory:
88 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
91 sudo -Hu pleroma mix deps.get
94 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
95 * Answer with `yes` if it asks you to install `rebar3`.
96 * This may take some time, because parts of pleroma get compiled first.
97 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
99 * 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):
102 mv config/{generated_config.exs,prod.secret.exs}
105 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
108 sudo -Hu postgres psql -f config/setup_db.psql
111 * Now run the database migration:
114 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
117 * Now you can start Pleroma already
120 sudo -Hu pleroma MIX_ENV=prod mix phx.server
123 ### Finalize installation
125 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.
129 * Install nginx, if not already done:
135 * Create directories for available and enabled sites:
138 sudo mkdir -p /etc/nginx/sites-{available,enabled}
141 * Append the following line at the end of the `http` block in `/etc/nginx/nginx.conf`:
144 include sites-enabled/*;
147 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
150 sudo pacman -S certbot certbot-nginx
156 sudo mkdir -p /var/lib/letsencrypt/
157 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
160 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).
164 * Copy the example nginx configuration and activate it:
167 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
168 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
171 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
172 * Enable and start nginx:
175 sudo systemctl enable --now nginx.service
178 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
181 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
184 #### Other webserver/proxies
186 You can find example configurations for them in `/opt/pleroma/installation/`.
190 * Copy example service file
193 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
196 * Edit the service file and make sure that all paths fit your installation
197 * Enable and start `pleroma.service`:
200 sudo systemctl enable --now pleroma.service
203 #### Create your first user
205 If your instance is up and running, you can create your first user with administrative rights with the following task:
208 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
213 {! backend/installation/further_reading.include !}
217 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**.