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
19 #### Optional packages used in this guide
21 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
22 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
24 ### Prepare the system
26 * First update the system, if not already done:
33 * Install some of the above mentioned programs:
36 sudo apt install git build-essential postgresql postgresql-contrib
39 ### Install Elixir and Erlang
41 * Download and add the Erlang repository:
44 wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb
45 sudo dpkg -i /tmp/erlang-solutions_1.0_all.deb
48 * Install Elixir and Erlang:
52 sudo apt install elixir erlang-dev erlang-parsetools erlang-xmerl erlang-tools
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:
123 sudo apt install nginx
126 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
129 sudo apt install certbot
135 sudo mkdir -p /var/lib/letsencrypt/
136 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
139 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).
143 * Copy the example nginx configuration and activate it:
146 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
147 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
150 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
151 * Enable and start nginx:
154 sudo systemctl enable --now nginx.service
157 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
160 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
163 #### Other webserver/proxies
165 You can find example configurations for them in `/opt/pleroma/installation/`.
169 * Copy example service file
172 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
175 * Edit the service file and make sure that all paths fit your installation
176 * Enable and start `pleroma.service`:
179 sudo systemctl enable --now pleroma.service
182 #### Create your first user
184 If your instance is up and running, you can create your first user with administrative rights with the following task:
187 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
192 * [Admin tasks](Admin tasks)
193 * [Backup your instance](Backup-your-instance)
194 * [Configuration tips](General tips for customizing pleroma fe)
195 * [Hardening your instance](Hardening-your-instance)
196 * [How to activate mediaproxy](How-to-activate-mediaproxy)
197 * [Small Pleroma-FE customizations](Small customizations)
198 * [Updating your instance](Updating-your-instance)
202 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**.