Configuration

Updatectl uses a YAML configuration file to define update intervals and projects.

Location

• Linux: /etc/updatectl/updatectl.yaml
• Windows: %ProgramData%\updatectl\updatectl.yaml

Schema

intervalMinutes: 10  # Check interval in minutes
projects:
  - name: string      # Project identifier
    path: string      # Local filesystem path
    repo: string      # Git repository URL
    type: string      # Project type (docker/pm2/static)
    buildCommand: string  # Optional build command (runs after git pull)

Examples

Docker Project

projects:
  - name: webapp
    path: /srv/webapp
    repo: https://github.com/company/webapp.git
    type: docker
    buildCommand: docker compose up -d --build

PM2 Project

projects:
  - name: api
    path: /srv/api
    repo: https://github.com/company/api.git
    type: pm2
    buildCommand: npm install && npm run build  # Optional: run before restart

Static Site

projects:
  - name: docs
    path: /var/www/docs
    repo: https://github.com/company/docs.git
    type: static
    buildCommand: npm run build  # Optional: run after git pull