Restrict public by recipients.

[akkoma] / README.md

diff --git a/README.md b/README.md
index b07593f67c5192d585ccf58bbdc2753e55d82945..b9449ad8682bf392aecb34cf1a6e45454bd7d0b3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,16 +22,14 @@ 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
+* Elixir version 1.5 or newer
 * Build-essential tools
 
 ### Configuration
 
   * Run `mix deps.get` to install elixir dependencies.
 
-  * 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`.
-
-  * Configure your database settings in `{dev,prod}.secret.exs` and either create the database with psql or run `mix ecto.create`.
+  * 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.
 
   * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
 
@@ -52,3 +50,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.