Plume/docs/ENV-VARS.md

# Useful Environment Variables

Plume relies on some environment variables for some configuration options. You can either set them before
starting the app with `cargo run` or write them in a `.env` file to have automatically loaded.

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.
- `USE_HTTPS`: if it is `0`, federation and medias will be using HTTP by default (`1` by default).
- `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_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`.

## Diesel

Diesel, the tool we use to run migrations may be configured with the `DATABASE_URL` which should contain the URL of the
PostgreSQL database. Otherwise, you can specify `--database-url YOUR-URL` everytime you run a `diesel` command.
Document env vars 2018-09-04 19:51:08 +02:00			`# Useful Environment Variables`

			`Plume relies on some environment variables for some configuration options. You can either set them before`
			starting the app with `cargo run` or write them in a `.env` file to have automatically loaded.

			`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.
Replace DB_URL with DATABASE_URL This way it is shared with diesel, which simplifies a lot the setup Also fixes a few issues in the documentation, that are not directly related 2018-10-06 20:17:36 +02:00			- `DATABASE_URL`: the URL of the PostgreSQL database, used by Plume (`postgres://plume:plume@localhost/plume` by default with PostgreSQL, `plume.db` with SQlite).
Adding MIGRATION_DIRECTORY 2018-10-22 20:17:27 +02:00			- `MIGRATION_DIRECTORY`: The folder that stores the migration files for the database, migrations/postgres for PostgreSQL database or migrations/sqlite for SQlite database.
Document env vars 2018-09-04 19:51:08 +02:00			- `USE_HTTPS`: if it is `0`, federation and medias will be using HTTP by default (`1` by default).
			- `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_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`.

			`## Diesel`

			Diesel, the tool we use to run migrations may be configured with the `DATABASE_URL` which should contain the URL of the
			PostgreSQL database. Otherwise, you can specify `--database-url YOUR-URL` everytime you run a `diesel` command.