Caddy Validate #

# 1. Validate the default Caddyfile at the standard location
caddy validate --config /etc/caddy/Caddyfile

# 2. Validate a configuration file with a custom name
caddy validate --config /home/user/project/Caddyfile

# 3. Validate a native JSON-format configuration
caddy validate --config /etc/caddy/config.json --adapter json

# 4. Validate configuration data streamed from standard input (stdin)
# Very useful for dynamic testing in automation scripts
cat /etc/caddy/Caddyfile | caddy validate --config /dev/stdin

# 5. Validate the Caddyfile and directly print the JSON representation if valid
caddy validate --config /etc/caddy/Caddyfile && \
    caddy adapt --config /etc/caddy/Caddyfile | jq .

#!/bin/bash
# safe-deploy.sh — Safe Caddy deployment with validation and rollback
set -euo pipefail

CONFIG_FILE="/etc/caddy/Caddyfile"
NEW_CONFIG="${1:-}"

# Make sure the input file argument is provided
if [ -z "$NEW_CONFIG" ]; then
    echo "Usage: $0 <path-to-new-caddyfile>"
    exit 1
fi

echo "[1/4] Validating the new configuration..."
if ! caddy validate --config "$NEW_CONFIG" 2>&1; then
    echo "✗ Configuration validation FAILED!"
    echo "   Deployment cancelled. The active configuration is unchanged."
    exit 1
fi
echo "✓ The configuration is declared VALID."

echo "[2/4] Creating a backup copy of the current configuration..."
BACKUP_FILE="/etc/caddy/Caddyfile.bak.$(date +%Y%m%d_%H%M%S)"
cp "$CONFIG_FILE" "$BACKUP_FILE"
echo "✓ Backup saved at: $BACKUP_FILE"

echo "[3/4] Applying the new configuration file..."
cp "$NEW_CONFIG" "$CONFIG_FILE"

echo "[4/4] Reloading the Caddy configuration (Reload)..."
if sudo systemctl reload caddy; then
    echo "✓ Caddy was successfully reloaded with the new configuration!"
else
    echo "✗ Failed to reload Caddy! Doing a recovery (Rollback)..."
    cp "$BACKUP_FILE" "$CONFIG_FILE"
    sudo systemctl reload caddy
    echo "✓ Recovery successful. Caddy is running with the old configuration."
    exit 1
fi

# Optional Step: Post-deployment site health testing
echo "[+] Waiting for network initialization..."
sleep 2
HTTP_STATUS=$(curl -sf -o /dev/null -w "%{http_code}" https://localhost/health 2>/dev/null || echo "000")

if [ "$HTTP_STATUS" = "200" ]; then
    echo "✓ Health test successful (HTTP $HTTP_STATUS)."
    echo "✓ Deployment completed successfully!"
else
    echo "✗ Health test failed (HTTP $HTTP_STATUS)! Doing a rollback..."
    cp "$BACKUP_FILE" "$CONFIG_FILE"
    sudo systemctl reload caddy
    echo "✓ Recovery to the old configuration was successfully applied."
    exit 1
fi

# Create the hook file in your local repository: .git/hooks/pre-commit
#!/bin/bash
set -u

# Track the Caddyfile files staged in git (staged changes)
CADDYFILES=$(git diff --cached --name-only | grep -E "Caddyfile|\.caddyfile$")

if [ -n "$CADDYFILES" ]; then
    echo "=== Running the Caddyfile Validation ==="
    
    for file in $CADDYFILES; do
        # Skip validation if the file is deleted
        if [ ! -f "$file" ]; then
            continue
        fi
        
        echo "Checking: $file"
        if ! caddy validate --config "$file" 2>&1; then
            echo "✗ Validation FAILED on the file: $file"
            echo "   Please fix the error before committing."
            exit 1
        fi
    done
    
    echo "✓ All Caddyfile files are valid. Continuing the commit..."
fi

exit 0

chmod +x .git/hooks/pre-commit

# .github/workflows/validate-caddy.yml
name: Caddyfile Linter & Validator

on:
  pull_request:
    paths:
      - '**/Caddyfile'
      - '**/*.caddyfile'

jobs:
  validate:
    name: Validate Configuration
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
        
      - name: Install Caddy
        run: |
          sudo apt-get install -y debian-keyring debian-archive-keyring apt-transport-https
          curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
          curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
          sudo apt-get update
          sudo apt-get install -y caddy
                    
      - name: Locate and Validate Caddyfiles
        run: |
          EXIT_STATUS=0
          # Find all files named Caddyfile or ending with .caddyfile
          find . -type f \( -name "Caddyfile" -o -name "*.caddyfile" \) | while read -r file; do
              echo "Validating: $file"
              if ! caddy validate --config "$file" 2>&1; then
                  echo "::error file=$file::Validation failed for $file"
                  EXIT_STATUS=1
              else
                  echo "✓ $file is valid"
              fi
          done
          exit $EXIT_STATUS          

      - name: Notify on Failure
        if: failure()
        uses: actions/github-script@v7
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: '🚨 **Integration Warning:** Caddyfile validation failed on this Pull Request. Please check the GitHub action logs for error details.'
            })            

