config

Documentation

Overview

Package config is responsible for managing the configuration of this application. It loads and updates the configuration that is provided by the system administrator that set up this application.

Index

• func BasePath() string
• func Load() error
• func Version() string
• type Configuration
  • func Get() Configuration

Functions

func BasePath

func BasePath() string

BasePath returns the configured base path.

func Load

func Load() error

Load loads the configuration or returns an error if something went wrong.

func Version

func Version() string

Version returns the current version of the system.

Types

type Configuration

type Configuration struct {
	BasePath string `` /* 155-byte string literal not displayed */
	Port     int    `name:"port" usage:"Defines the port number STP will listen to."`
	Host     string `` /* 126-byte string literal not displayed */
	DataDir  string `` /* 134-byte string literal not displayed */
	Debug    bool   `name:"debug" usage:"Enable this to get more detailed log output. Default is false."`
}

Configuration contains the configuration for the system. nolint

func Get

func Get() Configuration

Get returns a copy of the configuration.