Small improvements

This commit is contained in:
Baptiste Gelez 2019-04-21 22:02:42 +01:00
parent c85aabd677
commit 9d1d145751
2 changed files with 4 additions and 4 deletions

View file

@ -11,10 +11,10 @@ starting the app with `cargo run` or write them in a `.env` file to have automat
Here are the variables that Plume uses:
- `BASE_URL`: the domain name, or IP and port on which Plume is listening. It is used in all federation-related code.
- `DATABASE_URL`: the URL of the PostgreSQL database, used by Plume (`postgres://plume:plume@localhost/plume` by default with PostgreSQL, `plume.db` with SQlite).
- `MIGRATION_DIRECTORY`: The folder that stores the migration files for the database, migrations/postgres for PostgreSQL database or migrations/sqlite for SQlite database.
- `DATABASE_URL`: the URL of the database used by Plume (`postgres://plume:plume@localhost/plume` by default with PostgreSQL, `plume.db` with SQlite).
- `MIGRATION_DIRECTORY`: The folder that stores the migration files for the database, `migrations/postgres` for PostgreSQL databases or `migrations/sqlite` for SQlite databases.
- `ROCKET_ADDRESS`: the adress on which Plume should listen (`0.0.0.0` by default).
- `ROCKET_PORT`: the port on which Plume should listen ([`7878` by default](https://twitter.com/ag_dubs/status/852559264510070784))
- `ROCKET_PORT`: the port on which Plume should listen ([`7878` by default](https://twitter.com/ag_dubs/status/852559264510070784)).
- `ROCKET_SECRET_KEY`: key used to sign private cookies and for CSRF protection. If it is not set, it will be regenerated everytime you restart Plume,
meaning that all your users will get disconnected. You can generate one with `openssl rand -base64 32`.
- `SEARCH_INDEX`: the directory where the search index will be saved (`search_index` by default).

View file

@ -11,6 +11,6 @@ in this list:
<ul class="choices">
<li><a href="with/docker">Docker</a></li>
<li><a href="with/yunohost">YunoHost</a></li>
<li><a href="deps/prebuilt">Prebuilt binaries</a></li>
<li><a href="with/prebuilt">Prebuilt binaries</a></li>
<li><a href="deps">From source</a></li>
</ul>