config

Documentation

Index

• Constants
• type Configuration
  • func (cfg *Configuration) Cleanup()

Constants

const (
	// EndpointAdministration is the endpoint path of the web interface administration panel.
	EndpointAdministration = "/admin"
	// EndpointAccount is the endpoint path of the web interface account panel.
	EndpointAccount = "/account"

	// EndpointGenerateAPIKey is the endpoint path of the API key generator.
	EndpointGenerateAPIKey = "/generate-api-key"
	// EndpointVerifyAPIKey is the endpoint path for API key verification.
	EndpointVerifyAPIKey = "/verify-api-key"
	// EndpointAssignAPIKey is the endpoint path used for assigning an API key to an account.
	EndpointAssignAPIKey = "/assign-api-key"

	// EndpointList is the endpoint path for listing all stored accounts.
	EndpointList = "/list"
	// EndpointFind is the endpoint path for finding accounts.
	EndpointFind = "/find"

	// EndpointCreate is the endpoint path for account creation.
	EndpointCreate = "/create"
	// EndpointUpdate is the endpoint path for account updates.
	EndpointUpdate = "/update"
	// EndpointConfigure is the endpoint path for account configuration.
	EndpointConfigure = "/configure"
	// EndpointRemove is the endpoint path for account removal.
	EndpointRemove = "/remove"

	// EndpointLogin is the endpoint path for (internal) user login.
	EndpointLogin = "/login"
	// EndpointLogout is the endpoint path for (internal) user logout.
	EndpointLogout = "/logout"
	// EndpointResetPassword is the endpoint path for resetting user passwords
	EndpointResetPassword = "/reset-password"
	// EndpointContact is the endpoint path for sending contact emails
	EndpointContact = "/contact"

	// EndpointVerifyUserToken is the endpoint path for user token validation.
	EndpointVerifyUserToken = "/verify-user-token"

	// EndpointAuthorize is the endpoint path for account authorization.
	EndpointAuthorize = "/authorize"
	// EndpointIsAuthorized is the endpoint path used to check the authorization status of an account.
	EndpointIsAuthorized = "/is-authorized"

	// EndpointGrantGOCDBAccess is the endpoint path for granting or revoking GOCDB access.
	EndpointGrantGOCDBAccess = "/grant-gocdb-access"

	// EndpointUnregisterSite is the endpoint path for site unregistration.
	EndpointUnregisterSite = "/unregister-site"

	// EndpointDispatchAlert is the endpoint path for dispatching alerts from Prometheus.
	EndpointDispatchAlert = "/dispatch-alert"
)

Types

type Configuration

type Configuration struct {
	Prefix string `mapstructure:"prefix"`

	Storage struct {
		Driver string `mapstructure:"driver"`

		File struct {
			File string `mapstructure:"file"`
		} `mapstructure:"file"`
	} `mapstructure:"storage"`

	Email struct {
		SMTP              *smtpclient.SMTPCredentials `mapstructure:"smtp"`
		NotificationsMail string                      `mapstructure:"notifications_mail"`
	} `mapstructure:"email"`

	Mentix struct {
		URL                      string `mapstructure:"url"`
		DataEndpoint             string `mapstructure:"data_endpoint"`
		SiteRegistrationEndpoint string `mapstructure:"sitereg_endpoint"`
	} `mapstructure:"mentix"`

	Webserver struct {
		URL string `mapstructure:"url"`

		SessionTimeout      int  `mapstructure:"session_timeout"`
		VerifyRemoteAddress bool `mapstructure:"verify_remote_address"`
		LogSessions         bool `mapstructure:"log_sessions"`
	} `mapstructure:"webserver"`

	GOCDB struct {
		URL      string `mapstructure:"url"`
		WriteURL string `mapstructure:"write_url"`

		APIKey string `mapstructure:"apikey"`
	} `mapstructure:"gocdb"`
}

Configuration holds the general service configuration.

func (*Configuration) Cleanup

func (cfg *Configuration) Cleanup()

Cleanup cleans up certain settings, normalizing them.