config

Documentation

Index

• Constants
• Variables
• func BuildCachePath(pathParts ...string) string
• func BuildDataPath(pathParts ...string) string
• func BuildLibraryPath(libraryPath string, pathParts ...string) string
• func BuildPath(base string, pathParts ...string) string
• func GetInitialAdmin() (string, string)
• func LoadEnv()
• func RelativePath(basePath string, fullPath string) string
• func SetEnv()
• type CacheOptions
• type CredentialsModel
• type DBOptions
• type GalleryOptions
• type ImageFormat
• type Layout
• type Library
  • func ParseBasePaths() []Library
• type OptionsModel
• type Visibility

Constants

const (
	Private    Visibility = "private"
	Restricted            = "restricted"
	Public                = "public"
)

Variables

var AppEnvironment log.Environment

var LogLevel zapcore.Level

Functions

func BuildCachePath

func BuildCachePath(pathParts ...string) string

func BuildDataPath

func BuildDataPath(pathParts ...string) string

func BuildLibraryPath

func BuildLibraryPath(libraryPath string, pathParts ...string) string

func BuildPath

func BuildPath(base string, pathParts ...string) string

func GetInitialAdmin

func GetInitialAdmin() (string, string)

func LoadEnv

func LoadEnv()

LoadEnv loads the environment variables.

func RelativePath

func RelativePath(basePath string, fullPath string) string

func SetEnv

func SetEnv()

SetEnv sets the environment variables into Options and Credentials

Types

type CacheOptions

type CacheOptions struct {
	WebServer bool
	TTL       time.Duration
	Size      uint64
}

type CredentialsModel

type CredentialsModel struct {
	JWTSecret  string
	Passphrase string
}

var Credentials *CredentialsModel // TODO: Encrypt in memory?

Credentials stores the JWT secret, and optionally a passphrase and credentials for the db

type DBOptions

type DBOptions struct {
	Name       string
	Migrations bool
}

type GalleryOptions

type GalleryOptions struct {
	ThumbnailFormat       ImageFormat
	FuzzySearchSimilarity float64
	LTR                   bool
}

type ImageFormat

type ImageFormat string

const (
	WebP ImageFormat = "webp"
	AVIF             = "avif"
)

type Layout

type Layout string

const (
	Freeform   Layout = "freeform"
	Structured        = "structured"
)

type Library

type Library struct {
	ID     int32
	Path   string
	Layout string
}

func ParseBasePaths

func ParseBasePaths() []Library

type OptionsModel

type OptionsModel struct {
	Environment    log.Environment
	Domain         string
	Hostname       string
	Port           string
	Secure         bool
	SameSiteMode   http.SameSite
	StrictACAO     bool
	Registrations  bool
	Visibility     Visibility
	DB             DBOptions
	Cache          CacheOptions
	GalleryOptions GalleryOptions
}

var Options *OptionsModel

Options stores the global configuration for the server

type Visibility

type Visibility string