Docs: document STAFF_REPORT_KEY env var
This commit is contained in:
@@ -56,6 +56,13 @@ Add each variable to the page indicated below:
|
||||
| `CIVI_HTTP_AUTH_PASS` | **Secrets** | Only if above set |
|
||||
| `HEALTH_TOKEN` | **Secrets** | Optional; gates `/api/health` in production |
|
||||
| `PREVIEW_ADMIN_TOKEN` | **Secrets** | Optional; gates `/api/preview-link` |
|
||||
| `STAFF_REPORT_KEY` | **Secrets** | Shared secret for `/staff/report` and `/api/staff/file` |
|
||||
|
||||
**`STAFF_REPORT_KEY`** — shared secret guarding the internal staff report
|
||||
at `/staff/report` and the file proxy at `/api/staff/file`. Store in
|
||||
Amplify SSM Parameter Store next to the `CIVI_*` secrets. Rotate by
|
||||
changing the env value; all live links must be updated. Anyone with the
|
||||
secret can view any organization's full activity history.
|
||||
|
||||
Rule of thumb: if leaking the value would let someone impersonate the app
|
||||
to CiviCRM, or bypass a gate, it goes in **Secrets**. Hostnames and
|
||||
|
||||
Reference in New Issue
Block a user