diff --git a/README.md b/README.md index b8181b1..999987a 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,30 @@ docker run -d --name mjolnir \ -e WEB_LISTEN_ADDRESS='0.0.0.0' \ git.nixc.us/colin/mjolnir:production ``` +### docker-compose.yml +```yaml +version: '3.8' + +services: + mjolnir: + image: git.nixc.us/colin/mjolnir:production + container_name: mjolnir + volumes: + - ./data:/data + - ./config/config.yml:/etc/mjolnir/config.yml + environment: + - HOME_SERVER_URL=https://matrix.org + - RAW_HOME_SERVER_URL=https://matrix.org # this is intended for internal routing to your homeserver inside of docker networking. + - ACCESS_TOKEN=YOUR_TOKEN_HERE + - PANTALAIMON_USE=false + - PANTALAIMON_USERNAME=mjolnir + - PANTALAIMON_PASSWORD=your_password + - SENTRY_DSN= + - SENTRY_TRACES_SAMPLE_RATE=0.5 + - WEB_LISTEN_ADDRESS=0.0.0.0 + ports: + - "8080:8080" # this is for the webserver portion. +``` ## Documentation For more detailed documentation on configuring and running Mjolnir, visit the official Mjolnir GitHub repository.