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.8+, Follow the guide to install from the Erlang Solutions repo or use [asdf](https://github.com/asdf-vm/asdf) as the pleroma user)
18 #### Optional packages used in this guide
20 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
21 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
26 ### Prepare the system
28 * First update the system, if not already done:
35 * Install some of the above mentioned programs:
38 sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-devel
41 ### Install Elixir and Erlang
43 * Download and add the Erlang repository:
46 wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_2.0_all.deb
47 sudo dpkg -i /tmp/erlang-solutions_2.0_all.deb
50 * Install Elixir and Erlang:
54 sudo apt install elixir erlang-dev erlang-nox
57 ### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md)
60 sudo apt install imagemagick ffmpeg libimage-exiftool-perl
65 * Add a new system user for the Pleroma service:
68 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
71 **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.
73 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
76 sudo mkdir -p /opt/pleroma
77 sudo chown -R pleroma:pleroma /opt/pleroma
78 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
81 * Change to the new directory:
87 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
90 sudo -Hu pleroma mix deps.get
93 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
94 * Answer with `yes` if it asks you to install `rebar3`.
95 * This may take some time, because parts of pleroma get compiled first.
96 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
98 * 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):
101 mv config/{generated_config.exs,prod.secret.exs}
104 * Generate the environment file: `sudo -Hu pleroma mix pleroma.release_env gen`
105 * Input path to env file or keep default value `./config/pleroma.env`
108 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
111 sudo -Hu postgres psql -f config/setup_db.psql
114 * Now run the database migration:
117 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
120 * Now you can start Pleroma already
123 sudo -Hu pleroma MIX_ENV=prod mix phx.server
126 ### Finalize installation
128 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.
132 * Install nginx, if not already done:
135 sudo apt install nginx
138 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
141 sudo apt install certbot
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 * Check that `EnvironmentFile` contains the correct path to the env file. Or generate the env file: `sudo -Hu pleroma mix pleroma.release_env gen`
189 * Enable and start `pleroma.service`:
192 sudo systemctl enable --now pleroma.service
195 #### Create your first user
197 If your instance is up and running, you can create your first user with administrative rights with the following task:
200 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
205 {! backend/installation/further_reading.include !}
209 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**.