config.example.yml

# All fields are optional, unless stated otherwise
host: example.com # defaults to localhost
port: 9090 # defaults to 9090
# Public URL to use in the post output for pipeline url generation
# If not specified public url will be a combination of protocol + host + port
public_url: https://example.com:9090/ 
log_level: "debug" # defaults to 'info', other options are 'warn' and 'error'
disable_api: true # Disable Inspection HTTP API
api_user: 'admin' # Basic auth user for the inspection API. Defaults to "admin"
api_password: '' # Basic auth user for the inspection API. Defaults to empty string (disabled)
# SSL config: (optional, but recommended, unless you're using a reverse proxy)
ssl:
  cert_file_path: "./your/certfile/path/fullchain.pem"
  key_file_path: "/your/keyfile/path/privkey.pem"
projects:
  your_project_name:
    git_provider: gitea # defaults to "github"
    repo: "username/reponame" # REQUIRED repository full name, as displayed in the URL
    # please notice, it may be safer to keep secret and authorization tokens 
    # in env variables, depending on your application deployment and setup
    secret: "YourSecretGoesHere" # your secret, used to sign the payload and validate it
    authorization: "JghYTd" # post authorization header contents, to authorize the incoming request
    actions:
      - on: push # defaults to "push", use "*" to handle any incoming event
        branch: master # defaults to master
        user: www-data # user from which action will be run
        cwd: "/var/www/yourproject" # root dir in which action will be run
        # each action MUST have either a script or run field (but not both):
        # To run a script:
        script: |
          git fetch && git reset --hard origin/master
          npm ci
          npm run build
        # Or to execute a script or program:
        # run: ["node", "--version"]
 # pipeline results db filename, defaults to `actions.sqlite3` use empty string or null to disable
actions_db_file: "actions.sqlite3"
# application logs db filename, default to `logs.sqlite3`. Use empty string or null to disable
logs_db_file: "logs.sqlite3"