Skip to content

Commit 346a491

Browse files
committed
Document reporting configuration
The env vars live in settings.yml, but we need to document how to set up Mavis for it.
1 parent 4b08347 commit 346a491

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,10 @@ The `private_key` will automatically be used to generate a JWK on the
324324
`/oidc/jwks` endpoint, which is used by CIS2 to validate the JWT we use to
325325
request the access token from CIS2.
326326

327+
### Reporting
328+
329+
See [docs/reporting.md](docs/releasing.md).
330+
327331
#### Key Rotation
328332

329333
Keys should be rotated regularly. When a new key is introduced it's JWK will

docs/reporting.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Reporting
2+
3+
The reporting service is a separate Python microservice as per
4+
[ADR 11](../adr/00011-develop-reporting-component-in-python.md).
5+
6+
The codebase is:
7+
8+
https://github.com/NHSDigital/manage-vaccinations-in-schools-reporting
9+
10+
For the reporting functionality, you need to run it in parallel to Mavis.
11+
12+
## Configuration
13+
14+
When developing locally, you can override the default settings in
15+
`config/settings/development.local.yml`:
16+
17+
```yml
18+
reporting_api:
19+
client_app:
20+
token_ttl_seconds: 600
21+
root_url: http://localhost:5001 # Or the URL for the reporting app
22+
client_id: match_to_.env_in_reporting
23+
secret: match_to_.env_in_reporting
24+
```

0 commit comments

Comments
 (0)