monkeytype Docker & Self-Hosted Deployment

GitHub

The most customizable typing website with a minimalistic design and a ton of features. Test yourself in various modes, track your progress and improve your...

20,883 stars TypeScript TypeScript 1 file ยท ~15,272 tokens #monkeytype#typingtest
RAW Compose
1. Pull Image (DOCKERHUB) docker pull monkeytype/monkeytype-frontend
2. Docker Run (1-Click Launch) docker run -d --name monkeytype -p 80:80 --restart always monkeytype/monkeytype-frontend:latest
3. Podman Run podman run -d --name monkeytype -p 80:80 --restart always monkeytype/monkeytype-frontend:latest
4. Skopeo Inspect (Zero-Pull Manifest) skopeo inspect docker://docker.io/monkeytype/monkeytype-frontend:latest
5. ORAS Pull (OCI Artifact) oras pull monkeytype/monkeytype-frontend:latest
6. Compose Deployment docker compose up -d
docker/docker-compose.yml
Download .yml
services:
  monkeytype-proxy:
    container_name: monkeytype-proxy
    image: traefik:v3.7
    restart: on-failure
    depends_on:
      monkeytype-backend:
        condition: service_healthy
      monkeytype-frontend:
        condition: service_healthy
    ports:
      - "${HTTP_PORT:-80}:80"
      - "${HTTPS_PORT:-443}:443"
      #Dashboard disabled for security (uncomment only for debugging behind VPN)
      #- "8080:8080"
    networks:
      - public
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./letsencrypt:/letsencrypt
    command:
      - "--providers.docker=true"
      - "--entrypoints.web.address=:80"
      - "--entrypoints.websecure.address=:443"

      # enable for HTTPS
      #- "--certificatesresolvers.letsencrypt.acme.email=${ACME_EMAIL}"
      #- "--certificatesresolvers.letsencrypt.acme.storage=/letsencrypt/acme.json"
      #- "--certificatesresolvers.letsencrypt.acme.httpchallenge.entrypoint=web"
      #- "--entrypoints.web.http.redirections.entrypoint.to=websecure"
      #- "--entrypoints.web.http.redirections.entrypoint.scheme=https"

      # for debugging only
      #- "--api.insecure=true"
      #- "--log.level=DEBUG"

  monkeytype-frontend:
    container_name: monkeytype-frontend
    image: monkeytype/monkeytype-frontend:latest
    #uncomment if you want to expose the frontend server directly (not recommended)
    #ports:
    #  - "${FRONTEND_PORT:-8080}:80"
    restart: on-failure
    networks:
      - public
    labels:
      - "traefik.http.routers.frontend.rule=PathPrefix(`/`)"
      - "traefik.http.routers.frontend.entrypoints=web,websecure"
      - "traefik.http.routers.frontend.priority=25"
      - "traefik.http.services.frontend.loadbalancer.server.port=80"
      # enable for HTTPS
      #- "traefik.http.routers.frontend.rule=Host(`${DOMAIN}`)"
      #- "traefik.http.routers.frontend.tls=true"
      #- "traefik.http.routers.frontend.tls.certresolver=letsencrypt"
      #- "traefik.http.routers.frontend.tls.domains[0].main=${DOMAIN}"
    env_file:
      - path: ./.env
        required: true
    environment:
      - FIREBASE_APIKEY=${FIREBASE_APIKEY:-}
      - FIREBASE_AUTHDOMAIN=${FIREBASE_AUTHDOMAIN:-}
      - FIREBASE_PROJECTID=${FIREBASE_PROJECTID:-}
      - FIREBASE_STORAGEBUCKET=${FIREBASE_STORAGEBUCKET:-}
      - FIREBASE_MESSAGINGSENDERID=${FIREBASE_MESSAGINGSENDERID:-}
      - FIREBASE_APPID=${FIREBASE_APPID:-}
      - MONKEYTYPE_BACKENDURL=${BASE_URL:-http://localhost}/api
      - RECAPTCHA_SITE_KEY=${RECAPTCHA_SITE_KEY:-}
    healthcheck:
      test: ["CMD", "nc", "-z", "localhost", "80"]
      interval: 5s
      timeout: 10s
      retries: 15
      start_period: 5s

  monkeytype-backend:
    container_name: monkeytype-backend
    image: monkeytype/monkeytype-backend:latest
    #uncomment if you want to expose the backend server (not recommended)
    #ports:
    #  - "${BACKEND_PORT:-5005}:5005"
    networks:
      - public # access to the internet, e.g. google firebase
      - isolated # access to the databases
    restart: on-failure
    environment:
      - DB_NAME=monkeytype
      - DB_URI=mongodb://monkeytype-mongodb:27017
      - REDIS_URI=redis://monkeytype-redis:6379
      - FRONTEND_URL=${BASE_URL:-http://localhost}
      - RECAPTCHA_SECRET=${RECAPTCHA_SECRET:-}
      - EMAIL_HOST=${EMAIL_HOST:-}
      - EMAIL_PORT=${EMAIL_PORT:-}
      - EMAIL_USER=${EMAIL_USER:-}
      - EMAIL_PASS=${EMAIL_PASS:-}
      - EMAIL_FROM=${EMAIL_FROM:-}
    volumes:
      #uncomment to enable the account system, check the SELF_HOSTING.md file
      #- type: bind
      #  source: ./serviceAccountKey.json
      #  target: /app/backend/src/credentials/serviceAccountKey.json
      #  read_only: true
      - type: bind
        source: ./backend-configuration.json
        target: /app/backend/dist/backend-configuration.json
        read_only: true
    depends_on:
      monkeytype-redis:
        condition: service_healthy
      monkeytype-mongodb:
        condition: service_healthy
    healthcheck:
      test: ["CMD", "nc", "-z", "localhost", "5005"]
      interval: 5s
      timeout: 10s
      retries: 15
      start_period: 5s
    labels:
      - "traefik.http.middlewares.backend-prefix.stripprefix.prefixes=/api"
      - "traefik.http.middlewares.backend-headers.headers.customrequestheaders.CF-Connecting-IP="
      - "traefik.http.routers.backend.middlewares=backend-prefix,backend-headers"
      - "traefik.http.routers.backend.rule=PathPrefix(`/api`)"
      - "traefik.http.routers.backend.priority=100"
      - "traefik.http.routers.backend.entrypoints=web"
      - "traefik.http.services.backend.loadbalancer.server.port=5005"
      - "traefik.enable=true"
      - "traefik.docker.network=monkeytype-public"

  monkeytype-redis:
    container_name: monkeytype-redis
    image: redis:6.2.6
    #uncomment if you want to expose the redis server (not recommended)
    #ports:
    #  - "${REDIS_PORT:-6379}:6379"
    networks:
      - isolated
      #uncomment if you want to expose the redis server (not recommended)
      #- public
    restart: on-failure
    volumes:
      - redis-data:/data
    healthcheck:
      test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
      interval: 5s
      timeout: 10s
      retries: 15
      start_period: 10s

  monkeytype-mongodb:
    container_name: monkeytype-mongodb
    image: mongo:5.0.13
    restart: on-failure
    volumes:
      - mongo-data:/data/db
    #uncomment if you want to expose the mongodb server (not recommended)
    #ports:
    #  - "${MONGO_PORT:-27017}:27017"
    networks:
      - isolated
      #uncomment if you want to expose the mongodb server (not recommended)
      #- public
    healthcheck:
      test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
      interval: 5s
      timeout: 10s
      retries: 15
      start_period: 10s

volumes:
  mongo-data:
    name: monkeytype_mongo_data
  redis-data:
    name: monkeytype_redis_data

networks:
  isolated:
    name: monkeytype-isolated
    internal: true
  public:
    name: monkeytype-public