config

Documentation

Index

• Constants
• Variables
• func Enqueue(job func())
• func ExecuteCommand(params ExecCmdParams) (string, error)
• func GetBuildInfoString() string
• func GetConfigFilePath() string
• type BuildInfo
  • func GetBuildInfo() BuildInfo
• type CmdOpts
  • func (o CmdOpts) String() string
• type ExecCmdParams
  • func (e ExecCmdParams) String() string
• type Options
  • func GetDefaultConfiguration() Options
  • func ParseCommandLineArgs(clArgs []string) Options
  • func ReadConfiguration(filePath string, clArgs []string) (Options, error)
• type PasswordCredentials
• type UsersByRoles
• type VersionInfo

Constants

const BasicAuthentication = "basic"

const LineBreak = "\n"

const OIDCAuthentication = "oidc"

Variables

var DefaultConfigFilePath = filepath.Join(DefaultIconRepoHome, "config.json")

var DefaultIconDataLocationGit = filepath.Join(DefaultIconRepoHome, "git-repo")

var DefaultIconRepoHome = filepath.Join(os.Getenv("HOME"), ".ui-toolbox/icon-repo")

Functions

func Enqueue

func Enqueue(job func())

func ExecuteCommand

func ExecuteCommand(params ExecCmdParams) (string, error)

func GetBuildInfoString

func GetBuildInfoString() string

GetBuildInfoString constructs and returns a string containing the build info.

func GetConfigFilePath

func GetConfigFilePath() string

GetConfigFilePath gets the path of the configuration file

Types

type BuildInfo

type BuildInfo struct {
	VersionInfo    VersionInfo `json:"versionInfo"`
	AppDescription string      `json:"appDescription"`
}

BuildInfo holds basic information about the application

func GetBuildInfo

func GetBuildInfo() BuildInfo

GetBuildInfo returns basic information about the application

type CmdOpts

type CmdOpts struct {
	Cwd string
}

func (CmdOpts) String

func (o CmdOpts) String() string

type ExecCmdParams

type ExecCmdParams struct {
	Name string
	Args []string
	Opts *CmdOpts
}

func (ExecCmdParams) String

func (e ExecCmdParams) String() string

type Options

type Options struct {
	ServerHostname              string                `` /* 126-byte string literal not displayed */
	ServerPort                  int                   `json:"serverPort" env:"SERVER_PORT" long:"server-port" short:"p" default:"8080" description:"Server port"`
	ServerURLContext            string                `` /* 128-byte string literal not displayed */
	AppDescription              string                `json:"appDescription" env:"APP_DESCRIPTION" long:"app-description" short:"" default:"" description:"Application description"`
	IconDataLocationGit         string                `` /* 143-byte string literal not displayed */
	IconDataCreateNew           string                `` /* 140-byte string literal not displayed */
	AuthenticationType          string                `` /* 137-byte string literal not displayed */
	PasswordCredentials         []PasswordCredentials `json:"passwordCredentials" env:"PASSWORD_CREDENTIALS" long:"password-credentials"`
	OIDCClientID                string                `json:"oidcClientId" env:"OIDC_CLIENT_ID" long:"oidc-client-id" short:"" default:"" description:"OIDC client id"`
	OIDCClientSecret            string                `` /* 127-byte string literal not displayed */
	OIDCAccessTokenURL          string                `` /* 138-byte string literal not displayed */
	OIDCUserAuthorizationURL    string                `` /* 162-byte string literal not displayed */
	OIDCClientRedirectBackURL   string                `` /* 169-byte string literal not displayed */
	OIDCTokenIssuer             string                `json:"oidcTokenIssuer" env:"OIDC_TOKEN_ISSUER" long:"oidc-token-issuer" short:"" default:"" description:"OIDC token issuer"`
	OIDCIpJwtPublicKeyURL       string                `` /* 156-byte string literal not displayed */
	OIDCIpJwtPublicKeyPemBase64 string                `` /* 183-byte string literal not displayed */
	OIDCIpLogoutURL             string                `` /* 126-byte string literal not displayed */
	UsersByRoles                UsersByRoles          `json:"usersByRoles" env:"USERS_BY_ROLES" long:"users-by-roles" short:"" default:"" description:"Users by roles"`
	DBHost                      string                `json:"dbHost" env:"DB_HOST" long:"db-host" short:"" default:"localhost" description:"DB host"`
	DBPort                      int                   `json:"dbPort" env:"DB_PORT" long:"db-port" short:"" default:"5432" description:"DB port"`
	DBUser                      string                `json:"dbUser" env:"DB_USER" long:"db-user" short:"" default:"iconrepo" description:"DB user"`
	DBPassword                  string                `json:"dbPassword" env:"DB_PASSWORD" long:"db-password" short:"" default:"iconrepo" description:"DB password"`
	DBName                      string                `json:"dbName" env:"DB_NAME" long:"db-name" short:"" default:"iconrepo" description:"Name of the database"`
	DBSchemaName                string                `` /* 134-byte string literal not displayed */
	EnableBackdoors             bool                  `json:"enableBackdoors" env:"ENABLE_BACKDOORS" long:"enable-backdoors" short:"" description:"Enable backdoors"`
	PackageRootDir              string                `json:"packageRootDir" env:"PACKAGE_ROOT_DIR" long:"package-root-dir" short:"" default:"" description:"Package root dir"`
	LogLevel                    string                `json:"logLevel" env:"IGOREPO_LOG_LEVEL" long:"log-level" short:"l" default:"info"`
}

Options holds the available command-line options

func GetDefaultConfiguration

func GetDefaultConfiguration() Options

func ParseCommandLineArgs

func ParseCommandLineArgs(clArgs []string) Options

func ReadConfiguration

func ReadConfiguration(filePath string, clArgs []string) (Options, error)

ReadConfiguration reads the configuration file and merges it with the command line arguments

type PasswordCredentials

type PasswordCredentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

PasswordCredentials holds password-credentials

type UsersByRoles

type UsersByRoles map[string][]string

UsersByRoles maps roles to lists of user holding the role

type VersionInfo

type VersionInfo struct {
	Version   string `json:"version"`
	Commit    string `json:"commit"`
	BuildTime string `json:"buildTime"`
}

VersionInfo holds information about the application's version