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)
19 ### Prepare the system
21 * First update the system, if not already done:
27 * Install some of the above mentioned programs:
30 sudo pacman -S git base-devel elixir erlang-unixodbc
33 ### Install PostgreSQL
35 [Arch Wiki article](https://wiki.archlinux.org/index.php/PostgreSQL)
37 * Install the `postgresql` package:
40 sudo pacman -S postgresql
43 * Initialize the database cluster:
46 sudo -iu postgres initdb -D /var/lib/postgres/data
49 * Start and enable the `postgresql.service`
52 sudo systemctl enable --now postgresql.service
57 * Add a new system user for the Pleroma service:
60 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
63 **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.
65 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
68 sudo mkdir -p /opt/pleroma
69 sudo chown -R pleroma:pleroma /opt/pleroma
70 sudo -Hu pleroma git clone https://git.pleroma.social/pleroma/pleroma /opt/pleroma
73 * Change to the new directory:
79 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
82 sudo -Hu pleroma mix deps.get
85 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
86 * Answer with `yes` if it asks you to install `rebar3`.
87 * This may take some time, because parts of pleroma get compiled first.
88 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
90 * 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):
93 mv config/{generated_config.exs,prod.secret.exs}
96 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
99 sudo -Hu postgres psql -f config/setup_db.psql
102 * Now run the database migration:
105 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
108 * Now you can start Pleroma already
111 sudo -Hu pleroma MIX_ENV=prod mix phx.server
114 ### Finalize installation
116 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.
120 * Install nginx, if not already done:
126 * Create directories for available and enabled sites:
129 sudo mkdir -p /etc/nginx/sites-{available,enabled}
132 * Append the following line at the end of the `http` block in `/etc/nginx/nginx.conf`:
135 include sites-enabled/*;
138 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
141 sudo pacman -S certbot certbot-nginx
147 sudo mkdir -p /var/lib/letsencrypt/
148 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
151 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).
155 * Copy the example nginx configuration and activate it:
158 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
159 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
162 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
163 * Enable and start nginx:
166 sudo systemctl enable --now nginx.service
169 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
172 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
175 #### Other webserver/proxies
177 You can find example configurations for them in `/opt/pleroma/installation/`.
181 * Copy example service file
184 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
187 * Edit the service file and make sure that all paths fit your installation
188 * Enable and start `pleroma.service`:
191 sudo systemctl enable --now pleroma.service
194 #### Create your first user
196 If your instance is up and running, you can create your first user with administrative rights with the following task:
199 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
204 * [Admin tasks](Admin tasks)
205 * [Backup your instance](Backup-your-instance)
206 * [Configuration tips](General tips for customizing pleroma fe)
207 * [Hardening your instance](Hardening-your-instance)
208 * [How to activate mediaproxy](How-to-activate-mediaproxy)
209 * [Small Pleroma-FE customizations](Small customizations)
210 * [Updating your instance](Updating-your-instance)
214 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**.