Merge pull request #47 from mprasil/limits

Add limits configuration to the readme
This commit is contained in:
Daniel García 2018-06-30 17:48:34 +02:00 committed by GitHub
commit 4fcdf33621
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions

View File

@ -67,6 +67,15 @@ You could also set the `SIGNUPS_ALLOWED` environment variable. To do that when u
-e SIGNUPS_ALLOWED=false -e SIGNUPS_ALLOWED=false
``` ```
## Changing the API request size limit
By default the API calls are limited to 10MB. This should be sufficient for most cases, however if you want to support large imports, this might be limiting you. On the other hand you might want to limit the request size to something smaller than that to prevent API abuse and possible DOS attack, especially if running with limited resources.
To set the limit, you can use the `ROCKET_LIMITS` variable. Example here shows 10MB limit for posted json in the body (this is the default):
```
-e ROCKET_LIMITS={json=10485760}
```
## Enabling HTTPS ## Enabling HTTPS
To enable HTTPS, you need to configure the `ROCKET_TLS` option, the same way as `SIGNUPS_ALLOWED`. To enable HTTPS, you need to configure the `ROCKET_TLS` option, the same way as `SIGNUPS_ALLOWED`.