config

Documentation

Index

• type Config
  • func CreateTestConfig() (conf Config, cleanup func())
• type GarbageCollect

Types

type Config

type Config struct {
	// Used only for unit tests, so that they know where the temporary
	// directory created for this test is located.
	TestTempDir string `yaml:"-"`

	FileStorePath string `yaml:"fileStorePath"`
	CheckoutPath  string `yaml:"checkoutPath"`

	GarbageCollect GarbageCollect `yaml:"garbageCollect"`
}

Config contains all the Shaman configuration

func CreateTestConfig

func CreateTestConfig() (conf Config, cleanup func())

CreateTestConfig creates a configuration + cleanup function.

type GarbageCollect

type GarbageCollect struct {
	// How frequently garbage collection is performed on the file store:
	Period time.Duration `yaml:"period"`
	// How old files must be before they are GC'd:
	MaxAge time.Duration `yaml:"maxAge"`
	// Paths to check for symlinks before GC'ing files.
	ExtraCheckoutDirs []string `yaml:"extraCheckoutPaths"`

	// Used by the -gc CLI arg to silently disable the garbage collector
	// while we're performing a manual sweep.
	SilentlyDisable bool `yaml:"-"`
}

GarbageCollect contains the config options for the GC.