git.squeep.com Git - akkoma/blob - README.md

   1 # Pleroma
   2
   3 ## About Pleroma
   4
   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.
   6
   7 For clients it supports both the GNU Social API with Qvitter extensions and the Mastodon client API.
   8
   9 Mobile clients that are known to work well:
  10
  11 * Twidere
  12 * Tusky
  13 * Pawoo (Android + iOS)
  14 * Subway Tooter
  15 * Amaroq (iOS)
  16
  17 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.
  18
  19 ## Installation
  20
  21 ### Dependencies
  22
  23 * Postgresql version 9.6 or newer
  24 * Elixir version 1.4 or newer
  25 * Build-essential tools
  26
  27 #### Installing dependencies on Debian system
  28 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.
  29
  30 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`
  31
  32 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`
  33
  34 ### Preparation
  35
  36   * You probably want application to run as separte user - so create a new one: `adduser pleroma`, you can login as it via `su pleroma`
  37   * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors)
  38   * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that.
  39
  40 ### Database setup
  41
  42   * Create a database user and database for pleroma
  43      * Open psql shell as postgres user: (as root) `su postgres -c psql`
  44      * Create a new PostgreSQL user:
  45
  46      ```sql
  47      \c pleroma_dev
  48      CREATE user pleroma;
  49      ALTER user pleroma with encrypted password '<your password>';
  50      GRANT ALL ON ALL tables IN SCHEMA public TO pleroma;
  51      GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
  52      ```
  53
  54      * Create `config/dev.secret.exs` and copy the database settings from `dev.exs` there.
  55      * Change password in `config/dev.secret.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
  56      * Create and update your database with `mix ecto.create && mix ecto.migrate`.
  57
  58 ### Some additional configuration
  59
  60   * 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_.
  61
  62     Create the file `config/dev.secret.exs`, add these lines at the end of the file:
  63
  64     ```elixir
  65     config :pleroma, Pleroma.Web.Endpoint,
  66     url: [host: "example.tld", scheme: "https", port: 443]
  67     ```
  68
  69     replacing `example.tld` with your (sub)domain
  70
  71   * You should also setup your site name and admin email address. Look at config.exs for more available options.
  72
  73     ```elixir
  74     config :pleroma, :instance,
  75       name: "My great instance",
  76       email: "someone@example.com"
  77     ```
  78
  79   * 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/
  80   On Debian you can use `certbot` package and command to manage letsencrypt certificates.
  81
  82   * [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/`.
  83
  84 ## Running
  85
  86 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.
  87
  88 ### As systemd service (with provided .service file)
  89 Running `service pleroma start`
  90 Logs can be watched by using `journalctl -fu pleroma.service`
  91
  92 ### Standalone/run by other means
  93 Run `mix phx.server` in repository's root, it will output log into stdout/stderr