1 # Installing on Debian Based Distributions
4 This guide will assume you are on Debian 11 (“bullseye”) or later. This guide should also work with Ubuntu 18.04 (“Bionic Beaver”) and later. It also assumes that you have administrative rights, either as root or a user with [sudo permissions](https://www.digitalocean.com/community/tutorials/how-to-add-delete-and-grant-sudo-privileges-to-users-on-a-debian-vps). 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.
6 {! backend/installation/generic_dependencies.include !}
10 * First update the system, if not already done:
17 * Install some of the above mentioned programs:
20 sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev
23 ### Install Elixir and Erlang
25 * Install Elixir and Erlang (you might need to use backports or [asdf](https://github.com/asdf-vm/asdf) on old systems):
29 sudo apt install elixir erlang-dev erlang-nox
33 ### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
36 sudo apt install imagemagick ffmpeg libimage-exiftool-perl
41 * Add a new system user for the Pleroma service:
44 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
47 **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.
49 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
52 sudo mkdir -p /opt/pleroma
53 sudo chown -R pleroma:pleroma /opt/pleroma
54 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
57 * Change to the new directory:
63 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
66 sudo -Hu pleroma mix deps.get
69 * Generate the configuration: `sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen`
70 * Answer with `yes` if it asks you to install `rebar3`.
71 * This may take some time, because parts of pleroma get compiled first.
72 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
74 * 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):
77 sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
81 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
84 sudo -Hu postgres psql -f config/setup_db.psql
87 * Now run the database migration:
90 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
93 * Now you can start Pleroma already
96 sudo -Hu pleroma MIX_ENV=prod mix phx.server
99 ### Finalize installation
101 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.
105 * Install nginx, if not already done:
108 sudo apt install nginx
111 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
114 sudo apt install certbot
120 sudo mkdir -p /var/lib/letsencrypt/
121 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
124 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).
128 * Copy the example nginx configuration and activate it:
131 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
132 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
135 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
136 * Enable and start nginx:
139 sudo systemctl enable --now nginx.service
142 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
145 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
148 #### Other webserver/proxies
150 You can find example configurations for them in `/opt/pleroma/installation/`.
154 * Copy example service file
157 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
160 * Edit the service file and make sure that all paths fit your installation
161 * Enable and start `pleroma.service`:
164 sudo systemctl enable --now pleroma.service
167 #### Create your first user
169 If your instance is up and running, you can create your first user with administrative rights with the following task:
172 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
177 {! backend/installation/further_reading.include !}
181 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.