keys

Documentation

Index

• Variables
• type Key
  • func (key *Key) EnvBool() bool
  • func (key *Key) EnvExists() bool
  • func (key *Key) EnvId() string
  • func (key *Key) EnvInt() int
  • func (key *Key) EnvString() string
  • func (key *Key) EnvStringSlice() []string

Variables

var BackupId = newKey("backup-id", "backup id to use (backup tasks will autogenerate if not set)", "")

backup/restore shared

var BackupSchedule = newKey("backup-schedule", "cron expression for backups schedule", "")

var BackupStopModes = stopModes([]string{"labelled", "linked", "writers"})

...filters

var ContainerBackupDir = newKey("container-backup-dir", "backups archieve directory", "/backups")

daemon

var DaemonAddr = newKey("daemon-addr", "bind address for bckupr daemon, should use unix:///tmp/.bckupr or tcp binding like 0.0.0.0:8000", TcpAddr.Default)

var DaemonNet = newKey("daemon-net", "network connection type for bckupr daemon, unix or tcp", "tcp")

var DaemonProtocol = newKey("daemon-protocol", "protocol for bckupr daemon (don't recommend changing)", "http")

var Debug = newKey("debug", "enable additional logging information", false)

var DestroyBackups = newKey("destroy-backups", "destroy backups instead of moving to bin directory", false)

rotate

var DockerHosts = newKey("docker-hosts", "docker host uri's to manage backups on", []string{"unix:///var/run/docker.sock"})

var ExcludeName = newKey("exclude-names", "exclude containers with matching names", []string{})

var ExcludeVolumes = newKey("exclude-volumes", "exclude containers with matching volumes", []string{})

var HostBackupDir = newKey("host-backup-dir", "backups archieve directory", "")

var IncludeNames = newKey("include-names", "only include containers with matching names", []string{})

var IncludeVolumes = newKey("include-volumes", "only include containers with matching volumes", []string{})

var LabelPrefix = newKey("label-prefix", "label prefix used to scan containers for configuration", "bckupr")

var LocalContainersConfig = newKey("local-containers-config", "yaml config for managing local backups", "./configs/local/tar.yml")

var NoDryRun = newKey("no-dry-run", "only log actions and not executed", true)

var NotificationUrls = newKey("notification-urls", "shoutrrr service notification urls (https://containrrr.dev/shoutrrr/latest/services/overview/)", []string{})

var NotifyJobCompleted = newKey("notify-job-completed", "enable notifications when backups or restores complete", false)

var NotifyJobError = newKey("notify-job-error", "enable notifications when backups or restores complete with an error", false)

var NotifyJobStarted = newKey("notify-job-started", "enable notifications when backups or restores start", false)

var NotifyTaskCompleted = newKey("notify-task-completed", "enable notifications when backups or restores complete on specific volumes", false)

var NotifyTaskError = newKey("notify-task-errors", "enable notifications when backups or restores complete with an error on specific volumes", false)

var NotifyTaskStarted = newKey("notify-task-started", "enable notifications when backups or restores start on specific volumes", false)

var OffsiteContainersConfig = newKey("offsite-containers-config", "yaml config for managing offsite backups", "")

var PoliciesPath = newKey("rotation-policies-config", "rotation policies yaml path", "./configs/rotation/policies.yaml")

var RestoreStopModes = stopModes([]string{"labelled", "linked", "attached"})

var RotateSchedule = newKey("rotate-schedule", "cron expression for rotations schedule", "")

var TcpAddr = newKey("tcp-addr", "tcp address to bind ui/api", "0.0.0.0:8000")

var UnixSocket = newKey("unix-socket", "unix socket to bind daemon", "/tmp/.bckupr.sock")

var ThreadLimit = newKey("concurrency", "number of concurrent tasks", runtime.NumCPU())

var TimeZone = newKey("timezone", "timezone to use for cron scheduling", "UTC")

cron

Types

type Key

type Key struct {
	Id      string
	CliId   string
	Desc    string
	Default any
}

func (*Key) EnvBool

func (key *Key) EnvBool() bool

func (*Key) EnvExists

func (key *Key) EnvExists() bool

func (*Key) EnvId

func (key *Key) EnvId() string

func (*Key) EnvInt

func (key *Key) EnvInt() int

func (*Key) EnvString

func (key *Key) EnvString() string

func (*Key) EnvStringSlice

func (key *Key) EnvStringSlice() []string