conf

Documentation

Index

• type Config
  • func Load(path string) *Config
  • func (c *Config) Validate() error

Types

type Config

type Config struct {
	// Port gets the port number under which the site is being hosted.
	Port int

	// UploadDriver is used to select which backend data store is used for file uploads.
	// Supported drivers: fs, s3
	UploadDriver string

	// UploadPath gets the path (full or relative) under which to store uploads.
	// When using Amazon S3, this should be set to the bucket name.
	UploadPath string

	// IsDevelopment defines whether to run the application in "development mode".
	// Development mode turns on additional features, such as logging, that may
	// not be desirable in a production environment.
	IsDevelopment bool

	// SecretKey is used for session authentication. Recommended to be 32 or 64 ASCII characters.
	SecretKey string

	// ApplicationTitle is used where the application name (title) is displayed on screen.
	ApplicationTitle string

	// HomeTitle is an optional heading displayed at the top of the gome screen.
	HomeTitle string

	// HomeImage is an optional heading image displayed beneath the HomeTitle.
	HomeImage string

	// DatabaseDriver gets which database/sql driver to use.
	// Supported drivers: postgres
	DatabaseDriver string

	// DatabaseUrl gets the url (or path, connection string, etc) to use with the associated
	// database driver when opening the database connection.
	DatabaseURL string

	// DatabaseMaxConnections gets the maximum number of open database connection to maintain.
	// This value is fed to sql.DB.SetMaxOpenConns(N). The default is 0 (unlimited).
	DatabaseMaxConnections int
}

Config contains the application configuration settings

func Load

func Load(path string) *Config

Load reads the configuration file from the specified path

func (*Config) Validate

func (c *Config) Validate() error

Validate checks whether the current configuration settings are valid.