config

Documentation

Index

• type Auth
• type AuthBasic
• type AuthToken
• type Config
  • func Load() (*Config, error)
  • func (c *Config) MigrateLegacyConfig()
• type ConfigLoader
  • func NewConfigLoader() *ConfigLoader
  • func (l *ConfigLoader) Load() (*Config, error)
  • func (l *ConfigLoader) LoadLegacyEnv(cfg *Config) error
• type PathResolver
• type Paths
• type PathsConfig
• type RemoteNode
• type TLSConfig
• type UI
• type XDGConfig

Types

type Auth

type Auth struct {
	Basic AuthBasic `mapstructure:"basic"`
	Token AuthToken `mapstructure:"token"`
}

Auth represents the authentication configuration

type AuthBasic

type AuthBasic struct {
	Enabled  bool   `mapstructure:"enabled"`
	Username string `mapstructure:"username"`
	Password string `mapstructure:"password"`
}

AuthBasic represents the basic authentication configuration

type AuthToken

type AuthToken struct {
	Enabled bool   `mapstructure:"enabled"`
	Value   string `mapstructure:"value"`
}

AuthToken represents the authentication token configuration

type Config

type Config struct {
	// Server settings
	Host        string `mapstructure:"host"`
	Port        int    `mapstructure:"port"`
	Debug       bool   `mapstructure:"debug"`
	BasePath    string `mapstructure:"basePath"`
	APIBasePath string `mapstructure:"apiBasePath"`
	APIBaseURL  string `mapstructure:"apiBaseURL"` // For backward compatibility
	WorkDir     string `mapstructure:"workDir"`

	// Authentication
	Auth Auth `mapstructure:"auth"`

	// File system paths
	Paths PathsConfig `mapstructure:"paths"`

	// Legacy fields for backward compatibility - Start
	// Note: These fields are used for backward compatibility and should not be used in new code
	// Deprecated: Use Auth.Basic.Enabled instead
	DAGs string `mapstructure:"dags"`
	// Deprecated: Use Paths.Executable instead
	Executable string `mapstructure:"executable"`
	// Deprecated: Use Paths.LogDir instead
	LogDir string `mapstructure:"logDir"`
	// Deprecated: Use Paths.DataDir instead
	DataDir string `mapstructure:"dataDir"`
	// Deprecated: Use Paths.SuspendFlagsDir instead
	SuspendFlagsDir string `mapstructure:"suspendFlagsDir"`
	// Deprecated: Use Paths.AdminLogsDir instead
	AdminLogsDir string `mapstructure:"adminLogsDir"`
	// Deprecated: Use Paths.BaseConfig instead
	BaseConfig string `mapstructure:"baseConfig"`
	// Deprecated: Use Auth.Token.Enabled instead
	IsBasicAuth bool `mapstructure:"isBasicAuth"`
	// Deprecated: Use Auth.Basic.Username instead
	BasicAuthUsername string `mapstructure:"basicAuthUsername"`
	// Deprecated: Use Auth.Basic.Password instead
	BasicAuthPassword string `mapstructure:"basicAuthPassword"`
	// Deprecated: Use Auth.Token.Enabled instead
	IsAuthToken bool `mapstructure:"isAuthToken"`
	// Deprecated: Use Auth.Token.Value instead
	AuthToken string `mapstructure:"authToken"`
	// Deprecated: Use UI.LogEncodingCharset instead
	LogEncodingCharset string `mapstructure:"logEncodingCharset"`
	// Deprecated: Use UI.NavbarColor instead
	NavbarColor string `mapstructure:"navbarColor"`
	// Deprecated: Use UI.NavbarTitle instead
	NavbarTitle string `mapstructure:"navbarTitle"`
	// Deprecated: Use UI.MaxDashboardPageLimit instead
	MaxDashboardPageLimit int `mapstructure:"maxDashboardPageLimit"`

	// Other settings
	LogFormat         string         `mapstructure:"logFormat"`
	LatestStatusToday bool           `mapstructure:"latestStatusToday"`
	TZ                string         `mapstructure:"tz"`
	Location          *time.Location `mapstructure:"-"`
	Env               sync.Map       `mapstructure:"-"`

	UI UI `mapstructure:"ui"`

	// Remote nodes configuration
	RemoteNodes []RemoteNode `mapstructure:"remoteNodes"`

	// TLS configuration
	TLS *TLSConfig `mapstructure:"tls"`
}

Config represents the server configuration with both new and legacy fields

func Load

func Load() (*Config, error)

Load creates a new configuration with backward compatibility

func (*Config) MigrateLegacyConfig

func (c *Config) MigrateLegacyConfig()

MigrateLegacyConfig migrates legacy configuration

type ConfigLoader

type ConfigLoader struct {
	// contains filtered or unexported fields
}

func NewConfigLoader

func NewConfigLoader() *ConfigLoader

func (*ConfigLoader) Load

func (l *ConfigLoader) Load() (*Config, error)

func (*ConfigLoader) LoadLegacyEnv

func (l *ConfigLoader) LoadLegacyEnv(cfg *Config) error

type PathResolver

type PathResolver struct {
	Paths
	XDGConfig
}

type Paths

type Paths struct {
	ConfigDir       string
	DAGsDir         string
	SuspendFlagsDir string
	DataDir         string
	LogsDir         string
	AdminLogsDir    string
	BaseConfigFile  string
}

type PathsConfig

type PathsConfig struct {
	DAGsDir         string `mapstructure:"dagsDir"`
	Executable      string `mapstructure:"executable"`
	LogDir          string `mapstructure:"logDir"`
	DataDir         string `mapstructure:"dataDir"`
	SuspendFlagsDir string `mapstructure:"suspendFlagsDir"`
	AdminLogsDir    string `mapstructure:"adminLogsDir"`
	BaseConfig      string `mapstructure:"baseConfig"`
}

Paths represents the file system paths configuration

type RemoteNode

type RemoteNode struct {
	Name              string `mapstructure:"name"`
	APIBaseURL        string `mapstructure:"apiBaseURL"`
	IsBasicAuth       bool   `mapstructure:"isBasicAuth"`
	BasicAuthUsername string `mapstructure:"basicAuthUsername"`
	BasicAuthPassword string `mapstructure:"basicAuthPassword"`
	IsAuthToken       bool   `mapstructure:"isAuthToken"`
	AuthToken         string `mapstructure:"authToken"`
	SkipTLSVerify     bool   `mapstructure:"skipTLSVerify"`
}

RemoteNode represents a remote node configuration

type TLSConfig

type TLSConfig struct {
	CertFile string `mapstructure:"certFile"`
	KeyFile  string `mapstructure:"keyFile"`
}

TLSConfig represents TLS configuration

type UI

type UI struct {
	LogEncodingCharset    string `mapstructure:"logEncodingCharset"`
	NavbarColor           string `mapstructure:"navbarColor"`
	NavbarTitle           string `mapstructure:"navbarTitle"`
	MaxDashboardPageLimit int    `mapstructure:"maxDashboardPageLimit"`
}

type XDGConfig

type XDGConfig struct {
	DataHome   string
	ConfigHome string
}