config

package

v0.7.4 Latest Latest Go to latest Published: Jan 22, 2024 License: GPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Mangatsu/server

Links

Open Source Insights

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 Layout
type Library
- func ParseBasePaths() []Library
type OptionsModel
type Visibility

Constants ¶

View Source

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

Variables ¶

View Source

var AppEnvironment log.Environment

View Source

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 ¶ added in v0.4.0

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 ¶ added in v0.6.0

func SetEnv()

SetEnv sets the environment variables into Options and Credentials

Types ¶

type CacheOptions ¶ added in v0.4.0

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

type CredentialsModel ¶ added in v0.4.0

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 ¶ added in v0.4.0

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 ¶ added in v0.4.0

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

var Options *OptionsModel

Options stores the global configuration for the server

type Visibility ¶ added in v0.4.0

type Visibility string

Source Files ¶

View all Source files

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