TRX/Checkmate
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #3826 from Glazzze/docs/clarify-mongodb-deployment-3823

Browse Source 
docs(readme): clarify MongoDB requirement for single-image deployment
This commit is contained in:
Alexander Holliday authored and GitHub committed 2026-08-07 09:27:11 -07:00
2 parents 514ee0d30b 94f1f7e576
commit 4b921f4986
1 file changed
+3 -1
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -1
View File
@@ -80,7 +80,9 @@ Usage instructions can be found [here](https://checkmate.so/docs).
<a id="installation"></a>
## Installation
The quickest way to run Checkmate is the reference Docker Compose file, which runs the all-in-one image (`ghcr.io/bluewave-labs/checkmate`) plus MongoDB:
The quickest way to run Checkmate is the reference Docker Compose file. It starts two services: the all-in-one Checkmate application image (`ghcr.io/bluewave-labs/checkmate`) and a separate MongoDB service.
> **What “all-in-one” means:** the Checkmate application is packaged in a single image; MongoDB is not embedded in that image and remains required. The reference Compose file starts MongoDB for you. For custom deployments, configure `DB_CONNECTION_STRING` to use an external MongoDB instance.
```bash
curl -O https://raw.githubusercontent.com/bluewave-labs/checkmate/master/docker/docker-compose.yaml