1 # Installing on Debian Based Distributions
4 This guide will assume you are on Debian Stretch. This guide should also work with Ubuntu 16.04 and 18.04. 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 * Download and add the Erlang repository:
28 wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_2.0_all.deb
29 sudo dpkg -i /tmp/erlang-solutions_2.0_all.deb
32 * Install Elixir and Erlang:
36 sudo apt install elixir erlang-dev erlang-nox
39 ### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
42 sudo apt install imagemagick ffmpeg libimage-exiftool-perl
47 * Add a new system user for the Pleroma service:
50 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
53 **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.
55 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
58 sudo mkdir -p /opt/pleroma
59 sudo chown -R pleroma:pleroma /opt/pleroma
60 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
63 * Change to the new directory:
69 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
72 sudo -Hu pleroma mix deps.get
75 * Generate the configuration: `sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen`
76 * Answer with `yes` if it asks you to install `rebar3`.
77 * This may take some time, because parts of pleroma get compiled first.
78 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
80 * 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):
83 sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
87 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
90 sudo -Hu postgres psql -f config/setup_db.psql
93 * Now run the database migration:
96 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
99 * Now you can start Pleroma already
102 sudo -Hu pleroma MIX_ENV=prod mix phx.server
105 ### Finalize installation
107 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.
111 * Install nginx, if not already done:
114 sudo apt install nginx
117 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
120 sudo apt install certbot
126 sudo mkdir -p /var/lib/letsencrypt/
127 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
130 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).
134 * Copy the example nginx configuration and activate it:
137 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
138 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
141 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
142 * Enable and start nginx:
145 sudo systemctl enable --now nginx.service
148 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
151 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
154 #### Other webserver/proxies
156 You can find example configurations for them in `/opt/pleroma/installation/`.
160 * Copy example service file
163 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
166 * Edit the service file and make sure that all paths fit your installation
167 * Enable and start `pleroma.service`:
170 sudo systemctl enable --now pleroma.service
173 #### Create your first user
175 If your instance is up and running, you can create your first user with administrative rights with the following task:
178 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
183 {! backend/installation/further_reading.include !}
187 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.