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](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).
   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 * Tootdon (Android + iOS)
  17 * Tootle (iOS)
  18
  19 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.
  20
  21 ## Installation
  22
  23 ### Docker
  24
  25 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.
  26
  27 ### Dependencies
  28
  29 * Postgresql version 9.6 or newer
  30 * 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).
  31 * Build-essential tools
  32
  33 ### Configuration
  34
  35   * Run `mix deps.get` to install elixir dependencies.
  36
  37   * Run `mix pleroma.gen.instance`. This will ask you 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`, which you should run as the PostgreSQL superuser (i.e., `sudo -u postgres psql -f config/setup_db.psql`). It will create the database, user, and password you gave `mix pleroma.gen.instance` earlier, as well as set up the necessary extensions in the database. PostgreSQL superuser privileges are only needed for this step.
  38
  39   * 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`. You can also simply run `export MIX_ENV=prod` which will set this variable for the rest of the shell session.
  40
  41   * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
  42
  43   * 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.
  44
  45   * 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/>. 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.
  46
  47   * [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/`.
  48
  49 ## Running
  50
  51 * 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.
  52
  53 ### Frontends
  54 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.
  55
  56 ### As systemd service (with provided .service file)
  57 Running `service pleroma start`
  58 Logs can be watched by using `journalctl -fu pleroma.service`
  59
  60 ### Standalone/run by other means
  61 Run `mix phx.server` in repository's root, it will output log into stdout/stderr
  62
  63 ### Using an upstream proxy for federation
  64
  65 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:
  66
  67     config :pleroma, :http,
  68       proxy_url: "127.0.0.1:8123"
  69
  70 This is useful for running pleroma inside Tor or i2p.
  71
  72 ## Admin Tasks
  73
  74 ### Register a User
  75
  76 Run `mix register_user <name> <nickname> <email> <bio> <password>`. The `name` appears on statuses, while the nickname corresponds to the user, e.g. `@nickname@instance.tld`
  77
  78 ### Password reset
  79
  80 Run `mix generate_password_reset username` to generate a password reset link that you can then send to the user.
  81
  82 ### Moderators
  83
  84 You can make users moderators. They will then be able to delete any post.
  85
  86 Run `mix set_moderator username [true|false]` to make user a moderator or not.
  87
  88 ## Troubleshooting
  89
  90 ### No incoming federation
  91
  92 Check that you correctly forward the "host" header to backend. It is needed to validate signatures.