mentat-backup.py.conf

#-------------------------------------------------------------------------------
#
# CONFIGURATION FILE FOR MENTAT-BACKUP.PY MODULE
#
#-------------------------------------------------------------------------------

{
    #---------------------------------------------------------------------------
    # Custom script configurations
    #---------------------------------------------------------------------------

    # Do not upload the backup file to remote storage (flag).
    #   default: false
    #   type:    boolean
    #
    "no_upload": true,

    # Name of the local mount point directory for remote storage.
    #   default: "/media/ds-store"
    #   type:    string
    #
    #"mount_point": "/media/ds-store",

    # Name of the local temporary file directory.
    #   default: "/var/mentat/tmp"
    #   type:    string
    #
    #"temp_dir": "/var/mentat/tmp",

    # Name of the local database backup directory.
    #   default: "/var/mentat/backups"
    #   type:    string
    #
    #"backup_dir": "/var/mentat/backups",

    # SSH connection string for the remote host to which to sychronize backups.
    #   default: None
    #   type:    string
    #
    #"remote_host": "user@host.domain.org",

    # Directory path on the remote host to which to sychronize backups.
    #   default: None
    #   type:    string
    #
    #"remote_dir": "/var/backups/mentat/",

    #---------------------------------------------------------------------------
    # Common script configurations
    #---------------------------------------------------------------------------

    # Operational mode: regular script execution (flag).
    #   default: false
    #   type:    boolean
    #
    #"regular": false,

    # Operational mode: manual script execution from shell (flag).
    #   default: false
    #   type:    boolean
    #
    #"shell": false,

    # Name of the script command to be executed.
    #   default: "backup"
    #   type:    string
    #
    #"command": "backup",

    # Time interval for regular executions.
    #   default: null
    #   type:    string
    #
    "interval": "daily",

    # Round-up time interval threshols to interval size (flag).
    #   default: false
    #   type:    boolean
    #
    #"adjust_thresholds": false,

    # Upper time interval threshold.
    #   default: time.time()
    #   type:    float
    #
    #"time_high": null,

    #---------------------------------------------------------------------------
    # Common application configurations
    #---------------------------------------------------------------------------

    # Run in quiet mode (flag).
    #   default: false
    #   type:    boolean
    #
    #"quiet": false,

    # Application output verbosity.
    #   default: 0
    #   type:    int
    #
    #"verbosity": 0,

    # Name of the log file.
    #   default: "/var/mentat/log/mentat-backup.py.log"
    #   type:    string
    #
    #"log_file": "/var/mentat/log/mentat-backup.py.log",

    # Logging level ['debug', 'info', 'warning', 'error', 'critical'].
    #   default: "info"
    #   type:    string
    #
    #"log_level": "info",

    # Name of the runlog directory.
    #   default: "/var/mentat/run/mentat-backup.py"
    #   type:    string
    #
    #"runlog_dir": "/var/mentat/run/mentat-backup.py",

    # Dump runlog to stdout when done processing (flag).
    #   default: false
    #   type:    boolean
    #
    #"runlog_dump": false,

    # Write runlog to logging service when done processing (flag)
    #   default: false
    #   type:    boolean
    #
    #"runlog_log": false,

    # Name of the persistent state file.
    #   default: "/var/mentat/run/mentat-backup.py.pstate"
    #   type:    string
    #
    #"pstate_file": "/var/mentat/run/mentat-backup.py.pstate",

    # Dump persistent state to stdout when done processing (flag).
    #   default: false
    #   type:    boolean
    #
    #"pstate_dump": false,

    # Write persistent state to logging service when done processing (flag).
    #   default: false
    #   type:    boolean
    #
    #"pstate_log": false,

    # Name of the quick action to be performed.
    #   default: null
    #   type: string
    #
    #"action": null,

    # Name/uid of the user.
    #   default: null
    #   type:    string or integer
    #
    #"user": "mentat",

    # Name/gid of the group.
    #   default: null
    #   type:    string or integer
    #
    #"group": "mentat",

    # This is a dummy last configuration so that the user does not have to fix
    # the commas in the whole configuration file after each change.
    "_dummy_": "_dummy_"
}