Skip to content

Commit 6abd9a0

Browse files
committed
Document NBSS_MESH_* environment variables
1 parent c5f048a commit 6abd9a0

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/infrastructure/environment-variables.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,30 @@ Specifies the Django environment configuration. This variable controls environme
127127
- When not set to "production", enables the `nonprod` Django app which provides development utilities
128128
- The `seed_demo_data` management command checks this env var to prevent execution in production environments
129129

130+
## NBSS_MESH_INBOX_NAME [Secret]
131+
132+
Description: Inbox identifier for NBSS MESH data. Used in conjunction with other `NBSS_MESH_*` variables to connect.
133+
134+
To rotate: Contact NHS service desk to make request for new MESH inbox.
135+
136+
## NBSS_MESH_PASSWORD [Secret]
137+
138+
Description: Inbox password for NBSS MESH data. Used in conjunction with other `NBSS_MESH_*` variables to connect.
139+
140+
To rotate: Contact NHS service desk to make request for password change.
141+
142+
## NBSS_MESH_CERT [Secret]
143+
144+
Description: SSL Cert in PEM format used to connect to MESH inbox. Used in conjunction with `NBSS_MESH_PRIVATE_KEY` for SSL connections to MESH.
145+
146+
To rotate: Contact NHS service desk to make request for new MESH inbox keystore.
147+
148+
## NBSS_MESH_PRIVATE_KEY [Secret]
149+
150+
Description: SSL private key in PEM format used to connect to MESH inbox. Used in conjunction with `NBSS_MESH_CERT` for SSL connections to MESH.
151+
152+
To rotate: Contact NHS service desk to make request for new MESH inbox keystore.
153+
130154
## NHS_NOTIFY_API_KEY [Secret]
131155

132156
Description: API Key used in HMAC signature verification when processing callback HTTP requests from NHS Notify API.

0 commit comments

Comments
 (0)