config

package module
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 18, 2026 License: Apache-2.0 Imports: 17 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ProviderSet = wire.NewSet(
	GetConfig,
	ProvideLoggerConfig,
	ProvideDataConfig,
	ProvideExtensionConfig,
	ProvideAuthConfig,
	ProvideStorageConfig,
	ProvideEmailConfig,
	ProvideOAuthConfig,
)

ProviderSet is the wire provider set for the config package. It provides the main *Config and extracts sub-configurations for other modules to use.

Usage: 

wire.Build(
    config.ProviderSet,
    // ... other providers
)

Available configurations:

  • *Config: Main configuration
  • *Logger: Logger configuration
  • *Data: Data layer configuration
  • *Extension: Extension system configuration
  • *Auth: Authentication configuration
  • *Storage: Storage configuration
  • *Email: Email configuration
  • *OAuth: OAuth configuration

Functions

func BindConfigToContext 

func BindConfigToContext(ctx context.Context) context.Context

BindConfigToContext binds the configuration to the context.

func Reload 

func Reload() error

Reload reloads the configuration from the file.

func Watch 

func Watch(callback func(*Config))

Watch watches the configuration file and reloads it when it changes.

Types

type Auth 

type Auth struct {
	JWT                    *JWT     `json:"jwt" yaml:"jwt"`
	Casbin                 *Casbin  `json:"casbin" yaml:"casbin"`
	Whitelist              []string `json:"whitelist" yaml:"whitelist"`
	MaxSessions            int      `json:"max_sessions" yaml:"max_sessions"`
	SessionCleanupInterval int      `json:"session_cleanup_interval" yaml:"session_cleanup_interval"`
}

Auth auth config struct

func ProvideAuthConfig added in v0.2.0 

func ProvideAuthConfig(cfg *Config) *Auth

ProvideAuthConfig provides the authentication configuration.

type Casbin 

type Casbin struct {
	Path  string
	Model string
}

Casbin casbin config struct

type Config 

type Config struct {
	AppName     string       `yaml:"app_name" json:"app_name"`
	Environment string       `yaml:"environment" json:"environment"`
	Protocol    string       `yaml:"protocol" json:"protocol"`
	Domain      string       `yaml:"domain" json:"domain"`
	Host        string       `yaml:"host" json:"host"`
	Port        int          `yaml:"port" json:"port"`
	GRPC        *GRPC        `yaml:"grpc" json:"grpc"`
	Consul      *Consul      `yaml:"consul" json:"consul"`
	Observes    *Observes    `yaml:"observes" json:"observes"`
	Extension   *Extension   `yaml:"extension" json:"extension"`
	Frontend    *Frontend    `yaml:"frontend" json:"frontend"`
	Logger      *Logger      `yaml:"logger" json:"logger"`
	Data        *Data        `yaml:"data" json:"data"`
	Auth        *Auth        `yaml:"auth" json:"auth"`
	Storage     *Storage     `yaml:"storage" json:"storage"`
	OAuth       *OAuth       `yaml:"oauth" json:"oauth"`
	Email       *Email       `yaml:"email" json:"email"`
	Viper       *viper.Viper `yaml:"-" json:"-"`
}

Config represents the configuration implementation.

func GetConfig 

func GetConfig() (*Config, error)

GetConfig returns the configuration. It does not handle errors internally; instead, it returns the error for the caller to handle.

func Init 

func Init() (cfg *Config, err error)

Init initializes and loads the configuration.

func LoadConfig 

func LoadConfig(configPath string) (*Config, error)

LoadConfig loads the configuration from the file.

func (*Config) IsProd 

func (c *Config) IsProd(envs ...string) bool

IsProd returns current environment is production

type Consul 

type Consul struct {
	Address   string `yaml:"address" json:"address"`
	Scheme    string `yaml:"scheme" json:"scheme"`
	Discovery struct {
		DefaultTags   []string          `yaml:"default_tags" json:"default_tags"`
		DefaultMeta   map[string]string `yaml:"default_meta" json:"default_meta"`
		HealthCheck   bool              `yaml:"health_check" json:"health_check"`
		CheckInterval string            `yaml:"check_interval" json:"check_interval"`
		Timeout       string            `yaml:"timeout" json:"timeout"`
	} `yaml:"discovery" json:"discovery"`
}

Consul config struct

type DBNode 

type DBNode = dc.DBNode

DBNode represents a database node

type Data 

type Data = dc.Config

Data represents the data configuration

func ProvideDataConfig added in v0.2.0 

func ProvideDataConfig(cfg *Config) *Data

ProvideDataConfig provides the data layer configuration.

type Email 

type Email = email.Email

Email represents the email configuration

func ProvideEmailConfig added in v0.2.0 

func ProvideEmailConfig(cfg *Config) *Email

ProvideEmailConfig provides the email configuration.

type Extension 

type Extension = ec.Config

Extension represents the extension configuration

func ProvideExtensionConfig added in v0.2.0 

func ProvideExtensionConfig(cfg *Config) *Extension

ProvideExtensionConfig provides the extension system configuration.

type Frontend 

type Frontend struct {
	SignInURL string `json:"sign_in_url" yaml:"sign_in_url"`
	SignUpURL string `json:"sign_up_url" yaml:"sign_up_url"`
}

Frontend frontend config struct

type GRPC 

type GRPC struct {
	Enabled bool   `yaml:"enabled" json:"enabled"`
	Host    string `yaml:"host" json:"host"`
	Port    int    `yaml:"port" json:"port"`
}

type JWT 

type JWT struct {
	Secret string
	Expiry time.Duration
}

JWT jwt config struct

type Logger 

type Logger = lc.Config

Logger represents the logger configuration

func ProvideLoggerConfig added in v0.2.0 

func ProvideLoggerConfig(cfg *Config) *Logger

ProvideLoggerConfig provides the logger configuration.

type OAuth 

type OAuth = oc.Config

OAuth represents the OAuth configuration

func ProvideOAuthConfig added in v0.2.0 

func ProvideOAuthConfig(cfg *Config) *OAuth

ProvideOAuthConfig provides the OAuth configuration.

type Observes 

type Observes struct {
	Sentry *Sentry
	Tracer *Tracer
}

Observes config struct

type Sentry 

type Sentry struct {
	Endpoint string `json:"endpoint" yaml:"endpoint"`
}

Sentry config struct

type Storage 

type Storage = oss.Config

func ProvideStorageConfig added in v0.2.0 

func ProvideStorageConfig(cfg *Config) *Storage

ProvideStorageConfig provides the storage configuration.

type Tracer 

type Tracer struct {
	Endpoint string
}

Tracer config struct

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.