Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docker information to README #122

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Docker information to README #122

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2ce707
Update README.md
masiv1001 Nov 28, 2024
afcb0f8
Update README.md
masiv1001 Nov 30, 2024
161460c
Update README.md
masiv1001 Dec 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down