Configurations

Introduction

Dagu offers multiple ways to configure its behavior, from environment variables to configuration files. This document covers all available configuration options for setting up Dagu in different environments.

Configuration Methods

There are three ways to configure Dagu:

  1. Command-line arguments

  2. Environment variables

  3. Configuration file

Environment Variables

Server Configuration

  • DAGU_HOST (127.0.0.1): Server binding host

  • DAGU_PORT (8080): Server binding port

  • DAGU_BASE_PATH (""): Base path to serve the application (e.g., /dagu)

  • DAGU_TZ (""): Server timezone (default: system timezone, e.g., Asia/Tokyo)

  • DAGU_CERT_FILE: SSL certificate file path

  • DAGU_KEY_FILE: SSL key file path

  • DAGU_HEADLESS (""): Run the server in headless mode (1=enabled)

Directory Paths

  • DAGU_HOME: Set all Dagu directories to a custom location such as ~/.dagu.

  • DAGU_DAGS_DIR (~/.config/dagu/dags): DAG definitions directory

  • DAGU_LOG_DIR (~/.local/share/dagu/logs): Log files directory

  • DAGU_DATA_DIR (~/.local/share/dagu/history): Application data directory

  • DAGU_SUSPEND_FLAGS_DIR (~/.config/dagu/suspend): DAG suspend flags directory

  • DAGU_ADMIN_LOG_DIR (~/.local/share/admin): Admin logs directory

  • DAGU_BASE_CONFIG (~/.config/dagu/base.yaml): Base configuration file path

  • DAGU_WORK_DIR: Default working directory for DAGs (default: DAG location)

Authentication

  • DAGU_AUTH_BASIC_USERNAME (""): Basic auth username

  • DAGU_AUTH_BASIC_PASSWORD (""): Basic auth password

  • DAGU_AUTH_TOKEN (""): API token value

Queue System

  • DAGU_QUEUE_ENABLED (true): Enable/disable the queue system

UI Customization

  • DAGU_UI_NAVBAR_COLOR (""): Navigation bar color (e.g., red or #ff0000)

  • DAGU_UI_NAVBAR_TITLE (Dagu): Navigation bar title (e.g., Dagu - PROD)

Configuration File

Create config.yaml in ~/.config/dagu/ to override default settings. Below is a complete example with all available options:

# Server Configuration
host: "127.0.0.1"  # Web UI hostname
port: 8080         # Web UI port
basePath: ""       # Base path to serve the application
tz: "Asia/Tokyo"   # Timezone (e.g., "America/New_York")
headless: true     # Run in headless mode
permissions:       # Permissions for Web UI and API on the server
  writeDAGs: true  # Allow creating / editing / deleting DAGs
  runDAGs: true    # Allow running / stopping / retrying DAGs

# Directory Configuration
dagsDir: "~/.config/dagu/dags"            # DAG definitions location
workDir: "/path/to/work"                        # Default working directory
logDir: "~/.local/share/dagu/logs"        # Log files location
dataDir: "~/.local/share/dagu/history"    # Application data location
suspendFlagsDir: "~/.config/dagu/suspend" # DAG suspend flags location
adminLogsDir: "~/.local/share/admin"      # Admin logs location

# Queue Configuration
queues:
  enabled: true    # Enable/disable the queue system (default: true)
  config:          # Named queue configurations
    - name: "critical"
      maxConcurrency: 3
    - name: "batch"
      maxConcurrency: 1
    - name: "default"
      maxConcurrency: 2

# Common Configuration for all DAGs
baseConfig: "~/.config/dagu/base.yaml"  # Base DAG config

# Latest status configuration
latestStatusToday: true    # Show today's latest status

# UI Configuration
ui:
  navbarColor: "#ff0000"      # Header color
  navbarTitle: "Dagu - PROD"  # Header title
  logEncodingCharset: "utf-8" # Log encoding charset

# Authentication
auth:
  basic:
    username: "admin"          # Basic auth username
    password: "secret"         # Basic auth password
  token:
    value: "your-secret-token" # API token value

# SSL Configuration
tls:
    certFile: "/path/to/cert.pem"
    keyFile: "/path/to/key.pem"

Server Configuration

There are multiple ways to configure the server’s host and port:

  1. Command-line arguments (highest precedence):

dagu server --host=0.0.0.0 --port=8000

  1. Environment variables:

DAGU_HOST=0.0.0.0 DAGU_PORT=8000 dagu server

  1. Configuration file (config.yaml):

host: "0.0.0.0"
port: 8000

Quick Reference

Most commonly used configurations:

  1. Basic server setup:

host: "127.0.0.1"
port: 8080
dags: "~/dags"

  1. Production setup:

host: "0.0.0.0"
port: 443
auth:
  basic:
    enabled: true
    username: "admin"
    password: "strong-password"
tls:
  certFile: "/path/to/cert.pem"
  keyFile: "/path/to/key.pem"
ui:
  navbarColor: "#ff0000"
  navbarTitle: "Dagu - PROD"

  1. Development setup:

host: "127.0.0.1"
port: 8080
ui:
  navbarColor: "#00ff00"
  navbarTitle: "Dagu - DEV"