config

Documentation

Index

• Variables
• type Cache
• type Config
  • func Load() (*Config, error)
  • func LoadTest() (*Config, error)
• type Database
• type Discord
• type DiscordBot
• type DiscordCommands
• type DiscordGroupRole
• type DiscordGroupSync
• type DiscordUserInfoSync
• type DispatchCenter
• type GRPC
• type Game
• type HTTP
• type JWT
• type Livemap
• type NATS
• type OAuth2
• type OAuth2Endpoints
• type OAuth2Mapping
• type OAuth2Provider
• type OAuth2ProviderType
• type Perm
• type Result
• type Sentry
• type Sessions
• type Tracing
• type UnemployedJob

Variables

var Module = fx.Module("config",
	fx.Provide(
		Load,
	),
)

Types

type Cache

type Cache struct {
	RefreshTime time.Duration `default:"2m" yaml:"refreshTime"`
}

type Config

type Config struct {
	LogLevel string `default:"DEBUG" yaml:"logLevel"`
	Mode     string `default:"debug" yaml:"mode"`

	Sentry  Sentry  `yaml:"sentry"`
	Tracing Tracing `yaml:"tracing"`

	HTTP     HTTP     `yaml:"http"`
	GRPC     GRPC     `yaml:"grpc"`
	Database Database `yaml:"database"`
	NATS     NATS     `yaml:"nats"`
	JWT      JWT      `yaml:"jwt"`
	OAuth2   OAuth2   `yaml:"oauth2"`
	Cache    Cache    `yaml:"cache"`

	Game    Game    `yaml:"game"`
	Discord Discord `yaml:"discord"`
}

func Load

func Load() (*Config, error)

func LoadTest

func LoadTest() (*Config, error)

type Database

type Database struct {
	// refer to https://github.com/go-sql-driver/mysql#dsn-data-source-name for details
	DSN string `yaml:"dsn"`

	// Connection options
	MaxOpenConns    int           `default:"32" yaml:"maxOpenConns"`
	MaxIdleConns    int           `default:"5" yaml:"maxIdleConns"`
	ConnMaxIdleTime time.Duration `default:"15m" yaml:"connMaxIdleTime"`
	ConnMaxLifetime time.Duration `default:"60m" yaml:"connMaxLifetime"`
}

type Discord

type Discord struct {
	Bot DiscordBot `yaml:"bot"`
}

type DiscordBot

type DiscordBot struct {
	Enabled      bool                `default:"false" yaml:"enabled"`
	SyncInterval time.Duration       `default:"15m" yaml:"syncInterval"`
	InviteURL    string              `yaml:"inviteURL"`
	Token        string              `yaml:"token"`
	UserInfoSync DiscordUserInfoSync `yaml:"userInfoSync"`
	GroupSync    DiscordGroupSync    `yaml:"groupSync"`
	Commands     DiscordCommands     `yaml:"commands"`
}

type DiscordCommands

type DiscordCommands struct {
	Enabled bool `default:"false" yaml:"enabled"`
}

type DiscordGroupRole

type DiscordGroupRole struct {
	RoleName    string `yaml:"roleName"`
	Permissions *int64 `yaml:"omitempty,permissions"`
}

type DiscordGroupSync

type DiscordGroupSync struct {
	Enabled bool                        `default:"false" yaml:"enabled"`
	Mapping map[string]DiscordGroupRole `yaml:"omitempty,mapping"`
}

type DiscordUserInfoSync

type DiscordUserInfoSync struct {
	Enabled       bool   `default:"false" yaml:"enabled"`
	RoleFormat    string `default:"[%02d] %s" yaml:"roleFormat"`
	NicknameRegex string `yaml:"nicknameRegex"`
}

type DispatchCenter

type DispatchCenter struct {
	ConvertJobs []string `yaml:"convertJobs"`
}

type GRPC

type GRPC struct {
	Listen string `default:":9090" yaml:"listen"`
}

type Game

type Game struct {
	SignupEnabled      bool           `default:"true" yaml:"signupEnabled"`
	AuditRetentionDays *int           `default:"90" yaml:"auditRetentionDays"`
	SuperuserGroups    []string       `yaml:"superuserGroups"`
	UnemployedJob      UnemployedJob  `yaml:"unemployedJob"`
	PublicJobs         []string       `yaml:"publicJobs"`
	Livemap            Livemap        `yaml:"livemap"`
	DispatchCenter     DispatchCenter `yaml:"dispatchCenter"`
	DefaultPermissions []Perm         `yaml:"defaultPermissions"`
}

type HTTP

type HTTP struct {
	Listen    string   `default:":8080" yaml:"listen"`
	Sessions  Sessions `yaml:"sessions"`
	PublicURL string   `yaml:"publicURL"`
}

type JWT

type JWT struct {
	Secret string `yaml:"secret"`
}

type Livemap

type Livemap struct {
	RefreshTime time.Duration `default:"3s350ms" yaml:"refreshTime"`
	Jobs        []string      `yaml:"jobs"`
	PostalsFile string        `default:".output/public/data/postals.json" yaml:"postalsFile"`
}

type NATS

type NATS struct {
	URL         string `default:"nats://localhost:4222" yaml:"url"`
	WorkerCount int    `default:"5" yaml:"workerCount"`
}

type OAuth2

type OAuth2 struct {
	Providers []*OAuth2Provider
}

type OAuth2Endpoints

type OAuth2Endpoints struct {
	AuthURL     string `yaml:"authURL"`
	TokenURL    string `yaml:"tokenURL"`
	UserInfoURL string `yaml:"userInfoURL"`
}

type OAuth2Mapping

type OAuth2Mapping struct {
	ID       string `yaml:"id"`
	Username string `yaml:"username"`
	Avatar   string `yaml:"avatar"`
}

type OAuth2Provider

type OAuth2Provider struct {
	Name          string             `yaml:"name"`
	Label         string             `yaml:"label"`
	Homepage      string             `yaml:"homepage"`
	Type          OAuth2ProviderType `yaml:"type"`
	DefaultAvatar string             `yaml:"defaultAvatar"`
	RedirectURL   string             `yaml:"redirectURL"`
	ClientID      string             `yaml:"clientID"`
	ClientSecret  string             `yaml:"clientSecret"`
	Scopes        []string           `yaml:"scopes"`
	Endpoints     OAuth2Endpoints    `yaml:"endpoints"`
	Mapping       *OAuth2Mapping     `yaml:"omitempty,mapping"`
}

type OAuth2ProviderType

type OAuth2ProviderType string

const (
	OAuth2ProviderGeneric OAuth2ProviderType = "generic"
	OAuth2ProviderDiscord OAuth2ProviderType = "discord"
)

type Perm

type Perm struct {
	Category string `yaml:"category"`
	Name     string `yaml:"name"`
}

type Result

type Result struct {
	fx.Out

	Config *Config
}

type Sentry

type Sentry struct {
	ServerDSN   string `yaml:"serverDSN"`
	Environment string `default:"dev" yaml:"environment"`
	ClientDSN   string `default:"" yaml:"clientDSN"`
}

type Sessions

type Sessions struct {
	CookieSecret string `yaml:"cookieSecret"`
	Domain       string `default:"localhost" yaml:"domain"`
}

type Tracing

type Tracing struct {
	Enabled     bool   `default:"false" yaml:"enabled"`
	URL         string `yaml:"url"`
	Environment string `default:"dev" yaml:"environment"`
}

type UnemployedJob

type UnemployedJob struct {
	Name  string `default:"unemployed" yaml:"job"`
	Grade int32  `default:"1" yaml:"grade"`
}