Chadburn

Development Notice: Chadburn is undergoing a major rewrite. The code is not fully tested and documentation may not reflect current functionality. Please use prior stable versions for production environments.

Urgent Support Needed: Over $60 has been spent this month alone on development and domain costs, paid out-of-pocket by the financially strained lead developer. Please help cover these expenses via PayPal or Venmo to [email protected] to ensure continued development toward a stable release with new features. Feel free to reach out to discuss features you'd like to see.

Chadburn

Modern job scheduler for Docker environments

Get Started API Reference GitHub

Key Features

Docker Integration

Native support for Docker containers with the ability to execute commands inside running containers or create new containers on schedule.

Dynamic Configuration

Configure jobs using Docker labels for a flexible, dynamic approach that doesn't require restarts when configuration changes.

Multiple Job Types

Support for various job types including local execution, container execution, and container lifecycle events.

Container Lifecycle Events

Execute commands when containers start or stop, enabling powerful automation workflows.

Notifications

Built-in support for Slack, Email, and Gotify notifications to keep you informed about job executions.

Metrics

Prometheus-compatible metrics endpoint for monitoring job executions and performance.

New: REST API Documentation

Control and monitor your Chadburn instance programmatically with our comprehensive REST API.

  • Create and manage jobs via API calls
  • Monitor job status and execution history
  • Trigger jobs on demand
  • Integrate with your existing systems
Explore the API
// Example: Create a new job
fetch('/api/jobs', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    name: "backup-database",
    type: "job-local",
    schedule: "@daily",
    command: "/usr/local/bin/backup.sh"
  })
})

Thank You to Our Contributors

Loading contributors...

Quick Start

docker run -d --name chadburn \
  -v /var/run/docker.sock:/var/run/docker.sock:ro,z \
  -v /path/to/config.ini:/etc/chadburn.conf \
  premoweb/chadburn:latest daemon

Check out the Getting Started Guide for more detailed instructions.

Documentation

Getting Started

Installation, quick start, and basic concepts

Configuration

Configuration file format, environment variables, and command line options

Job Types

Different job types and their configuration options

API Reference

Comprehensive REST API documentation for programmatic control

Docker Integration

Docker labels, container lifecycle events, and dynamic configuration

Examples

Common use cases and Docker Compose examples