config

package

v1.0.2 Latest Latest Go to latest Published: Jul 4, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fulcrumproject/core

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	EnvPrefix = "FULCRUM_"
)

Variables ¶

View Source

var Default = Config{
	Port:           8080,
	HealthPort:     8081,
	Authenticators: []string{"token"},
	JobConfig: JobConfig{
		Maintenance: 24 * time.Hour,
		Retention:   30 * 24 * time.Hour,
		Timeout:     5 * time.Minute,
	},
	AgentConfig: AgentConfig{
		HealthTimeout: 30 * time.Second,
	},
	LogConfig: logging.Conf{
		Level:  slog.LevelInfo,
		Format: "json",
	},
	DBConfig: gormpg.Conf{
		DSN:       "host=localhost user=fulcrum password=fulcrum_password dbname=fulcrum_db port=5432 sslmode=disable",
		LogLevel:  slog.LevelWarn,
		LogFormat: "text",
	},
}

Functions ¶

This section is empty.

Types ¶

type AgentConfig ¶

type AgentConfig struct {
	HealthTimeout time.Duration `json:"healthTimeout" env:"AGENT_HEALTH_TIMEOUT"`
}

Fulcrum Agent configuration

type Config ¶

type Config struct {
	Port           uint            `json:"port" env:"PORT" validate:"required,min=1,max=65535"`
	HealthPort     uint            `json:"healthPort" env:"HEALTH_PORT" validate:"required,min=1,max=65535"`
	Authenticators []string        `json:"authenticators" env:"AUTHENTICATORS" validate:"omitempty,dive,oneof=oauth token"`
	JobConfig      JobConfig       `json:"job" validate:"required"`
	AgentConfig    AgentConfig     `json:"agent" validate:"required"`
	LogConfig      logging.Conf    `json:"log" validate:"required"`
	DBConfig       gormpg.Conf     `json:"db" validate:"required"`
	OAuthConfig    keycloak.Config `json:"oauth" validate:"required"`
}

Fulcrum configuration

type JobConfig ¶

type JobConfig struct {
	Maintenance time.Duration `json:"maintenance" env:"JOB_MAINTENANCE_INTERVAL"`
	Retention   time.Duration `json:"retention" env:"JOB_RETENTION_INTERVAL"`
	Timeout     time.Duration `json:"timeout" env:"JOB_TIMEOUT_INTERVAL"`
}

Fulcrum Job configuration

Source Files ¶

View all Source files

config.go

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