config

Documentation

Index

• Constants
• 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
• type CacheOptions
• type CredentialsModel
• type DBOptions
• type Layout
• type Library
  • func ParseBasePaths() []Library
• type OptionsModel
• type Visibility

Constants

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

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 into Options and Credentials

func RelativePath

func RelativePath(basePath string, fullPath string) string

Types

type CacheOptions

type CacheOptions struct {
	WebServer bool
	TTL       time.Duration
}

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 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 {
	Hostname      string
	Port          string
	Registrations bool
	Visibility    Visibility
	DB            DBOptions
	Cache         CacheOptions
}

var Options *OptionsModel

Options stores the global configuration for the server

type Visibility

type Visibility string