config

package

v0.17.2 Latest Latest Go to latest Published: Apr 18, 2024 License: GPL-3.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/garethgeorge/backrest

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func BindAddress() string
func ConfigFilePath() string
func DataDir() string
func NewDefaultConfig() *v1.Config
func ResticBinPath() string
func ValidateConfig(c *v1.Config) error
type CachingValidatingStore
- func (c *CachingValidatingStore) Get() (*v1.Config, error)
- func (c *CachingValidatingStore) Update(config *v1.Config) error
type ConfigStore
type JsonFileStore
- func (f *JsonFileStore) Get() (*v1.Config, error)
- func (f *JsonFileStore) Update(config *v1.Config) error
type MemoryStore
- func (c *MemoryStore) Get() (*v1.Config, error)
- func (c *MemoryStore) Update(config *v1.Config) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	EnvVarConfigPath  = "BACKREST_CONFIG"         // path to config file
	EnvVarDataDir     = "BACKREST_DATA"           // path to data directory
	EnvVarBindAddress = "BACKREST_PORT"           // port to bind to (default 9898)
	EnvVarBinPath     = "BACKREST_RESTIC_COMMAND" // path to restic binary (default restic)
)

View Source

var ErrConfigNotFound = fmt.Errorf("config not found")

Functions ¶

func BindAddress ¶

func BindAddress() string

func ConfigFilePath ¶

func ConfigFilePath() string

ConfigFilePath - *nix systems use $XDG_CONFIG_HOME/backrest/config.json - windows uses %APPDATA%/backrest/config.json

func DataDir ¶

func DataDir() string

DataDir - *nix systems use $XDG_DATA_HOME/backrest - windows uses %APPDATA%/backrest/data

func NewDefaultConfig ¶

func NewDefaultConfig() *v1.Config

func ResticBinPath ¶

func ResticBinPath() string

func ValidateConfig ¶

func ValidateConfig(c *v1.Config) error

Types ¶

type CachingValidatingStore ¶

type CachingValidatingStore struct {
	ConfigStore
	// contains filtered or unexported fields
}

func (*CachingValidatingStore) Get ¶

func (c *CachingValidatingStore) Get() (*v1.Config, error)

func (*CachingValidatingStore) Update ¶

func (c *CachingValidatingStore) Update(config *v1.Config) error

type ConfigStore ¶

type ConfigStore interface {
	Get() (*v1.Config, error)
	Update(config *v1.Config) error
}

type JsonFileStore ¶

type JsonFileStore struct {
	Path string
	// contains filtered or unexported fields
}

func (*JsonFileStore) Get ¶

func (f *JsonFileStore) Get() (*v1.Config, error)

func (*JsonFileStore) Update ¶

func (f *JsonFileStore) Update(config *v1.Config) error

type MemoryStore ¶

type MemoryStore struct {
	Config *v1.Config
	// contains filtered or unexported fields
}

func (*MemoryStore) Get ¶

func (c *MemoryStore) Get() (*v1.Config, error)

func (*MemoryStore) Update ¶

func (c *MemoryStore) Update(config *v1.Config) error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
migrations

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL