Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Register ¶ added in v0.73.0
Register uses serpents to declare client-related flags and config options in the specified *pflag.FlagSet
func RegisterServer ¶ added in v0.90.0
RegisterServer uses serpents to declare server-related flags and config options in the specified *pflag.FlagSet
Types ¶
type ClientConfig ¶
type ClientConfig struct { Cli struct { Style string } Api struct { Host string Key string PageSize int Page int Protocol string Port int } }
Struct ClientConfig holds config options needed by a client. Example uses are:
- Cli output style
- Remote (or local) API connection informations
type Config ¶
type Config struct { // Client configuration Client ClientConfig // Server configuration Server ServerConfig }
Struct Config is used as the primary target for viper.Unmarshal() in haul
It tries to contain all possible configuration options, and will apply the proper defaults set by cobra.
Config options are split between Config.Server and Config.Client.
type ServerConfig ¶
type ServerConfig struct { Api struct { Key string Port int TLS struct { Enabled bool Cert string Key string } } Postgres struct { Database string Host string Password string Port int User string SSLEnabled bool } Web struct { Password string Port int Username string } }
Struct ServerConfig holds config options needed by a server. Examples uses are:
- API server configurations for hosting
- Database connection informations
Click to show internal directories.
Click to hide internal directories.