X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;ds=inline;f=README.md;h=31d2a27549b409b49dd758e7eac300ff0cf43f86;hb=bcc4e73e51fb59c1cf924cdef8ccf317bc3971e9;hp=5aa520526b838a764684a2cc54602cb65f18273e;hpb=dd676a36c1f8ceb383b5e169db5d38578a307ced;p=akkoma diff --git a/README.md b/README.md index 5aa520526..31d2a2754 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,18 @@ 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: +Mobile clients that are known to work well: * Twidere * Tusky -* Pawoo (Android) +* 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. +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 @@ -52,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: