Welcome to Blackdagger’s documentation!

Blackdagger

Blackdagger is a powerful Cron alternative that comes with a Web UI. It allows you to define dependencies between commands as a Directed Acyclic Graph (DAG) in a declarative YAML Format. Additionally, Blackdagger natively supports running Docker containers, making HTTP requests, and executing commands over SSH. Blackdagger was designed to be easy to use, self-contained, and require no coding, making it ideal for small projects.

Contents

• Installation
  • Via Bash script
  • Via Docker
  • Via GitHub Release Page
• Quick Start Guide
  • 1. Launch the Web UI
  • 2. Create a New DAG
  • 3. Edit the DAG
  • 4. Execute the DAG
• Command Line Interface
• Web Interface
  • DAG List
  • DAG Details
  • DAG Search
  • Execution History
  • DAG Execution Log
• YAML Format
  • All Available Fields for DAGs
  • All Available Fields for Steps
  • Minimal DAG Definition
  • Specifying Working Directory
  • Running Arbitrary Code Snippets
  • Defining Environment Variables
  • Defining and Using Parameters
  • Using Command Substitution
  • Adding Conditional Logic
  • User Defined Functions
  • Setting Environment Variables with Standard Output
  • Redirecting Stdout and Stderr
  • Adding Lifecycle Hooks
  • Repeating a Task at Regular Intervals
  • Scheduling a DAG with Cron Expression
• Base Configuration for all DAGs
• Examples
  • Hello World
  • Conditional Steps
  • File Output
  • Passing Output to Next Step
  • Running a Docker Container
  • Sending HTTP Requests
  • Querying JSON Data with jq
  • Formatting JSON Data with jq
  • Outputting Raw Values with jq
  • Sending Email Notifications
  • Sending Email
  • Customizing Signal Handling on Stop
• Configuration Options
  • Environment Variables
  • Config File
  • Server’s Host and Port Configuration
• Basic Authentication
• API Token
• Executors
  • Running Docker Containers
  • Making HTTP Requests
  • Sending Email
  • Executing jq Command
  • Command Execution over SSH
• Sending Email Notifications
• Scheduler
  • Cron Expression
  • Stop Schedule
  • Restart Schedule
  • Run Scheduler as a Daemon
  • Configuration
• Using Docker Compose
• REST API Docs
  • API Endpoints
  • Show DAGs GET /api/v1/dags/
  • Show Workflow Detail GET /api/v1/dags/:name
  • Show Workflow Spec GET /api/v1/dags/:name/spec
  • Submit Workflow Action POST /api/v1/dags/:name
• Building Docker Image
• FAQ
  • How Long Will the History Data be Stored?
  • How to Use Specific Host and Port or blackdagger server?
  • How to Specify the DAGs Directory for blackdagger server and blackdagger scheduler?
  • How Can I Retry a DAG from a Specific Task?
  • How Does It Track Running Processes Without DBMS?
• Contribution Guide
  • Prerequisite
  • Setting up your local environment
  • Running Tests
  • Code Structure
  • Setting up your local environment for front end development
  • Branches