# Run the validation by injecting fake environment variables in front of it
CF_API_TOKEN="mock-token-value" \
DB_PORT="3306" \
caddy validate --config /etc/caddy/Caddyfile

# Helper function for comparing configurations
diff_caddy_configs() {
    local old_config="$1"
    local new_config="$2"
    
    # Convert and sort JSON objects alphabetically (jq -S)
    caddy adapt --config "$old_config" | jq -S . > /tmp/caddy-old.json
    caddy adapt --config "$new_config" | jq -S . > /tmp/caddy-new.json
    
    echo "=== GATEWAY JSON STRUCTURE DIFFERENCES ==="
    diff --color=always -u /tmp/caddy-old.json /tmp/caddy-new.json || true
}

# Run the comparison
diff_caddy_configs /etc/caddy/Caddyfile.bak /etc/caddy/Caddyfile

# 1. Copy the Caddyfile to a temporary working directory
cp /etc/caddy/Caddyfile /tmp/caddy-sandbox.caddyfile

# 2. Do configuration edits on that sandbox file
nano /tmp/caddy-sandbox.caddyfile

# 3. Run validation repeatedly every time you finish adding one feature
caddy validate --config /tmp/caddy-sandbox.caddyfile

# 4. After the sandbox configuration is declared valid, copy it back to the main location
sudo cp /tmp/caddy-sandbox.caddyfile /etc/caddy/Caddyfile
sudo systemctl reload caddy

# /etc/caddy/Makefile
.PHONY: validate deploy rollback status

CADDYFILE = /etc/caddy/Caddyfile
BACKUP_DIR = /var/backups/caddy

validate:
	@echo "[+] Validating the Caddyfile configuration..."
	@caddy validate --config $(CADDYFILE)

deploy: validate
	@echo "[+] Creating the backup folder..."
	@mkdir -p $(BACKUP_DIR)
	@echo "[+] Backing up the active configuration..."
	@cp $(CADDYFILE) $(BACKUP_DIR)/Caddyfile.bak.$(shell date +%Y%m%d_%H%M%S)
	@echo "[+] Reloading the Caddy configuration (Reload)..."
	@sudo systemctl reload caddy
	@echo "[✓] Deployment successful!"

rollback:
	@echo "[+] Finding the latest backup copy..."
	@latest_backup=$$(ls -t $(BACKUP_DIR)/Caddyfile.bak.* | head -n 1); \
	if [ -z "$$latest_backup" ]; then \
		echo "[-] No backup files found!"; \
		exit 1; \
	fi; \
	echo "[+] Restoring to the file: $$latest_backup"; \
	cp $$latest_backup $(CADDYFILE) && \
	sudo systemctl reload caddy && \
	echo "[✓] Rollback completed successfully."

status:
	@sudo systemctl status caddy --no-pager