mattrax

Documentation

Index

• Constants
• type Arguments
  • func (Arguments) Description() string
  • func (Arguments) Version() string
• type Server

Constants

const Version = "v0.0.0-dev"

Version contains the builds version. It is injected at build time

const VersionCommit = "xxxxxx"

VersionCommit contains the Git commit it of the build. It is injected at build time

const VersionDate = "2020.11.12 00:00:00AM"

VersionDate contains the time of the build. It is injected at build time

Types

type Arguments

type Arguments struct {
	Domain  string `placeholder:"\"mdm.example.com\"" arg:"env:DOMAIN" help:"The domain your server is accessible from"`
	DB      string `placeholder:"\"postgres://localhost/Mattrax\"" arg:"env:DB" help:"The Postgres database connection url"`
	Addr    string `default:":443" placeholder:"\":443\"" arg:"env:ADDR" help:"The listen address of the https server"`
	TLSCert string `default:"./certs/tls.crt" placeholder:"\"./certs/tls.crt\"" harg:"env:TLS_CERT" elp:"The path for the tls certificate"`
	TLSKey  string `default:"./certs/tls.key" placeholder:"\"./certs/tls.key\"" arg:"env:TLS_KEY" help:"The path for the tls certificates key"`
	Zipkin  string `` /* 142-byte string literal not displayed */

	GoogleServiceAccountPath string `` /* 173-byte string literal not displayed */
	AzureADClientID          string `` /* 126-byte string literal not displayed */
	AzureADClientSecret      string `` /* 132-byte string literal not displayed */

	MattraxCloud              bool   `` /* 134-byte string literal not displayed */
	MattraxCloudAuth          string `` /* 145-byte string literal not displayed */
	MattraxCloudAuthIP        string `` /* 149-byte string literal not displayed */
	MattraxCloudVendorEmail   string `default:"" arg:"env:MATTRAX_CLOUD_VENDOR_EMAIL" help:"The support email for the Mattrax cloud vendor!"`
	MattraxCloudVendorWebsite string `default:"" arg:"env:MATTRAX_CLOUD_VENDOR_WEBSITE" help:"The support website for the Mattrax cloud vendor!"`
	MattraxCloudVendorPhone   string `default:"" arg:"env:MATTRAX_CLOUD_VENDOR_PHONE" help:"The support phone number for the Mattrax cloud vendor!"`

	Debug bool `help:"Enabled development mode. PLEASE DO NOT USE IN PRODUCTION!"`
}

Arguments are the command line flags

func (Arguments) Description

func (Arguments) Description() string

Description is for alexflint/go-args

func (Arguments) Version

func (Arguments) Version() string

Version is for alexflint/go-args

type Server

type Server struct {
	Args         Arguments
	GlobalRouter *mux.Router
	Router       *mux.Router // Subrouter which is only accessible via secure origins (configured by admin)

	API    *api.Service
	DB     *db.Queries
	DBConn *sql.DB
	Cache  *cache.Cache

	Cert     *certificates.Service
	Auth     *authentication.Service
	Settings *settings.Service
}

Server contains the global server state