config

Documentation

Overview

Package config provides functions to read in various configuration files into definded types. This includes the main configuration file specifying all details about the distributed setup of pluto.

Index

• type AuthFile
• type AuthPostgres
• type Config
  • func LoadConfig(configFile string) (*Config, error)
• type Distributor
• type IMAP
• type Storage
• type TLS
• type Worker

Types

type AuthFile

type AuthFile struct {
	File      string
	Separator string
}

AuthFile provides information on authenticating user taken from a designated authorization text file.

type AuthPostgres

type AuthPostgres struct {
	IP       string
	Port     uint16
	Database string
	User     string
	Password string
	UseTLS   bool
}

AuthPostgres defines parameters for connecting to a Postgres database for authenticating users.

type Config

type Config struct {
	RootCertLoc     string
	IntlConnTimeout int
	IntlConnRetry   int
	IMAP            IMAP
	Distributor     Distributor
	Workers         map[string]Worker
	Storage         Storage
}

Config holds all information parsed from supplied config file.

func LoadConfig

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

LoadConfig takes in the path to the main config file of pluto in TOML syntax and places the values from the file in the corresponding struct.

type Distributor

type Distributor struct {
	IP           string
	Port         string
	AuthAdapter  string
	PublicTLS    TLS
	InternalTLS  TLS
	AuthFile     *AuthFile
	AuthPostgres *AuthPostgres
}

Distributor describes the configuration of the first entry point of a pluto setup, the IMAP request authenticator and distributor.

type IMAP

type IMAP struct {
	Greeting           string
	HierarchySeparator string
}

IMAP is the IMAP server related part of the TOML config file.

type Storage

type Storage struct {
	IP            string
	MailPort      string
	SyncPort      string
	MaildirRoot   string
	CRDTLayerRoot string
	TLS           TLS
}

Storage configures the global database node storing all user data in a very safe manner.

type TLS

type TLS struct {
	CertLoc string
	KeyLoc  string
}

TLS contains Transport Layer Security relevant parameters. Use this to provide paths to your TLS certificate and key.

type Worker

type Worker struct {
	IP            string
	MailPort      string
	SyncPort      string
	UserStart     int
	UserEnd       int
	MaildirRoot   string
	CRDTLayerRoot string
	TLS           TLS
}

Worker contains the connection and user sharding information for an individual IMAP worker node.