env

package

v1.13.0 Latest Latest Go to latest Published: May 4, 2026 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
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 LogsPath() string
func MultihostHeartbeatInterval() time.Duration
func ResticBinPath() string
func SSHDir() string

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)
	EnvVarMultihostHeartbeatInterval = "BACKREST_MULTIHOST_HEARTBEAT_INTERVAL" // interval for multihost heartbeat messages
)

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 LogsPath ¶ added in v1.5.0

func LogsPath() string

func MultihostHeartbeatInterval ¶ added in v1.9.0

func MultihostHeartbeatInterval() time.Duration

func ResticBinPath ¶

func ResticBinPath() string

func SSHDir ¶ added in v1.12.0

func SSHDir() string

Types ¶

This section is empty.

Source Files ¶

View all Source files

environment.go

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