5 Pleroma is an OStatus-compatible social networking server written in Elixir, compatible with GNU Social and Mastodon. It is high-performance and can run on small devices like a Raspberry Pi.
7 For clients it supports both the [GNU Social API with Qvitter extensions](https://twitter-api.readthedocs.io/en/latest/index.html) and the [Mastodon client API](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md).
9 Mobile clients that are known to work well:
13 * Pawoo (Android + iOS)
16 * Tootdon (Android + iOS)
18 No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at https://matrix.heldscal.la/#/room/#pleromafe:matrix.heldscal.la.
24 * Postgresql version 9.6 or newer
25 * Elixir version 1.4 or newer
26 * Build-essential tools
28 #### Installing dependencies on Debian system
29 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.
31 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`
33 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`
37 * You probably want application to run as separte user - so create a new one: `adduser pleroma`, you can login as it via `su pleroma`
38 * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors)
39 * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that.
43 * Create a database user and database for pleroma
44 * Open psql shell as postgres user: (as root) `su postgres -c psql`
45 * Create a new PostgreSQL user:
50 ALTER user pleroma with encrypted password '<your password>';
51 GRANT ALL ON ALL tables IN SCHEMA public TO pleroma;
52 GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
55 * Create `config/dev.secret.exs` and copy the database settings from `dev.exs` there.
56 * Change password in `config/dev.secret.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
57 * Create and update your database with `mix ecto.create && mix ecto.migrate`.
59 ### Some additional configuration
61 * You will need to let pleroma instance to know what hostname/url it's running on. _THIS IS THE MOST IMPORTANT STEP. GET THIS WRONG AND YOU'LL HAVE TO RESET YOUR DATABASE_. We _ONLY_ support _HTTPS_ deployments in production. You can use basic http for local dev, but _NEVER USE IT_ on an actual instance.
63 Create the file `config/dev.secret.exs`, add these lines at the end of the file:
66 config :pleroma, Pleroma.Web.Endpoint,
67 url: [host: "example.tld", scheme: "https", port: 443]
70 replacing `example.tld` with your (sub)domain
72 * You should also setup your site name and admin email address. Look at config.exs for more available options.
75 config :pleroma, :instance,
76 name: "My great instance",
77 email: "someone@example.com"
80 * 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/
81 On Debian you can use `certbot` package and command to manage letsencrypt certificates.
83 * [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/`.
87 By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you are on the same machine). In case of an error it will restart automatically.
89 ### As systemd service (with provided .service file)
90 Running `service pleroma start`
91 Logs can be watched by using `journalctl -fu pleroma.service`
93 ### Standalone/run by other means
94 Run `mix phx.server` in repository's root, it will output log into stdout/stderr