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

   1 # Pleroma
   2
   3 ## About Pleroma
   4
   5 Pleroma is a microblogging server software that can federate (= exchange messages with) other servers that support the same federation standards (OStatus and ActivityPub). What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Pleroma will federate with all servers that implement either OStatus or ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.
   6
   7 Pleroma is written in Elixir, high-performance and can run on small devices like a Raspberry Pi.
   8
   9 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).
  10
  11 Mobile clients that are known to work well:
  12
  13 * Twidere
  14 * Tusky
  15 * Pawoo (Android + iOS)
  16 * Subway Tooter
  17 * Amaroq (iOS)
  18 * Tootdon (Android + iOS)
  19 * Tootle (iOS)
  20
  21 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 #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org.
  22
  23 ## Installation
  24
  25 ### Docker
  26
  27 While we don't provide docker files, other people have written very good ones. Take a look at https://github.com/Angristan/dockerfiles/tree/master/pleroma or https://github.com/sn0w/pleroma-docker.
  28
  29 ### Dependencies
  30
  31 * Postgresql version 9.6 or newer
  32 * Elixir version 1.5 or newer. If your distribution only has an old version available, check [Elixir's install page](https://elixir-lang.org/install.html) or use a tool like [asdf](https://github.com/asdf-vm/asdf).
  33 * Build-essential tools
  34
  35 ### Configuration
  36
  37   * Run `mix deps.get` to install elixir dependencies.
  38
  39   * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/generated_config.exs`. Check that and copy it to either `config/dev.secret.exs` or `config/prod.secret.exs`. It will also create a `config/setup_db.psql`; you may want to double-check this file in case you wanted a different username, or database name than the default. Then you need to run the script as PostgreSQL superuser (i.e. `sudo su postgres -c "psql -f config/setup_db.psql"`). It will create a pleroma db user, database and will setup needed extensions that need to be set up. Postgresql super-user privileges are only needed for this step.
  40
  41   * For these next steps, the default will be to run pleroma using the dev configuration file, `config/dev.secret.exs`. To run them using the prod config file, prefix each command at the shell with `MIX_ENV=prod`. For example: `MIX_ENV=prod mix phx.server`. Documentation for the config can be found at [``config/config.md``](config/config.md)
  42
  43   * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
  44
  45   * You can check if your instance is configured correctly by running it with `mix phx.server` and checking the instance info endpoint at `/api/v1/instance`. If it shows your uri, name and email correctly, you are configured correctly. If it shows something like `localhost:4000`, your configuration is probably wrong, unless you are running a local development setup.
  46
  47   * 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/
  48   The simplest way to obtain and install a certificate is to use [Certbot.](https://certbot.eff.org) Depending on your specific setup, certbot may be able to get a certificate and configure your web server automatically.
  49
  50 ## Running
  51
  52 * 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.
  53
  54 ### Frontends
  55 Pleroma comes with two frontends. The first one, Pleroma FE, can be reached by normally visiting the site. The other one, based on the Mastodon project, can be found by visiting the /web path of your site.
  56
  57 ### As systemd service (with provided .service file)
  58 Example .service file can be found in `installation/pleroma.service` you can put it in `/etc/systemd/system/`.
  59 Running `service pleroma start`
  60 Logs can be watched by using `journalctl -fu pleroma.service`
  61
  62 ### As OpenRC service (with provided RC file)
  63 Copy ``installation/init.d/pleroma`` to ``/etc/init.d/pleroma``.
  64 You can add it to the services ran by default with:
  65 ``rc-update add pleroma``
  66
  67 ### Standalone/run by other means
  68 Run `mix phx.server` in repository's root, it will output log into stdout/stderr
  69
  70 ### Using an upstream proxy for federation
  71
  72 Add the following to your `dev.secret.exs` or `prod.secret.exs` if you want to proxify all http requests that pleroma makes to an upstream proxy server:
  73
  74     config :pleroma, :http,
  75       proxy_url: "127.0.0.1:8123"
  76
  77 This is useful for running pleroma inside Tor or i2p.
  78
  79 ## Troubleshooting
  80
  81 ### No incoming federation
  82
  83 Check that you correctly forward the "host" header to backend. It is needed to validate signatures.