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.
8 * `postgresql` (9.6+, Ubuntu 16.04 comes with 9.5, you can get a newer version from [here](https://www.postgresql.org/download/linux/ubuntu/))
9 * `postgresql-contrib` (9.6+, same situtation as above)
10 * `elixir` (1.5+, [install from here, Debian and Ubuntu ship older versions](https://elixir-lang.org/install.html#unix-and-unix-like) or use [asdf](https://github.com/asdf-vm/asdf) as the pleroma user)
14 * `erlang-eldap`, if you want to enable ldap authenticator
20 #### Optional packages used in this guide
22 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
23 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
25 ### Prepare the system
27 * First update the system, if not already done:
34 * Install some of the above mentioned programs:
37 sudo apt install git build-essential postgresql postgresql-contrib
40 ### Install Elixir and Erlang
42 * Download and add the Erlang repository:
45 wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb
46 sudo dpkg -i /tmp/erlang-solutions_1.0_all.deb
49 * Install Elixir and Erlang:
53 sudo apt install elixir erlang-dev erlang-parsetools erlang-xmerl erlang-tools erlang-ssh
58 * Add a new system user for the Pleroma service:
61 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
64 **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.
66 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
69 sudo mkdir -p /opt/pleroma
70 sudo chown -R pleroma:pleroma /opt/pleroma
71 sudo -Hu pleroma git clone https://git.pleroma.social/pleroma/pleroma /opt/pleroma
74 * Change to the new directory:
80 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
83 sudo -Hu pleroma mix deps.get
86 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
87 * Answer with `yes` if it asks you to install `rebar3`.
88 * This may take some time, because parts of pleroma get compiled first.
89 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
91 * 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):
94 mv config/{generated_config.exs,prod.secret.exs}
97 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
100 sudo -Hu postgres psql -f config/setup_db.psql
103 * Now run the database migration:
106 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
109 * Now you can start Pleroma already
112 sudo -Hu pleroma MIX_ENV=prod mix phx.server
115 ### Finalize installation
117 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.
121 * Install nginx, if not already done:
124 sudo apt install nginx
127 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
130 sudo apt install certbot
136 sudo mkdir -p /var/lib/letsencrypt/
137 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
140 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).
144 * Copy the example nginx configuration and activate it:
147 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
148 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
151 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
152 * Enable and start nginx:
155 sudo systemctl enable --now nginx.service
158 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
161 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
164 #### Other webserver/proxies
166 You can find example configurations for them in `/opt/pleroma/installation/`.
170 * Copy example service file
173 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
176 * Edit the service file and make sure that all paths fit your installation
177 * Enable and start `pleroma.service`:
180 sudo systemctl enable --now pleroma.service
183 #### Create your first user
185 If your instance is up and running, you can create your first user with administrative rights with the following task:
188 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
193 * [Admin tasks](Admin tasks)
194 * [Backup your instance](Backup-your-instance)
195 * [Configuration tips](General tips for customizing pleroma fe)
196 * [Hardening your instance](Hardening-your-instance)
197 * [How to activate mediaproxy](How-to-activate-mediaproxy)
198 * [Small Pleroma-FE customizations](Small customizations)
199 * [Updating your instance](Updating-your-instance)
203 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**.