cfg

Documentation

Index

• Variables
• func FileExists(path string) bool
• func LoadConfig() mo.Result[*Config]
• type Config
  • func LoadFromFile(path string) (conf *Config, err error)
• type CouchDBConfig
• type DBConfig
• type External
• type FiberConfig
• type GrpcConfig
• type KeysConfig
• type MeiliConfig
• type RedisConfig
• type SearchConfig
• type ThumbnailConfig
• type ThumbnailerNamespace
• type ValidationError
  • func Validate(conf *Config, validate *validator.Validate) (errs []ValidationError)

Variables

var (
	// nolint:gochecknoglobals
	// DefaultConfig is the default config for the application.
	// It is used as a fallback if loading the proper config fails.
	// Loading it should always be accompanied by a warning.
	DefaultConfig = Config{
		DBConfig: DBConfig{
			Engine:         "postgres",
			Host:           "localhost",
			Port:           uint16(5432),
			Database:       "librate",
			User:           "postgres",
			Password:       "postgres",
			SSL:            "unknown",
			MigrationsPath: "/app/data/migrations",
		},
		Fiber: FiberConfig{
			Host:    "localhost",
			Port:    3000,
			Prefork: false,
		},
		Secret:     uuid.Must(uuid.NewV7()).String(),
		LibrateEnv: "production",
	}
	// nolint:gochecknoglobals
	// TestConfig is a convenience config for testing, so that the test functions are terser, avoiding unnecessary repetition.
	TestConfig = Config{
		DBConfig: DBConfig{
			Engine:             "postgres",
			Host:               "0.0.0.0",
			Port:               uint16(5432),
			Database:           "librate_test",
			User:               "postgres",
			Password:           "postgres",
			SSL:                "disable",
			ExitAfterMigration: false,
			MigrationsPath:     "./migrations",
		},
		Logging: logging.Config{
			Level:  "debug",
			Target: "stdout",
			Format: "json",
			Caller: true,
			Timestamp: logging.TimestampConfig{
				Enabled: false,
				Format:  "2006-01-0215:04:05.000Z07:00",
			},
		},
		Redis: RedisConfig{
			Host:     "localhost",
			Port:     6379,
			Username: "",
			Password: "",
			CacheDB:  8,
			PowDB:    9,
			CsrfDB:   11,
		},
		Search: SearchConfig{
			Provider: "meilisearch",
			Meili: &MeiliConfig{
				Host:      "127.0.0.1",
				Port:      uint32(7700),
				MasterKey: "",
			},
			CouchDB: CouchDBConfig{
				Host:     "0.0.0.0",
				Port:     5984,
				User:     "librate",
				Password: "librate",
			},
		},
		Fiber: FiberConfig{
			Host:           "0.0.0.0",
			Port:           3001,
			Prefork:        false,
			ReduceMemUsage: false,
			StaticDir:      "./static",
			PowInterval:    1,
			PowDifficulty:  1,
		},
		Secret:     "secret",
		LibrateEnv: "test",
	}
)

Functions

func FileExists

func FileExists(path string) bool

FileExists checks whether the config file exists. It is useful for the fallback mechanism of using default config

func LoadConfig

func LoadConfig() mo.Result[*Config]

LoadConfig loads the config from the config file, or falls back to defaults. It is used only when no --config flag is passed.

Types

type Config

type Config struct {
	DBConfig `json:"database,omitempty" yaml:"database" mapstructure:"database"`
	Fiber    FiberConfig `json:"fiber,omitempty" yaml:"fiber" mapstructure:"fiber"`
	// used to encrypt sessions database
	Secret string `json:"secret,omitempty" yaml:"secret" mapstructure:"secret" env:"LIBRATE_SECRET"`
	// default to production for security reasons
	// nolint: revive
	LibrateEnv string         `` /* 161-byte string literal not displayed */
	Redis      RedisConfig    `json:"redis,omitempty" yaml:"redis" mapstructure:"redis"`
	Logging    logging.Config `json:"logging,omitempty" yaml:"logging" mapstructure:"logging"`
	Keys       KeysConfig     `json:"keys,omitempty" yaml:"keys" mapstructure:"keys"`
	JWTSecret  string         `json:"jwtSecret,omitempty" yaml:"jwtSecret" mapstructure:"jwtSecret" env:"LIBRATE_JWT_SECRET"`
	GRPC       GrpcConfig     `json:"grpc,omitempty" yaml:"grpc" mapstructure:"grpc"`
	External   External       `json:"external,omitempty" yaml:"external" mapstructure:"external"`
	Search     SearchConfig   `json:"search,omitempty" yaml:"search" mapstructure:"search"`
}

