7 * Postgresql version 9.6 or newer
8 * Elixir version 1.4 or newer
10 * Build-essential tools
12 #### Installing dependencies on Debian system
13 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.
15 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`
17 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`
19 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.
23 * You probably want application to run as separte user - so create a new one: `adduser pleroma`, you can login as it via `su pleroma`
24 * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors)
25 * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that.
29 * You'll need to allow password-based authorisation for `postgres` superuser
30 * Changing default password for superuser is probably a good idea:
31 * Open psql shell as postgres user - while being root run `su postgres -c psql`
32 * There, enter following:
35 ALTER USER postgres with encrypted password '[PASSWORD]';
38 where [PASSWORD] is any string, no need to manually encrypt it - postgres will encrypt it automatically for you.
39 * Replace password in file `config/dev.exs` with password you supplied in previous step (look for line like `password: "postgres"`)
41 * Edit `/etc/postgresql/9.6/main/pg_hba.conf` (Assuming you have the 9.6 version) and change the line:
44 local all postgres peer
50 local all postgres md5
53 don't forget to revert it in the later step so you won't have to enter password when accessing psql console.
54 * Create and update your database with `mix ecto.create && mix ecto.migrate`. If it gives errors, try running again, this is a known issue.
55 * Undo changes you made in `/etc/postgresql/9.6/main/pg_hba.conf` (replace `md5` with `peer`)
56 * 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).
57 * Open psql shell as postgres user: (as root) `su postgres -c psql`
58 * Create a new PostgreSQL user:
63 ALTER user pleroma with encrypted password '[your password]';
64 GRANT ALL ON ALL tables IN SCHEMA public TO pleroma;
65 GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
68 * Again, change password in `config/dev.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
70 ### Some additional configuration
72 * You will need to let pleroma instance to know what hostname/url it's running on.
74 In file `config/dev.exs`, add these lines at the end of the file:
77 config :pleroma, Pleroma.Web.Endpoint,
78 url: [host: "example.tld", scheme: "https", port: 443]
81 replacing `example.tld` with your (sub)domain
83 * 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/
84 On Debian you can use `certbot` package and command to manage letsencrypt certificates.
86 * [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/`.
90 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.
92 ### As systemd service (with provided .service file)
93 Running `service pleroma start`
94 Logs can be watched by using `journalctl -fu pleroma.service`
96 ### Standalone/run by other means
97 Run `mix phx.server` in repository's root, it will output log into stdout/stderr
101 Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment).
105 * Official website: http://www.phoenixframework.org/
106 * Guides: http://phoenixframework.org/docs/overview
107 * Docs: https://hexdocs.pm/phoenix
108 * Mailing list: http://groups.google.com/group/phoenix-talk
109 * Source: https://github.com/phoenixframework/phoenix