s

Documentation

Index

• type DbSettings
• type HttpsSettings
• type Settings
  • func NewSettingsFromFile(filePath string, versionInfo *ver.Versioneer) (stn *Settings, err error)
  • func (stn *Settings) Check() (err error)
  • func (stn *Settings) UseConstructor(filePath string, versionInfo *ver.Versioneer) (cmi.ISettings, error)
• type SystemSettings
  • func (s SystemSettings) Check() (err error)

Types

type DbSettings

type DbSettings = cs.DbSettings

DbSettings are parameters of the Database.

type HttpsSettings

type HttpsSettings = cs.HttpsSettings

HttpsSettings are settings of an HTTPS server for incoming requests.

type Settings

type Settings struct {
	// Path to the file with these settings.
	FilePath cm.Path `json:"-"`

	// Program versioning information.
	VersionInfo *ver.Versioneer `json:"-"`

	HttpsSettings  `json:"https"`
	DbSettings     `json:"db"`
	SystemSettings `json:"system"`

	// External services.
	AcmSettings s.ServiceClientSettings `json:"acm"`
	NmSettings  s.ServiceClientSettings `json:"nm"`
}

Settings is Server's settings.

func NewSettingsFromFile

func NewSettingsFromFile(filePath string, versionInfo *ver.Versioneer) (stn *Settings, err error)

func (*Settings) Check

func (stn *Settings) Check() (err error)

func (*Settings) UseConstructor

func (stn *Settings) UseConstructor(filePath string, versionInfo *ver.Versioneer) (cmi.ISettings, error)

type SystemSettings

type SystemSettings struct {
	DKeySize        base2.Count `json:"dKeySize"`
	MessageEditTime base2.Count `json:"messageEditTime"`
	PageSize        base2.Count `json:"pageSize"`

	// NewThreadsAtTop parameter controls how new and updated threads are
	// placed inside forums. If set to 'True', then following will happen:
	// 1. New threads will be added to the start (top) of the list of forum's
	// threads instead of being added to the end (bottom) of the list;
	// 2. New messages added to threads will update the thread moving it to the
	// start (top) position of the list of forum's threads.
	// If set to 'False', then new threads are added to the end (bottom) of the
	// list and thread's new messages do not update thread's position in the
	// list.
	NewThreadsAtTop base2.Flag `json:"newThreadsAtTop"`

	IsDebugMode base2.Flag `json:"isDebugMode"`
}

SystemSettings are system settings.

func (SystemSettings) Check

func (s SystemSettings) Check() (err error)