Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into develop

[akkoma] / README.md

diff --git a/README.md b/README.md
index 664b8b47548f950d6eed6781535095c47376f4c7..3d909e776a120ad43a4c59913e58216a133938a7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@ Mobile clients that are known to work well:
 * 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 #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org.
 
@@ -22,7 +23,7 @@ No release has been made yet, but several servers have been online for months al
 ### Dependencies
 
 * Postgresql version 9.6 or newer
-* Elixir version 1.4 or newer (you will also need erlang-dev, erlang-parsetools, erlang-xmerl packages)
+* Elixir version 1.5 or newer
 * Build-essential tools
 
 ### Configuration
@@ -50,3 +51,24 @@ Logs can be watched by using `journalctl -fu pleroma.service`
 
 ### 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.