config

package

v1.16.0 Latest Latest Go to latest Published: Jan 15, 2026 License: MIT Imports: 4 Imported by: 0

Details

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

Repository

github.com/ONSdigital/dp-files-api

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	MetadataCollection    = "MetadataCollection"
	CollectionsCollection = "CollectionsCollection"
	BundlesCollection     = "BundlesCollection"
	FileEventsCollection  = "FileEventsCollection"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AuthConfig ¶

type AuthConfig = authorisation.Config

type Config ¶

type Config struct {
	BindAddr                   string        `envconfig:"BIND_ADDR"`
	AwsRegion                  string        `envconfig:"AWS_REGION"`
	PrivateBucketName          string        `envconfig:"S3_PRIVATE_BUCKET_NAME"`
	LocalstackHost             string        `envconfig:"LOCALSTACK_HOST"`
	GracefulShutdownTimeout    time.Duration `envconfig:"GRACEFUL_SHUTDOWN_TIMEOUT"`
	HealthCheckInterval        time.Duration `envconfig:"HEALTHCHECK_INTERVAL"`
	HealthCheckCriticalTimeout time.Duration `envconfig:"HEALTHCHECK_CRITICAL_TIMEOUT"`
	IsPublishing               bool          `envconfig:"IS_PUBLISHING"`
	MaxNumBatches              int           `envconfig:"MAX_NUM_BATCHES"`
	MinBatchSize               int           `envconfig:"MIN_BATCH_SIZE"`
	MongoConfig
	KafkaConfig
	AuthConfig
}

Config represents service configuration for dp-files-api

func Get ¶

func Get() (*Config, error)

Get returns the default config with any modifications through environment variables

type KafkaConfig ¶

type KafkaConfig struct {
	Addr                      []string `envconfig:"KAFKA_ADDR"                            json:"-"`
	ProducerMinBrokersHealthy int      `envconfig:"KAFKA_PRODUCER_MIN_BROKERS_HEALTHY"`
	Version                   string   `envconfig:"KAFKA_VERSION"`
	MaxBytes                  int      `envconfig:"KAFKA_MAX_BYTES"`
	SecProtocol               string   `envconfig:"KAFKA_SEC_PROTO"`
	SecCACerts                string   `envconfig:"KAFKA_SEC_CA_CERTS"`
	SecClientKey              string   `envconfig:"KAFKA_SEC_CLIENT_KEY"                  json:"-"`
	SecClientCert             string   `envconfig:"KAFKA_SEC_CLIENT_CERT"`
	SecSkipVerify             bool     `envconfig:"KAFKA_SEC_SKIP_VERIFY"`
	StaticFilePublishedTopic  string   `envconfig:"STATIC_FILE_PUBLISHED_TOPIC"`
}

KafkaConfig contains the config required to connect to Kafka

type MongoConfig ¶

type MongoConfig = mongodb.MongoDriverConfig

Source Files ¶

View all Source files

config.go

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