https://github.com/nhsdigital/mesh-sandbox
a sandbox for mesh testing
https://github.com/nhsdigital/mesh-sandbox
Last synced: about 12 hours ago
JSON representation
a sandbox for mesh testing
- Host: GitHub
- URL: https://github.com/nhsdigital/mesh-sandbox
- Owner: NHSDigital
- License: mit
- Created: 2022-11-10T13:25:15.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2026-01-16T09:50:22.000Z (4 days ago)
- Last Synced: 2026-01-17T06:59:52.831Z (3 days ago)
- Language: Python
- Size: 1.1 MB
- Stars: 6
- Watchers: 6
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
MESH Sandbox
===========
MESH sandbox for local testing of [NHS Digital's MESH API](https://digital.nhs.uk/developer/api-catalogue/message-exchange-for-social-care-and-health-api).
Installation
------------
Example use
-----------
pip
---
```bash
pip install mesh-sandbox
STORE_MODE=file MAILBOXES_DATA_DIR=/tmp/mesh uvicorn mesh_sandbox.api:app --reload --port 8700 --workers=1
curl http://localhost:8700/health
```
docker compose
--------------
```yaml
services:
mesh_sandbox:
build:
context: https://github.com/NHSDigital/mesh-sandbox.git#refs/tags/v1.0.4
ports:
- "8700:443"
deploy:
restart_policy:
condition: on-failure
max_attempts: 3
healthcheck:
test: curl -ksf https://localhost/health || exit 1
interval: 3s
timeout: 10s
environment:
- SHARED_KEY=TestKey
- SSL=yes
# - STORE_MODE=file # store mode file will persist data to disk
volumes:
# mount a different mailboxes.jsonl to pre created mailboxes
- ./src/mesh_sandbox/store/data/mailboxes.jsonl:/app/mesh_sandbox/store/data/mailboxes.jsonl:ro
- ./src/mesh_sandbox/test_plugin:/app/mesh_sandbox/plugins:ro
# you can mount a directory if you want access the stored messages
# - ./messages:/tmp/mesh_store
# you can also mount different server cert and key if using ssl and you need a trusted certificate
# - ./mycert.pem:/tmp/server-cert.pem:ro
# - ./mycert.key:/tmp/server-cert.key:ro
```
Guidance for contributors
-------------------------
[contributing](CONTRIBUTING.md)