Files
triggershell/examples/triggershell.yml
T

118 lines
3.1 KiB
YAML
Raw Normal View History

2026-08-15 18:37:30 +02:00
# TriggerShell example configuration.
# See docs/CONFIG_REFERENCE.md for the full field reference.
server:
host: 127.0.0.1
port: 4173
auth:
# Set to false for trusted/local-only use - no login required.
enabled: true
# Must be >= 32 characters. Loaded from .env (see .env.example) - the fallback after `:-` only
# exists so this example runs with zero setup; don't rely on it for anything real.
2026-08-15 18:37:30 +02:00
sessionSecret: "${TRIGGERSHELL_SESSION_SECRET:-dev-only-insecure-session-secret-change-me-before-deploying}"
sessionTtlHours: 12
users:
# Generate with `triggershell users add`. This demo hash is for the password "admin" -
# change it before using this example anywhere but your own machine.
- username: admin
passwordHash: "$argon2id$v=19$m=65536,t=3,p=4$zQavMjKmTLUlSSy8e7doRQ$s6uQeh9rc4Jl+l0GHepH4S8zhcqGfIAbvrxk9F3rT4U"
tokens:
# Generate with `triggershell users add-token`. This demo token is "ci-bot-demo-token".
- name: ci-bot
tokenHash: "sha256:131709125e3c04e7c1dd59bc840a997a772ba54ff7448184c558ebc550d9d245"
database:
path: .triggershell/triggershell.db
logs:
dir: .triggershell/logs
retentionDays: 30
scripts:
- id: deploy-service
name: Deploy Service
description: Deploys the given service to the target environment.
command: bash
args: ["./scripts/deploy.sh"]
cwd: ./
timeoutSeconds: 600
variables:
- name: environment
label: Target Environment
type: enum
choices: [staging, production]
default: staging
required: true
control: select
passAs: arg
argName: --env
- name: replicas
label: Replica Count
type: number
default: 3
min: 1
max: 20
control: slider
passAs: arg
argName: --replicas
- name: dryRun
label: Dry Run
type: boolean
default: false
control: checkbox
passAs: flag
argName: --dry-run
- name: notifySlack
label: Notify Slack Channel
type: string
required: false
pattern: '^#[a-z0-9-]+$'
passAs: env
envName: SLACK_CHANNEL
- id: cleanup-logs
name: Cleanup Old Logs
description: Removes log files older than N days from a target directory.
command: node
args: ["./scripts/cleanup.js"]
cwd: ./
timeoutSeconds: 120
variables:
- name: targetDir
label: Target Directory
type: string
required: true
default: /var/log/app
passAs: arg
argName: --dir
- name: olderThanDays
label: Older Than (days)
type: number
default: 14
min: 1
control: number
passAs: arg
argName: --days
- name: fileTypes
label: File Types
type: multiselect
choices: [log, txt, gz, json]
default: [log, gz]
passAs: arg
argName: --types
joinWith: ","
- name: apiKey
label: External API Key
type: string
secret: true
required: true
passAs: env
envName: CLEANUP_API_KEY