X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=cb91f0b48ff14e5c841879e7e6b4f1e1204c5742;hb=7de3a652147d9b7da9cf3fd82d8a8438df93bae8;hp=36b4c5133e9f2248b2d60cfc31363176dca890ae;hpb=eb248cf8aa92316269a77d1234234a536627cbf8;p=akkoma diff --git a/README.md b/README.md index 36b4c5133..cb91f0b48 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,17 @@ 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. + +Mobile clients that are known to work well: + +* Twidere +* Tusky +* Pawoo (Android + iOS) +* Subway Tooter +* Amaroq (iOS) +* Tootdon (Android + 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. ## Installation @@ -43,11 +54,11 @@ Elixir will also require `make` and probably other related software for building * 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`. If it gives errors, try running again, this is a known issue. + * 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_. + * 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_. We _ONLY_ support _HTTPS_ deployments in production. You can use basic http for local dev, but _NEVER USE IT_ on an actual instance. Create the file `config/dev.secret.exs`, add these lines at the end of the file: