mirror of
https://codeberg.org/alicia/web-check.git
synced 2024-05-31 23:52:15 +02:00
Adds docs for rate limit env var
This commit is contained in:
parent
3f80d58085
commit
f63418039a
1
.env
1
.env
|
@ -22,4 +22,5 @@ REACT_APP_WHO_API_KEY=''
|
|||
# DISABLE_GUI='false' # Disable the GUI, and only serve the API
|
||||
# API_TIMEOUT_LIMIT='10000' # The timeout limit for API requests, in milliseconds
|
||||
# API_CORS_ORIGIN='*' # Enable CORS, by setting your allowed hostname(s) here
|
||||
# API_ENABLE_RATE_LIMIT='true' # Enable rate limiting for the API
|
||||
# REACT_APP_API_ENDPOINT='/api' # The endpoint for the API (can be local or remote)
|
||||
|
|
6
.github/README.md
vendored
6
.github/README.md
vendored
|
@ -839,10 +839,12 @@ Key | Value
|
|||
|
||||
Key | Value
|
||||
---|---
|
||||
`CHROME_PATH` | The path the Chromium executable (e.g. `/usr/bin/chromium`)
|
||||
`PORT` | Port to serve the API, when running server.js (e.g. `3000`)
|
||||
`DISABLE_GUI` | Disable the GUI, and only serve the API (e.g. `false`)
|
||||
`API_ENABLE_RATE_LIMIT` | Enable rate-limiting for the /api endpoints (e.g. `true`)
|
||||
`API_TIMEOUT_LIMIT` | The timeout limit for API requests, in milliseconds (e.g. `10000`)
|
||||
`API_CORS_ORIGIN` | Enable CORS, by setting your allowed hostname(s) here (e.g. `example.com`)
|
||||
`CHROME_PATH` | The path the Chromium executable (e.g. `/usr/bin/chromium`)
|
||||
`DISABLE_GUI` | Disable the GUI, and only serve the API (e.g. `false`)
|
||||
`REACT_APP_API_ENDPOINT` | The endpoint for the API, either local or remote (e.g. `/api`)
|
||||
|
||||
All values are optional.
|
||||
|
|
Loading…
Reference in a new issue