README.md: Add note about config/config.md
authorHaelwenn (lanodan) Monnier <contact@hacktivis.me>
Thu, 8 Nov 2018 13:47:04 +0000 (14:47 +0100)
committerHaelwenn (lanodan) Monnier <contact@hacktivis.me>
Sat, 10 Nov 2018 12:09:38 +0000 (13:09 +0100)
README.md

index 40c55e79a3d2bfd5508a86bd74c6259492c5d8f6..642d3e95493e0f95f5345a1bc1748034f7fc09ac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ While we don't provide docker files, other people have written very good ones. T
 
   * 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`; you may want to double-check this file in case you wanted a different username, or database name than the default. Then you need to run the script as PostgreSQL superuser (i.e. `sudo su postgres -c "psql -f config/setup_db.psql"`). It will create a pleroma db user, database and will setup needed extensions that need to be set up. Postgresql super-user privileges are only needed for this step.
 
-  * For these next steps, the default will be to run pleroma using the dev configuration file, `config/dev.secret.exs`. To run them using the prod config file, prefix each command at the shell with `MIX_ENV=prod`. For example: `MIX_ENV=prod mix phx.server`.
+  * For these next steps, the default will be to run pleroma using the dev configuration file, `config/dev.secret.exs`. To run them using the prod config file, prefix each command at the shell with `MIX_ENV=prod`. For example: `MIX_ENV=prod mix phx.server`. Documentation for the config can be found at [``config/config.md``](config/config.md)
 
   * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.