From 6aab2ae6c895b333365ee6c395ca5749cbdd69f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Garc=C3=ADa?= Date: Fri, 29 Jun 2018 23:11:15 +0200 Subject: [PATCH] Document configuration a bit and increase JSON size limit to 10MB --- README.md | 24 ++++++++++++++++++++++++ Rocket.toml | 2 ++ 2 files changed, 26 insertions(+) create mode 100644 Rocket.toml diff --git a/README.md b/README.md index da7f2e26..d80b48c6 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,30 @@ cargo run ``` Then visit [http://localhost:80](http://localhost:80) +# Configuration +The available configuration options are documented in the default `.env` file, and they can be modified by uncommenting the desired options in that file or by setting their respective environment variables. + +Note: the environment variables override the values set in the `.env` file. + +## Disabling user registrations +To disable user registrations, you can uncomment the `SIGNUPS_ALLOWED` line in the `.env` file and change the value to `false`. + +You could also set the `SIGNUPS_ALLOWED` environment variable. To do that when using Docker, add the following line to the end of the `docker run` command: +``` +-e SIGNUPS_ALLOWED=false +``` + +## Enabling HTTPS +To enable HTTPS, you need to configure the `ROCKET_TLS` option, the same way as `SIGNUPS_ALLOWED`. + +The values to the option must follow the format: +``` +ROCKET_TLS={certs="/path/to/certs.pem",key="/path/to/key.pem"} +``` +Where: +- certs: a path to a certificate chain in PEM format +- key: a path to a private key file in PEM format for the certificate in certs + ## How to recreate database schemas (for developers) Install diesel-cli with cargo: ```sh diff --git a/Rocket.toml b/Rocket.toml new file mode 100644 index 00000000..e8409cb3 --- /dev/null +++ b/Rocket.toml @@ -0,0 +1,2 @@ +[global.limits] +json = 10485760 # 10 MiB