sylveondeko/mewdeko repository overview

⁠Mewdeko Docker image

sylveondeko/mewdeko runs the Mewdeko bot. It does not contain a Discord token, database password, API key, or any other credentials. Supply a credentials.json file when starting the container.

⁠Tags

• nightly: newest successful build from main
• sha-<commit>: immutable build from a specific commit
• latest and a version tag: published for a versioned release

The image supports linux/amd64 and linux/arm64.

⁠Quick start with Docker Compose

This is the recommended setup. It starts PostgreSQL, Redis, the bot, and the optional dashboard on one private Docker network.

curl -O https://raw.githubusercontent.com/SylveonDeko/Mewdeko/main/docker-compose.example.yml
curl -O https://raw.githubusercontent.com/SylveonDeko/Mewdeko/main/credentials.docker.example.json
curl -O https://raw.githubusercontent.com/SylveonDeko/Mewdeko/main/dashboard.docker.env.example

mv credentials.docker.example.json credentials.json
mv dashboard.docker.env.example dashboard.env
mv docker-compose.example.yml compose.yaml

Edit credentials.json, dashboard.env, and the PostgreSQL password in compose.yaml. Then start the stack:

docker compose up -d
docker compose logs -f mewdeko

The dashboard is available at http://localhost:3000. For production, place it behind an HTTPS reverse proxy and register that public URL as a Discord OAuth redirect.

⁠Required bot credentials

Generate independent secrets with openssl rand -hex 32.

⁠Bot-only deployment

If PostgreSQL and Redis already exist, create credentials.json from credentials_example.json⁠, point it at those services, and run:

docker run -d \
  --name mewdeko \
  --restart unless-stopped \
  -v "$PWD/credentials.json:/app/credentials.json:ro" \
  -v mewdeko-data:/app/data \
  -v mewdeko-logs:/app/logs \
  sylveondeko/mewdeko:nightly

Only publish port 5001 when another service outside Docker needs the bot API. Keep it private when the dashboard runs on the same Docker network.

⁠Owner Docker page

Bot owners get a Docker page in the dashboard's Owner Panel that lists the containers on the bot's host, samples their CPU and memory, follows their logs, and can start, stop and restart them. It talks to the daemon over its socket, so the bot needs it mounted:

    volumes:
      - /var/run/docker.sock:/var/run/docker.sock

The page also shows, per registered instance, the commit it runs (stamped into the image by CI as MEWDEKO_GIT_SHA) against the newest sylveondeko/mewdeko:nightly on Docker Hub, with an Update button per bot and an Update all for the whole compose project. Compose pull, up and update run in a throwaway docker:cli helper container the bot creates through the socket, so they survive the bot's own container being recreated; the project's compose directory has to be mounted into the bot at the same path it has on the host for that to work. Without the socket the page just reports that Docker is not configured. Anyone the bot treats as an owner can then control every container on that machine, so keep the owner list short.

Forks publishing under another name can point the version check elsewhere with MEWDEKO_IMAGE_REPO and MEWDEKO_IMAGE_TAG.

⁠Dashboard

The companion image is sylveondeko/mewdash⁠. Its required environment variables and standalone launch command are documented in the dashboard Docker guide⁠.