diff --git a/README.md b/README.md index d992b2a..94b26f0 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,29 @@ For example: npx chat-analytics -p discord -i "exported/*.json" -o report.html ``` +## Docker Compose + +You can utilize the official docker image provided at https://hub.docker.com/r/mlomb/chat-analytics for selfhosting purposes. +Check an example configuration at [docker-compose.yaml](/docker-compose.yaml). + +Such file can look like this: +``` +version: '3.8' + +services: + chat-analytics: + image: mlomb/chat-analytics:latest + ports: + - "80:80" + restart: unless-stopped +``` +You can map the web interface port as required by changing the port mapping, internal port must be kept to 80. + +## Docker build + +The image can be built from stratch by downloading the source repository utilizing the dockerfile provided at the main respository. +Check [dockerfile](/Dockerfile) for more information. + ## Docs & Development You can read [docs/README.md](/docs/README.md) for technical details, and [docs/DEV.md](/docs/DEV.md) for development instructions.