1 # Installing on CentOS 7
4 This guide is a step-by-step installation guide for CentOS 7. 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-create-a-sudo-user-on-centos-quickstart). 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+, CentOS 7 comes with 9.2, we will install version 11 in this guide)
16 #### Optional packages used in this guide
18 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
19 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
21 ### Prepare the system
23 * First update the system, if not already done:
29 * Install some of the above mentioned programs:
32 sudo yum install wget git unzip
35 * Install development tools:
38 sudo yum group install "Development Tools"
41 ### Install Elixir and Erlang
46 sudo yum install epel-release
50 * Install Erlang repository:
53 wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions-1.0-1.noarch.rpm
54 sudo rpm -Uvh erlang-solutions-1.0-1.noarch.rpm
60 sudo yum install erlang erlang-parsetools erlang-xmerl
63 * Download [latest Elixir release from Github](https://github.com/elixir-lang/elixir/releases/tag/v1.8.1) (Example for the newest version at the time when this manual was written)
66 wget -P /tmp/ https://github.com/elixir-lang/elixir/releases/download/v1.8.1/Precompiled.zip
69 * Create folder where you want to install Elixir, we’ll use:
72 sudo mkdir -p /opt/elixir
75 * Unzip downloaded file there:
78 sudo unzip /tmp/Precompiled.zip -d /opt/elixir
81 * Create symlinks for the pre-compiled binaries:
84 for e in elixir elixirc iex mix; do sudo ln -s /opt/elixir/bin/${e} /usr/local/bin/${e}; done
87 ### Install PostgreSQL
89 * Add the Postgresql repository:
92 sudo yum install https://download.postgresql.org/pub/repos/yum/11/redhat/rhel-7-x86_64/pgdg-centos11-11-2.noarch.rpm
95 * Install the Postgresql server:
98 sudo yum install postgresql11-server postgresql11-contrib
101 * Initialize database:
104 sudo /usr/pgsql-11/bin/postgresql-11-setup initdb
107 * Open configuration file `/var/lib/pgsql/11/data/pg_hba.conf` and change the following lines from:
110 # IPv4 local connections:
111 host all all 127.0.0.1/32 ident
112 # IPv6 local connections:
113 host all all ::1/128 ident
119 # IPv4 local connections:
120 host all all 127.0.0.1/32 md5
121 # IPv6 local connections:
122 host all all ::1/128 md5
125 * Enable and start postgresql server:
128 sudo systemctl enable --now postgresql-11.service
131 ### Install PleromaBE
133 * Add a new system user for the Pleroma service:
136 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
139 **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.
141 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
144 sudo mkdir -p /opt/pleroma
145 sudo chown -R pleroma:pleroma /opt/pleroma
146 sudo -Hu pleroma git clone https://git.pleroma.social/pleroma/pleroma /opt/pleroma
149 * Change to the new directory:
155 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
158 sudo -Hu pleroma mix deps.get
161 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
162 * Answer with `yes` if it asks you to install `rebar3`.
163 * This may take some time, because parts of pleroma get compiled first.
164 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
166 * 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):
169 mv config/{generated_config.exs,prod.secret.exs}
172 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
175 sudo -Hu postgres psql -f config/setup_db.psql
178 * Now run the database migration:
181 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
184 * Now you can start Pleroma already
187 sudo -Hu pleroma MIX_ENV=prod mix phx.server
190 ### Finalize installation
192 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.
196 * Install nginx, if not already done:
199 sudo yum install nginx
202 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
205 sudo yum install certbot-nginx
211 sudo mkdir -p /var/lib/letsencrypt/
212 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
215 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).
219 * Copy the example nginx configuration to the nginx folder
222 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
225 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
226 * Enable and start nginx:
229 sudo systemctl enable --now nginx
232 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
235 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
238 #### Other webserver/proxies
240 You can find example configurations for them in `/opt/pleroma/installation/`.
244 * Copy example service file
247 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
250 * Edit the service file and make sure that all paths fit your installation
251 * Enable and start `pleroma.service`:
254 sudo systemctl enable --now pleroma.service
257 #### Create your first user
259 If your instance is up and running, you can create your first user with administrative rights with the following task:
262 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
267 * [Admin tasks](Admin tasks)
268 * [Backup your instance](Backup-your-instance)
269 * [Configuration tips](General tips for customizing pleroma fe)
270 * [Hardening your instance](Hardening-your-instance)
271 * [How to activate mediaproxy](How-to-activate-mediaproxy)
272 * [Small Pleroma-FE customizations](Small customizations)
273 * [Updating your instance](Updating-your-instance)
277 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**.