Documentation
¶
Index ¶
- type BackupConfig
- type Config
- type ConfigAlert
- type ConfigAlertDiscord
- type ConfigAlertEmail
- type ConfigAlertEmailAccount
- type ConfigContainerPost
- type ConfigContainerTar
- type ConfigDaemon
- type ConfigDest
- type ConfigDestLocal
- type ConfigDestSftp
- type ConfigRetain
- type ContainerDocker
- type DiscordAuthor
- type DiscordBasicMessage
- type DiscordEmbed
- type DiscordField
- type DiscordFooter
- type DiscordImage
- type Flags
- type Logs
- type Process
- type RunBackupDetails
- type RunDestDetails
- type RunDetails
- type RunDetailsDestLocal
- type SendAlert
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BackupConfig ¶
type BackupConfig struct {
Docker []ContainerDocker `yaml:"Docker,omitempty"`
}
type Config ¶
type Config struct {
Daemon ConfigDaemon `yaml:"Daemon,omitempty"`
Backup BackupConfig `yaml:"Backup"`
Alert ConfigAlert `yaml:"Alert,omitempty"`
Destination ConfigDest `yaml:"Destination,omitempty"`
}
This is the root yaml config that contains the information needed to operate
type ConfigAlert ¶
type ConfigAlert struct {
SendOnlyOnError bool `yaml:"SendOnlyOnError,omitempty"`
Discord ConfigAlertDiscord `yaml:"Discord,omitempty"`
Email ConfigAlertEmail `yaml:"Email,omitempty"`
}
type ConfigAlertDiscord ¶
type ConfigAlertEmail ¶ added in v0.0.3
type ConfigAlertEmail struct {
Account ConfigAlertEmailAccount `yaml:"Account"`
From string `yaml:"From"`
To string `yaml:"To"`
}
type ConfigAlertEmailAccount ¶ added in v0.0.3
type ConfigContainerPost ¶ added in v0.0.3
type ConfigContainerPost struct {
Reboot []string `yaml:"Reboot,omitempty"`
}
type ConfigContainerTar ¶
type ConfigDaemon ¶ added in v0.0.4
type ConfigDaemon struct {
Cron string `yaml:"Cron,omitempty"`
}
type ConfigDest ¶
type ConfigDest struct {
Retain ConfigRetain `yaml:"Retain,omitempty"`
Local ConfigDestLocal `yaml:"Local,omitempty"`
Sftp ConfigDestSftp `yaml:"Sftp,omitempty"`
}
type ConfigDestLocal ¶
type ConfigDestLocal struct {
Path string `yaml:"Path,omitempty"`
}
Defines where and how to move data
type ConfigDestSftp ¶
type ConfigRetain ¶
type ConfigRetain struct {
Days int `yaml:"Days,omitempty"`
}
Defines how long backups should be retained
type ContainerDocker ¶
type ContainerDocker struct {
Name string `yaml:"Name"`
Directory string `yaml:"Directory"`
Tar ConfigContainerTar `yaml:"Tar"`
Post ConfigContainerPost `yaml:"Post,omitempty"`
}
type DiscordAuthor ¶
type DiscordBasicMessage ¶ added in v0.0.6
type DiscordBasicMessage struct {
Username string `json:"username,omitempty"`
AvatarUrl string `json:"avatar_url,omitempty"`
Content string `json:"content,omitempty"`
Embeds []DiscordEmbed `json:"embeds,omitempty"`
}
Root object for Discord Webhook messages
type DiscordEmbed ¶
type DiscordEmbed struct {
Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"`
Url string `json:"url,omitempty"`
Color int `json:"color,omitempty"`
Fields []DiscordField `json:"fields,omitempty"`
Author DiscordAuthor `json:"author,omitempty"`
Image DiscordImage `json:"image,omitempty"`
Thumbnail DiscordImage `json:"thumbnail,omitempty"`
}
type DiscordField ¶
type DiscordFooter ¶
type DiscordFooter struct {
}
type DiscordImage ¶
type DiscordImage struct {
Url string `json:"url,omitempty"`
}
type RunBackupDetails ¶
type RunDestDetails ¶
type RunDestDetails struct {
Local RunDetailsDestLocal
}
type RunDetails ¶
type RunDetails struct {
ContainerName string
ContainerBackupPath string
Backup RunBackupDetails
Dest RunDestDetails
}
Click to show internal directories.
Click to hide internal directories.