Skip to content

Configuration Schema

Detailed YAML configuration reference.

Root Level

FieldTypeRequiredDescription
intervalMinutesintegerYesMinutes between update checks
projectsarrayYesList of projects to monitor

Project Object

FieldTypeRequiredDescription
namestringYesUnique project identifier
pathstringYesLocal filesystem path
repostringYesGit repository URL
typestringYesProject type: docker, pm2, static
buildCommandstringNoBuild command (Docker only)

Validation Rules

  • intervalMinutes: Must be positive integer
  • path: Must exist and be writable
  • repo: Must be valid Git URL
  • type: Must be one of supported types
  • buildCommand: Required for docker type

Example

yaml
intervalMinutes: 30
projects:
  - name: frontend
    path: /srv/frontend
    repo: https://github.com/company/frontend.git
    type: docker
    buildCommand: docker compose up -d --build
  - name: backend
    path: /srv/backend
    repo: https://github.com/company/backend.git
    type: pm2