Built-in hooksΒΆ
Required parameters are marked in red.
engine=email
- Send an email to one or more recipient when the hook is called.
Some extra variables are available:
* "status" ('--' for "before_backup" hooks, 'OK' or 'KO' otherwise) ,
* "detailed_status" (one 'KO'/'OK' per line, for each backup or collect point, empty for "before_backup" hooks)
* "complete_log" (the complete stdout log).
List of available parameters:
- certfile: client PEM cert file
- content: mail content (default to "{detailed_status} {complete_log}") 1
- encryption: Encryption method ("none", "starttls" or "tls")
- events: list of events (comma-separated) that trigger this hook: "before_backup","backup_success", "backup_error", "after_backup".
- hostname: SMTP server name (default to "localhost")
- keyfile: client PEM key file
- password: SMTP client password
- port: SMTP server port
- recipient: recipients, separated by commas 1
- sender: from address (default to docs@build-7784484-project-54907-polyarchiv) 1
- subject: subject (default to "[BACKUP][{fqdn}] {Y}/{m}/{d} {H}:{M} [{status}]") 1
- username: SMTP client username
engine=http
- Perform a HTTP request.
List of available parameters:
- body: request body (empty by default) 1
- cafile: CA cert PEM file, or "ignore" to ignore invalid certificates 1
- certfile: client PEM cert file 1
- events: list of events (comma-separated) that trigger this hook: "before_backup","backup_success", "backup_error", "after_backup".
- headers: custom headers, space-separated, e.g. HEADER1=VALUE HEADER2="VA LUE"
- keyfile: client PEM key file 1
- method: HTTP method (default to "GET")
- password: HTTP password 1
- proxy_url: Proxy URL 12
- url: requested URL 1
- username: HTTP username 1
engine=log
- store PolyArchiv's output to the given path. Be sure to set `keep_output` to `y`.
List of available parameters:
- events: list of events (comma-separated) that trigger this hook: "before_backup","backup_success", "backup_error", "after_backup".
- path: path of the log file 1
- this parameter can use variables
- please only use file/http/https/ssh URLs. If a username and a password are required, their must be provided in the URL.