Config is the struct that holds all the configuration for the application unfortunately, camel case must be used, instead the yaml parser will not work

func LoadFromFile

func LoadFromFile(path string) (conf *Config, err error)

LoadFromFile loads the config from the config file, or tries to call LoadConfig.

type CouchDBConfig

type CouchDBConfig struct {
	Host     string `yaml:"host,omitempty" default:"librate-search" env:"LIBRATE_SEARCH_HOST"`
	Port     int    `yaml:"port,omitempty" default:"5984" env:"LIBRATE_SEARCH_PORT"`
	User     string `yaml:"user,omitempty" default:"admin" env:"LIBRATE_SEARCH_USER"`
	Password string `yaml:"password,omitempty" default:"admin" env:"LIBRATE_SEARCH_PASSWORD"`
}

type DBConfig

type DBConfig struct {
	Engine             string `yaml:"engine" default:"postgres" env:"LIBRATE_DB_ENGINE" validate:"required,oneof='postgres' 'mariadb' 'sqlite'"`
	Host               string `yaml:"host" default:"localhost" env:"LIBRATE_DB_HOST"`
	Port               uint16 `yaml:"port" default:"5432" env:"LIBRATE_DB_PORT"`
	Database           string `yaml:"database" default:"librate" env:"LIBRATE_DB_NAME"`
	User               string `yaml:"user" default:"postgres" env:"LIBRATE_DB_USER"`
	Password           string `yaml:"password,omitempty" default:"postgres" env:"LIBRATE_DB_PASSWORD"`
	SSL                string `yaml:"SSL" default:"unknown" env:"LIBRATE_DB_SSL"`
	ExitAfterMigration bool   `yaml:"exitAfterMigration,omitempty" default:"false" env:"LIBRATE_EXIT_AFTER_MIGRATION"`
	RetryAttempts      int32  `yaml:"retryAttempts,omitempty" default:"10" env:"LIBRATE_DB_RETRY_ATTEMPTS"`
	MigrationsPath     string `yaml:"migrationsPath,omitempty" default:"/app/data/migrations" env:"LIBRATE_MIGRATIONS"`
}

nolint: musttag,revive // tagged in the struct above, can't break tags into multiline

type External

type External struct {
	// currently supported: json, id3, spotify (requires client ID and secret)
	ImportSources       []string `yaml:"import_sources,omitempty" default:"json,id3" env:"LIBRATE_IMPORT_SOURCES"`
	SpotifyClientID     string   `yaml:"spotify_client_id,omitempty" env:"SPOTIFY_CLIENT_ID"`
	SpotifyClientSecret string   `yaml:"spotify_client_secret,omitempty" env:"SPOTIFY_CLIENT_SECRET"`
}

type FiberConfig

type FiberConfig struct {
	DefaultLanguage string          `yaml:"defaultLanguage" default:"en-US" env:"LIBRATE_DEFAULT_LANGUAGE"`
	Host            string          `yaml:"host" default:"localhost" env:"LIBRATE_HOST"`
	Domain          string          `yaml:"domain" default:"lr.localhost" env:"DOMAIN"`
	Port            int             `yaml:"port" default:"3000" env:"LIBRATE_PORT"`
	Prefork         bool            `yaml:"prefork" default:"false" env:"LIBRATE_PREFORK"`
	ReduceMemUsage  bool            `yaml:"reduceMemUsage" default:"false" env:"LIBRATE_REDUCE_MEM"`
	StaticDir       string          `yaml:"staticDir" default:"./static" env:"LIBRATE_ASSETS"`
	FrontendDir     string          `yaml:"frontendDir" default:"./fe/build" env:"LIBRATE_FRONTEND"`
	PowInterval     int             `yaml:"powInterval" default:"300" env:"POW_INTERVAL"`
	PowDifficulty   int             `yaml:"powDifficulty" default:"30000" env:"POW_DIFFICULTY"`
	RequestTimeout  int             `yaml:"requestTimeout" default:"10" env:"LIBRATE_REQUEST_TIMEOUT"`
	TLS             bool            `yaml:"tls" default:"false" env:"LIBRATE_TLS"`
	MaxUploadSize   int64           `yaml:"maxUploadSize" default:"4194304" env:"LIBRATE_MAX_SIZE"`
	Thumbnailing    ThumbnailConfig `yaml:"thumbnailing" default:"{namespaces: [{name: album_cover, size: {Width: 500, Height: 500}}]"`
}

