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.
-For clients it supports both the GNU Social API with Qvitter extensions and the Mastodon client API.
+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).
Mobile clients that are known to work well:
* Pawoo (Android + iOS)
* Subway Tooter
* Amaroq (iOS)
+* Tootdon (Android + iOS)
+* Tootle (iOS)
-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.
+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.
## Installation
### Dependencies
* Postgresql version 9.6 or newer
-* Elixir version 1.4 or newer
+* Elixir version 1.5 or newer
* Build-essential tools
-#### Installing dependencies on Debian system
-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.
+### Configuration
-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`
+ * Run `mix deps.get` to install elixir dependencies.
-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`
+ * 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`, which you need to run as PostgreSQL superuser (i.e. `sudo su postgres -c "psql -f config/setup_db.psql"`). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.
-### Preparation
+ * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
- * You probably want application to run as separte user - so create a new one: `adduser pleroma`, you can login as it via `su pleroma`
- * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors)
- * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that.
-
-### Database setup
-
- * Create a database user and database for pleroma
- * Open psql shell as postgres user: (as root) `su postgres -c psql`
- * Create a new PostgreSQL user:
-
- ```sql
- \c pleroma_dev
- CREATE user pleroma;
- ALTER user pleroma with encrypted password '<your password>';
- GRANT ALL ON ALL tables IN SCHEMA public TO pleroma;
- GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
- ```
-
- * Create `config/dev.secret.exs` and copy the database settings from `dev.exs` there.
- * Change password in `config/dev.secret.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
- * Create and update your database with `mix ecto.create && mix ecto.migrate`.
-
-### Some additional configuration
-
- * 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_.
-
- Create the file `config/dev.secret.exs`, add these lines at the end of the file:
-
- ```elixir
- config :pleroma, Pleroma.Web.Endpoint,
- url: [host: "example.tld", scheme: "https", port: 443]
- ```
-
- replacing `example.tld` with your (sub)domain
-
- * You should also setup your site name and admin email address. Look at config.exs for more available options.
-
- ```elixir
- config :pleroma, :instance,
- name: "My great instance",
- email: "someone@example.com"
- ```
+ * 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.
* 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/
On Debian you can use `certbot` package and command to manage letsencrypt certificates.
### Standalone/run by other means
Run `mix phx.server` in repository's root, it will output log into stdout/stderr
+
+### Using an upstream proxy for federation
+
+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:
+
+ config :pleroma, :http,
+ proxy_url: "127.0.0.1:8123"
+
+This is useful for running pleroma inside Tor or i2p.
+
+## Admin Tasks
+
+### Password reset
+
+Run `mix generate_password_reset username` to generate a password reset link that you can then send to the user.
+
+### Moderators
+
+You can make users moderators. They will then be able to delete any post.
+
+Run `mix set_moderator username [true|false]` to make user a moderator or not.
projects / akkoma / blobdiff