diff options
| -rw-r--r-- | README.md | 39 |
1 files changed, 24 insertions, 15 deletions
@@ -4,19 +4,19 @@ ### Dependencies -* Postgresql version 9.5 or newer +* Postgresql version 9.6 or newer * Elixir version 1.4 or newer * NodeJS LTS * Build-essential tools #### Installing dependencies on Debian system -PostgreSQL 9.6 should be available on debian stable (Jessie) from "main" area. Install it using apt: `apt install postgresql-9.6`. Make sure that older versions are not installed, debian allows multiple versions to coexist but still runs only one version. +PostgreSQL 9.6 should be available on Debian stable (Jessie) from "main" area. Install it using apt: `apt install postgresql-9.6`. Make sure that older versions are not installed since Debian allows multiple versions to coexist but still runs only one version. You must install elixir 1.4+ from elixir-lang.org, because Debian repos only have 1.3.x version. You will need to add apt repo to sources.list(.d) and import GPG key. Follow instructions here: https://elixir-lang.org/install.html#unix-and-unix-like (See "Ubuntu or Debian 7"). This should be valid until Debian updates elixir in their repositories. Package you want is named `elixir`, so install it using `apt install elixir` Elixir will also require `make` and probably other related software for building dependencies - in case you don't have them, get them via `apt install build-essential` -NodeJS is available as `nodejs` package on debian. `apt install nodejs`. Debian stable has 4.8.x version. If that does not work, use nodesource's repo https://github.com/nodesource/distributions#deb - version 5.x confirmed to work. +NodeJS is available as `nodejs` package on Debian. `apt install nodejs`. Debian stable has 4.8.x version. If that does not work, use nodesource's repo https://github.com/nodesource/distributions#deb - version 5.x confirmed to work. ### Preparation @@ -24,15 +24,21 @@ NodeJS is available as `nodejs` package on debian. `apt install nodejs`. Debian * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors) * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that. -### Database preparation +### Database setup * You'll need to allow password-based authorisation for `postgres` superuser - * changing default password for superuser is probably a good idea: + * Changing default password for superuser is probably a good idea: * Open psql shell as postgres user - while being root run `su postgres -c psql` - * There, enter following: `ALTER USER postgres with encrypted password '<PASSWORD>';` - where <PASSWORD> is just any string, no need to manually encrypt it, postgres will encrypt it automatically for you. + * There, enter following: + + ```sql + ALTER USER postgres with encrypted password '<PASSWORD>'; + ``` + + where <PASSWORD> is any string, no need to manually encrypt it - postgres will encrypt it automatically for you. * Replace password in file `config/dev.exs` with password you supplied in previous step (look for line like `password: "postgres"`) - * edit `/etc/postgresql/9.6/main/pg_hba.conf` (Assuming you have 9.6 version) and change the line: + * Edit `/etc/postgresql/9.6/main/pg_hba.conf` (Assuming you have the 9.6 version) and change the line: ``` local all postgres peer @@ -47,7 +53,7 @@ NodeJS is available as `nodejs` package on debian. `apt install nodejs`. Debian don't forget to revert it in the later step so you won't have to enter password when accessing psql console. * Create and update your database with `mix ecto.create && mix ecto.migrate`. If it gives errors, try running again, this is a known issue. * Undo changes you made in `/etc/postgresql/9.6/main/pg_hba.conf` (replace `md5` with `peer`) - * You most likely don't want having some application accessing database as superuser, so you need to create separate user for that. Right now it must be done manually (issue #27). + * You most likely don't want having some application accessing database as a superuser, so you should create separate user for Pleroma. Right now it must be done manually (issue #27). * Open psql shell as postgres user: (as root) `su postgres -c psql` * Create a new PostgreSQL user: @@ -74,18 +80,21 @@ NodeJS is available as `nodejs` package on debian. `apt install nodejs`. Debian replacing `example.tld` with your (sub)domain - * The common and convenient way for adding HTTPS is by using nginx as reverse proxy. You can look at example nginx configuration in `installation/pleroma.nginx`. If you need TLS/SSL certificates for HTTPS, you can look get some for free with letsencrypt: https://letsencrypt.org/ - On debian you can use `certbot` package and command to manage letsencrypt certificates. + * The common and convenient way for adding HTTPS is by using Nginx as a reverse proxy. You can look at example Nginx configuration in `installation/pleroma.nginx`. If you need TLS/SSL certificates for HTTPS, you can look get some for free with letsencrypt: https://letsencrypt.org/ + On Debian you can use `certbot` package and command to manage letsencrypt certificates. - * (not tested with reboots yet!) You'll also want to set up Pleroma to be run as a systemd service. Example .service can be found in `installation/pleroma.service` you can put it in `/etc/systemd/system/`. - Start pleroma by running `service pleroma start` - Logs can be watched by using `journalctl -fu pleroma.service` + * [Not tested with system reboot yet!] You'll also want to set up Pleroma to be run as a systemd service. Example .service file can be found in `installation/pleroma.service` you can put it in `/etc/systemd/system/`. - * Without systemd you can start Pleroma by starting Phoenix endpoint with `mix phx.server` +## Running -In any case, it should be available on 4000 port on localhost and proxied to 443 port by nginx. +By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you it on same machine). In case of an error it will restart automatically. +### As systemd service (with provided .service file) +Running `service pleroma start` +Logs can be watched by using `journalctl -fu pleroma.service` +### Standalone/run by other means +Run `mix phx.server` in repository's root, it will output log into stdout/stderr # Phoenix info |