configuration

Documentation

Overview

Package configuration provides definitions and functionality related to the configuration.

Index

• type Alertmanager
• type Argon2Config
• type Configuration
  • func Get() *Configuration
• type CryptoConfig
• type Formatting
• type Matrix
• type RepairBehavior

Types

type Alertmanager

type Alertmanager struct {
	AnnotationTitle   string `default:"title"`
	AnnotationMessage string `default:"message"`
}

Alertmanager holds information on how to parse alertmanager calls

type Argon2Config

type Argon2Config struct {
	Memory      uint32 `default:"131072"`
	Iterations  uint32 `default:"4"`
	Parallelism uint8  `default:"4"`
	SaltLength  uint32 `default:"16"`
	KeyLength   uint32 `default:"32"`
}

Argon2Config holds the parameters used for creating hashes with Argon2.

type Configuration

type Configuration struct {
	Debug bool `default:"false"`
	HTTP  struct {
		ListenAddress  string   `default:""`
		Port           int      `default:"8080"`
		TrustedProxies []string `default:"[]"`
		CertFile       string   `default:""`
		KeyFile        string   `default:""`
	}
	Database struct {
		Dialect    string `default:"sqlite3"`
		Connection string `default:"pushbits.db"`
	}
	Admin struct {
		Name     string `default:"admin"`
		Password string `default:"admin"`
		MatrixID string `required:"true"`
	}
	Matrix   Matrix
	Security struct {
		CheckHIBP bool `default:"false"`
	}
	Crypto         CryptoConfig
	Formatting     Formatting
	Alertmanager   Alertmanager
	RepairBehavior RepairBehavior
}

Configuration holds values that can be configured by the user.

func Get

func Get() *Configuration

Get returns the configuration extracted from env variables or config file.

type CryptoConfig

type CryptoConfig struct {
	Argon2 Argon2Config
}

CryptoConfig holds the parameters used for creating hashes.

type Formatting

type Formatting struct {
	ColoredTitle bool `default:"false"`
}

Formatting holds additional parameters used for formatting messages

type Matrix

type Matrix struct {
	Homeserver string `default:"https://matrix.org"`
	Username   string `required:"true"`
	Password   string `required:"true"`
}

Matrix holds credentials for a matrix account

type RepairBehavior

type RepairBehavior struct {
	ResetRoomName  bool `default:"true"`
	ResetRoomTopic bool `default:"true"`
}

RepairBehavior holds information on how repair applications.