config

package

v1.109.0 Latest Latest Go to latest Published: Jul 9, 2026 License: MIT Imports: 2 Imported by: 1

Details

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

Repository

github.com/ONSdigital/florence

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Config
- func Get() (*Config, error)
type SharedConfig

Constants ¶

View Source

const (
	DefaultBindAddr             = ":8080"
	DefaultAPIRouterURL         = "http://localhost:23200"
	DefaultFrontendRouterURL    = "http://localhost:20000"
	DefaultDatasetControllerURL = "http://localhost:24000"
	DefaultTableRendererURL     = "http://localhost:23300"
	DefaultDataAdminURL         = "http://localhost:29400/data-admin"
	DefaultAPIRouterVersion     = "v1"
)

Default configuration values

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	BindAddr                   string        `envconfig:"BIND_ADDR"`
	APIRouterURL               string        `envconfig:"API_ROUTER_URL"`
	FrontendRouterURL          string        `envconfig:"ROUTER_URL"`
	DatasetControllerURL       string        `envconfig:"DATASET_CONTROLLER_URL"`
	TableRendererURL           string        `envconfig:"TABLE_RENDERER_URL"`
	DataAdminURL               string        `envconfig:"DATA_ADMIN_URL"`
	GracefulShutdownTimeout    time.Duration `envconfig:"GRACEFUL_SHUTDOWN_TIMEOUT"`
	HealthCheckInterval        time.Duration `envconfig:"HEALTHCHECK_INTERVAL"`
	HealthCheckCriticalTimeout time.Duration `envconfig:"HEALTHCHECK_CRITICAL_TIMEOUT"`
	SharedConfig               SharedConfig
}

Config represents the configuration required for florence

func Get ¶

func Get() (*Config, error)

Get retrieves the config from the environment for florence

type SharedConfig ¶

type SharedConfig struct {
	AllowedExternalPaths    []string `envconfig:"ALLOWED_EXTERNAL_PATHS" json:"allowedExternalPaths"`
	APIRouterVersion        string   `envconfig:"API_ROUTER_VERSION" json:"apiRouterVersion"`
	EnableCantabularJourney bool     `envconfig:"ENABLE_CANTABULAR_JOURNEY" json:"enableCantabularJourney"`
	EnableDataAdmin         bool     `envconfig:"ENABLE_DATA_ADMIN" json:"enableDataAdmin"`
	EnableMigrationField    bool     `envconfig:"ENABLE_MIGRATION_FIELD" json:"enableMigrationField"`
	EnableNewUpload         bool     `envconfig:"ENABLE_NEW_UPLOAD" json:"enableNewUpload"`
	EnablePermissionsAPI    bool     `envconfig:"ENABLE_PERMISSION_API" json:"enablePermissionsAPI"`
	EnableSystemNavBar      bool     `envconfig:"ENABLE_SYSTEM_NAV_BAR" json:"enableSystemNavBar"`
}

SharedConfig represents the configuration made available to the client-side application from the server

Source Files ¶

View all Source files

config.go

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