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