git.squeep.com Git - akkoma/blob - docs/installation/debian_based_en.md

   1 # Installing on Debian Based Distributions
   2 ## Installation
   3
   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.
   5
   6 ### Required packages
   7
   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)
  11 * `erlang-dev`
  12 * `erlang-nox`
  13 * `git`
  14 * `build-essential`
  15 * `cmake`
  16
  17 #### Optional packages used in this guide
  18
  19 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
  20 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
  21
  22 ### Prepare the system
  23
  24 * First update the system, if not already done:
  25
  26 ```shell
  27 sudo apt update
  28 sudo apt full-upgrade
  29 ```
  30
  31 * Install some of the above mentioned programs:
  32
  33 ```shell
  34 sudo apt install git build-essential postgresql postgresql-contrib cmake
  35 ```
  36
  37 ### Install Elixir and Erlang
  38
  39 * Download and add the Erlang repository:
  40
  41 ```shell
  42 wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_2.0_all.deb
  43 sudo dpkg -i /tmp/erlang-solutions_2.0_all.deb
  44 ```
  45
  46 * Install Elixir and Erlang:
  47
  48 ```shell
  49 sudo apt update
  50 sudo apt install elixir erlang-dev erlang-nox
  51 ```
  52
  53 ### Install PleromaBE
  54
  55 * Add a new system user for the Pleroma service:
  56
  57 ```shell
  58 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
  59 ```
  60
  61 **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.
  62
  63 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
  64
  65 ```shell
  66 sudo mkdir -p /opt/pleroma
  67 sudo chown -R pleroma:pleroma /opt/pleroma
  68 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
  69 ```
  70
  71 * Change to the new directory:
  72
  73 ```shell
  74 cd /opt/pleroma
  75 ```
  76
  77 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
  78
  79 ```shell
  80 sudo -Hu pleroma mix deps.get
  81 ```
  82
  83 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
  84   * Answer with `yes` if it asks you to install `rebar3`.
  85   * This may take some time, because parts of pleroma get compiled first.
  86   * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
  87
  88 * 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):
  89
  90 ```shell
  91 mv config/{generated_config.exs,prod.secret.exs}
  92 ```
  93
  94 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
  95
  96 ```shell
  97 sudo -Hu postgres psql -f config/setup_db.psql
  98 ```
  99
 100 * Now run the database migration:
 101
 102 ```shell
 103 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
 104 ```
 105
 106 * Now you can start Pleroma already
 107
 108 ```shell
 109 sudo -Hu pleroma MIX_ENV=prod mix phx.server
 110 ```
 111
 112 ### Finalize installation
 113
 114 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.
 115
 116 #### Nginx
 117
 118 * Install nginx, if not already done:
 119
 120 ```shell
 121 sudo apt install nginx
 122 ```
 123
 124 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
 125
 126 ```shell
 127 sudo apt install certbot
 128 ```
 129
 130 and then set it up:
 131
 132 ```shell
 133 sudo mkdir -p /var/lib/letsencrypt/
 134 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
 135 ```
 136
 137 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).
 138
 139 ---
 140
 141 * Copy the example nginx configuration and activate it:
 142
 143 ```shell
 144 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
 145 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
 146 ```
 147
 148 * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
 149 * Enable and start nginx:
 150
 151 ```shell
 152 sudo systemctl enable --now nginx.service
 153 ```
 154
 155 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
 156
 157 ```shell
 158 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
 159 ```
 160
 161 #### Other webserver/proxies
 162
 163 You can find example configurations for them in `/opt/pleroma/installation/`.
 164
 165 #### Systemd service
 166
 167 * Copy example service file
 168
 169 ```shell
 170 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 171 ```
 172
 173 * Edit the service file and make sure that all paths fit your installation
 174 * Enable and start `pleroma.service`:
 175
 176 ```shell
 177 sudo systemctl enable --now pleroma.service
 178 ```
 179
 180 #### Create your first user
 181
 182 If your instance is up and running, you can create your first user with administrative rights with the following task:
 183
 184 ```shell
 185 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 186 ```
 187
 188 #### Further reading
 189
 190 {! backend/installation/further_reading.include !}
 191
 192 ## Questions
 193
 194 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**.