X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=da528e1a2ac81b2fe87ab144aac24c4478482b0e;hb=ea6d1b2b172d88b6ea47ab044813d39b053534b2;hp=57343c1514486b557e3fbc5a1fb879d9fc0ea424;hpb=44dc6948823f5e26ede427d3348fef72129f3f4d;p=akkoma

diff --git a/README.md b/README.md
index 57343c151..da528e1a2 100644
--- a/README.md
+++ b/README.md
@@ -22,12 +22,18 @@ 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.4 or newer (you will also need erlang-dev, erlang-parsetools, erlang-xmerl packages)
 * Build-essential tools
 
 ### Configuration
 
-  * 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`. You can check if your instance is configured correctly by running it with `mix phx.serve` 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.
+  * 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`. 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.
+
+  * 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.
@@ -44,3 +50,12 @@ 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.