Remove the docker-compose file and simply add it as a suggestion
All checks were successful
Test, Build and Publish / test (push) Successful in 35s
Test, Build and Publish / build-and-push-images (push) Successful in 1m15s

This commit is contained in:
Marc Di Luzio 2024-08-25 23:21:44 +01:00
parent 7afa5086fd
commit c6e252a82a

View file

@ -60,7 +60,17 @@ An example for how to do this may look like this:
```bash
docker run -v --env-file=.env ./.matchy:/usr/src/app/.matchy forge.mdiluz.io/mdiluz/matchy:latest
```
A [`docker-compose.yml`](docker-compose.yml) file is also provided that essentially performs the above when used with `docker compose up --exit-code-from matchy`. A `MATCHY_DATA` envar can be used in conjunction with compose to set a custom local path for the location of the data file.
### Docker compose
Matchy can easily be hosted with `docker compose` using a file like so:
```yaml
services:
matchy:
image: forge.mdiluz.io/mdiluz/matchy:${MATCHY_TAG:-latest}
env_file: ".env"
volumes:
- ${MATCHY_DATA:-./.matchy}:/usr/src/app/.matchy
```
## TODO
* Implement better tests to the discordy parts of the codebase