scott/crabfit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add docs for FRONTEND_URL env var

Browse source
This commit is contained in:
Ben Grant 2023-05-16 02:42:01 +10:00
parent fc18e6f85b
commit f78d762999
4 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
api/README.md
View file

@ -25,6 +25,12 @@ Some adaptors require environment variables to be set. You can specify them in a
See [adding an adaptor](adaptors/README.md#adding-an-adaptor) in the adaptors readme.
## Cleanup task
## Environment
### CORS
In release mode, a `FRONTEND_URL` environment variable is required to correctly restrict cross-origin requests to the frontend.
### Cleanup task
By default, anyone can run the cleanup task at `/tasks/cleanup`. This is usually not an issue, as it's based on when the events were last visited, and not when it's run, but if you'd prefer to restrict runs of the cleanup task (as it can be intensive), set a `CRON_KEY` environment variable in `.env`. This will require sending an `X-Cron-Key` header to the route with a value that matches `CRON_KEY`, or the route will return a 401 Unauthorized error.