X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=fcf296c01c4c7b4a9c63dca698e4bc9baa76bc0a;hb=bdb5dd21943f886a1b4181aebd73e60662536e93;hp=01a56d6bfdb80af8da27d37304bb2512e42179a2;hpb=0673511d3939c04efd0e3fd350c47b4bfb3e322e;p=akkoma diff --git a/README.md b/README.md index 01a56d6bf..fcf296c01 100644 --- a/README.md +++ b/README.md @@ -22,14 +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 (you will also need erlang-dev, erlang-parsetools, erlang-xmerl packages) +* 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/dev.secret.exs` and `config/prod.secret.exs`. It will also create a `config/db_setup.psql`, which you need to run as PostgreSQL superuser (i.e. `sudo su - postgre -c "psql -f config/db_setup.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 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. @@ -50,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.