refer to https://docs.gofiber.io/api/fiber#config

type GrpcConfig

type GrpcConfig struct {
	Host            string `yaml:"host" default:"localhost" env:"LIBRATE_GRPC_HOST"`
	Port            int    `yaml:"port" default:"3030" env:"LIBRATE_GRPC_PORT"`
	ShutdownTimeout int    `yaml:"shutdownTimeout" default:"10" env:"LIBRATE_SHUTDOWN_TIMEOUT"`
}

type KeysConfig

type KeysConfig struct {
	Private string `yaml:"private" default:"./keys/private.pem" env:"LIBRATE_PRIVATE_KEY"`
	Public  string `yaml:"public" default:"./keys/public.pem" env:"LIBRATE_PUBLIC_KEY"`
}

KeysConfig defines the location of keys used for TLS

type MeiliConfig

type MeiliConfig struct {
	Host string `yaml:"host,omitempty" default:"127.0.0.1" env:"MEILI_HOST"`
	// protobufs don't support smaller int sizes
	Port      uint32 `yaml:"port,omitempty" default:"7700" env:"MEILI_PORT"`
	MasterKey string `yaml:"masterKey,omitempty" env:"MEILI_MASTER_KEY"`
}

type RedisConfig

type RedisConfig struct {
	Host string `yaml:"host,omitempty" default:"localhost" env:"LIBRATE_REDIS_HOST"`
	Port int    `yaml:"port,omitempty" default:"6379" env:"LIBRATE_REDIS_PORT"`
	// how many errors can occur during scan of SQL DB into cache before the process is stopped
	Username string `yaml:"username,omitempty" default:"" env:"LIBRATE_REDIS_USERNAME"`
	Password string `yaml:"password,omitempty" default:"" env:"LIBRATE_REDIS_PASSWORD"`
	CacheDB  int    `yaml:"cacheDb,omitempty" default:"0" env:"LIBRATE_CACHE_DB"`
	CsrfDB   int    `yaml:"csrfDb,omitempty" default:"2" env:"LIBRATE_CSRF_DB"`
	PowDB    int    `yaml:"powDb,omitempty" default:"3" env:"LIBRATE_POW_DB"`
	PagesDB  int    `yaml:"pagesDb,omitempty" default:"4" env:"LIBRATE_PAGES_DB"`
	SearchDB int    `yaml:"searchDb,omitempty" default:"5" env:"LIBRATE_SEARCH_CACHE"`
}

type SearchConfig

type SearchConfig struct {
	Provider string `yaml:"provider,omitempty" default:"meilisearch" validate:"oneof='meilisearch' 'bleve'"`
	// For bleve no special config is needed.
	// The only field it needs is the main index path. You can
	// set it to whatever value when using meilisearch and
	// the app will just ignore it.
	Meili *MeiliConfig `yaml:"meili,omitempty"`
	// CouchDB config must be set
	CouchDB       CouchDBConfig `yaml:"couchdb"`
	MainIndexPath string        `yaml:"mainIndexPath,omitempty" default:"site-index.bleve" env:"LIBRATE_SEARCH_INDEX_PATH"`
}

currently only couchdb is supported

type ThumbnailConfig

type ThumbnailConfig struct {
	// Target namespaces can be grouped together or defined individually
	TargetNS []ThumbnailerNamespace `yaml:"namespaces" default:"[{names: {album_cover, film_poster} size: {Width: 500, Height: 500}}]"`
}

FIXME: currently this cannot be reliably configured via environment variables

type ThumbnailerNamespace

type ThumbnailerNamespace struct {
	Names   []string         `yaml:"names" validate:"required,oneof='album_cover' 'film_poster' 'profile' 'all'"`
	MaxSize thumbnailer.Dims `yaml:"size" default:"{Width: 500, Height: 500}"`
}

type ValidationError

type ValidationError struct {
	FailedField string
	Tag         string
	Value       interface{}
}

func Validate

func Validate(conf *Config, validate *validator.Validate) (errs []ValidationError)