Skip to content

Checkmate is an open-source, self-hosted tool designed to track and monitor server hardware, uptime, response times, and incidents in real-time with beautiful visualizations. Don't be shy, join here: https://discord.com/invite/NAb6H3UTjK :)

License

Notifications You must be signed in to change notification settings

keonramses/CheckmateX

 
 

Repository files navigation

CheckmateX

Personal Fork of Checkmate with Custom Features

⚠️ This is a personal fork for my own use. Use at your own risk. ⚠️


About This Fork

This is a personal fork of Checkmate, an open-source uptime and infrastructure monitoring application. I've added features that I wanted for my personal monitoring needs.

Original Project: bluewave-labs/checkmate

If you're looking for the official, production-ready version, please visit the original repository.


🎯 Custom Features Added

✅ Completed Features

  • Docker Logs Feature - Comprehensive Docker container log viewing and management

    • Real-time and historical log viewing
    • Advanced severity filtering (TRACE, DEBUG, INFO, WARN, ERROR, FATAL)
    • Multi-format log parsing (JSON, Syslog, Winston, Bunyan, Pino, Log4j, Docker, Nginx)
    • Date range filtering with custom time selection
    • Smart search with text filtering
    • Sort controls (oldest/newest first)
    • Manual log capture with "Save Logs" button
    • Export logs in multiple formats (TXT, JSON, CSV)
    • Color-coded severity chips with gradient theme
    • Auto-save logs on container status changes
    • 30-day TTL retention policy
    • MongoDB persistence with indexed queries
    • 45 integration tests with 100% pass rate
  • UI/UX Improvements

    • Severity filter buttons color-coded by severity level
    • Count display showing filtered/total logs correctly
    • Bold filter dropdown text for better visibility
    • Removed sidebar clutter (Support, Discussions, Docs, Changelog buttons)
    • Integrated search bar with severity filters
    • Dynamic count hiding when specific severity selected
    • Bottom text color adjusted for better contrast
    • Save icon with descriptive tooltip

🚧 Planned Features

  • End-to-end Testing
    • Complete flow: monitor down → auto-save logs → view historical logs → apply filters → export
  • Additional Docker Monitoring Enhancements
    • Container metrics visualization (CPU, memory, network)
    • Multi-container log aggregation view
    • Log pattern detection and anomaly alerts
    • Custom log retention policies per monitor

🔄 Changes from Original Project

Removals

  • ❌ Removed "Support" button from sidebar (Discord link)
  • ❌ Removed "Discussions" button from sidebar (GitHub Discussions link)
  • ❌ Removed "Docs" button from sidebar (Gitbook documentation link)
  • ❌ Removed "Changelog" button from sidebar (GitHub releases link)
  • ❌ Removed "Star Checkmate" popup from sidebar (GitHub star prompt)
  • ❌ Removed incomplete v2 pages and routes (simplified codebase)
  • ❌ Removed unused v2 components (~36 files)

Additions

  • ✅ Full Docker logs viewing and management system
  • ✅ Advanced log filtering and search capabilities
  • ✅ Multiple export formats for logs
  • ✅ Historical log storage and retrieval
  • ✅ Enhanced UI/UX improvements throughout

Architecture Simplification

This fork uses a simplified hybrid architecture:

  • Primary codebase: v1 (JavaScript, feature-complete, all monitoring types)
  • Custom features: Selective v2 components (TypeScript, modern design)
  • Clean routing: No confusing /v2/* paths - single source of truth

The original Checkmate project had an incomplete v2 redesign alongside v1. To simplify maintenance and focus on customization, this fork has removed all incomplete v2 pages while preserving:

  • ✅ DockerLogsViewer component (custom feature using modern v2 architecture)
  • ✅ v2 theme system (available for gradual design modernization)
  • ✅ Clean integration pattern for future custom features

For details, see V2_CLEANUP_SUMMARY.md and V1_VS_V2_COMPARISON.md


🚀 Installation

This fork uses the same installation process as the original Checkmate project.

Quick Start with Docker

# Clone this repository
git clone https://github.com/keonramses/CheckmateX.git
cd CheckmateX

# Start development environment
docker-compose -f docker-compose.dev.yaml up -d

# Install dependencies and start servers
cd server && pnpm install && pnpm dev
cd ../client && pnpm install && pnpm dev

For more detailed setup instructions, see:


📚 Documentation


🧩 Core Features (from Original Checkmate)

  • Completely open source, deployable on your servers or home devices (e.g Raspberry Pi 4 or 5)
  • Website monitoring
  • Page speed monitoring
  • Infrastructure monitoring - requires Capture agent
  • Docker monitoring (ENHANCED in this fork)
  • Ping monitoring
  • SSL monitoring
  • Port monitoring
  • Game server monitoring
  • Incidents at a glance
  • Status pages
  • E-mail, Webhooks, Discord and Slack notifications
  • Scheduled maintenance
  • JSON query monitoring
  • Multi-language support

🏗️ Tech Stack

Frontend:

Backend:

Architecture:

  • v1 codebase (feature-complete, all monitoring types)
  • Selective v2 components for custom features (Docker logs)
  • Clean single-version routing

⚠️ Disclaimer

This is a personal fork maintained for my own use.

  • ❌ No guarantees of stability, security, or support
  • ❌ Features may break or change without notice
  • ❌ Use in production at your own risk
  • ✅ For official support and production use, please use the original Checkmate project

🙏 Credits

This project is based on Checkmate by BlueWave Labs.

Original Project Team:

And 90+ contributors from around the globe.

All core functionality and architecture credit goes to the original Checkmate team.


� License

This project maintains the same license as the original Checkmate project.


🔗 Related Projects

Original Checkmate Ecosystem:

About

Checkmate is an open-source, self-hosted tool designed to track and monitor server hardware, uptime, response times, and incidents in real-time with beautiful visualizations. Don't be shy, join here: https://discord.com/invite/NAb6H3UTjK :)

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • JavaScript 84.2%
  • TypeScript 12.7%
  • Shell 1.7%
  • CSS 0.6%
  • Dockerfile 0.5%
  • PowerShell 0.3%