Skip to content

Commit

Permalink
Document configuration a bit and increase JSON size limit to 10MB
Browse files Browse the repository at this point in the history
  • Loading branch information
dani-garcia committed Jun 29, 2018
1 parent 64ac81b commit 6aab2ae
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions Rocket.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[global.limits]
json = 10485760 # 10 MiB

0 comments on commit 6aab2ae

Please sign in to comment.