core

Documentation

Index

• func New(version string)
• func Samples() error
• func SetDB(database database.Database)
• type AllNotifiers
• type Core
  • func Select() (*Core, error)
  • func (c *Core) Create() error
  • func (c *Core) Delete() error
  • func (Core) TableName() string
  • func (c *Core) Update() error
• type Integrator
• type OAuth

Functions

func New

func New(version string)

func Samples

func Samples() error

func SetDB

func SetDB(database database.Database)

Types

type AllNotifiers

type AllNotifiers interface{}

AllNotifiers contains all the Notifiers loaded

type Core

type Core struct {
	Name          string          `gorm:"not null;column:name" json:"name,omitempty"`
	Description   string          `gorm:"not null;column:description" json:"description,omitempty"`
	ConfigFile    string          `gorm:"column:config" json:"-"`
	ApiKey        string          `gorm:"column:api_key" json:"api_key" scope:"admin"`
	ApiSecret     string          `gorm:"column:api_secret" json:"api_secret" scope:"admin"`
	Style         string          `gorm:"not null;column:style" json:"style,omitempty"`
	Footer        null.NullString `gorm:"column:footer" json:"footer"`
	Domain        string          `gorm:"not null;column:domain" json:"domain"`
	Version       string          `gorm:"column:version" json:"version"`
	Setup         bool            `gorm:"-" json:"setup"`
	MigrationId   int64           `gorm:"column:migration_id" json:"migration_id,omitempty"`
	UseCdn        null.NullBool   `gorm:"column:use_cdn;default:false" json:"using_cdn,omitempty"`
	LoggedIn      bool            `gorm:"-" json:"logged_in"`
	IsAdmin       bool            `gorm:"-" json:"admin"`
	AllowReports  null.NullBool   `gorm:"column:allow_reports;default:false" json:"allow_reports"`
	CreatedAt     time.Time       `gorm:"column:created_at" json:"created_at"`
	UpdatedAt     time.Time       `gorm:"column:updated_at" json:"updated_at"`
	Started       time.Time       `gorm:"-" json:"started_on"`
	Notifications []AllNotifiers  `gorm:"-" json:"-"`
	Integrations  []Integrator    `gorm:"-" json:"-"`

	OAuth `json:"oauth"`
}

Core struct contains all the required fields for Statping. All application settings will be saved into 1 row in the 'core' table. You can use the core.CoreApp global variable to interact with the attributes to the application, such as services.

var (
	App *Core
)

func Select

func Select() (*Core, error)

func (*Core) Create

func (c *Core) Create() error

func (*Core) Delete

func (c *Core) Delete() error

func (Core) TableName

func (Core) TableName() string

func (*Core) Update

func (c *Core) Update() error

type Integrator

type Integrator interface{}

type OAuth

type OAuth struct {
	Domains            string `gorm:"column:oauth_domains" json:"oauth_domains,omitempty" scope:"admin"`
	Providers          string `gorm:"column:oauth_providers;default:local" json:"oauth_providers,omitempty"`
	GithubClientID     string `gorm:"column:gh_client_id" json:"gh_client_id,omitempty" scope:"admin"`
	GithubClientSecret string `gorm:"column:gh_client_secret" json:"gh_client_secret,omitempty" scope:"admin"`
	GoogleClientID     string `gorm:"column:google_client_id" json:"google_client_id,omitempty" scope:"admin"`
	GoogleClientSecret string `gorm:"column:google_client_secret" json:"google_client_secret,omitempty" scope:"admin"`
	SlackClientID      string `gorm:"column:slack_client_id" json:"slack_client_id,omitempty" scope:"admin"`
	SlackClientSecret  string `gorm:"column:slack_client_secret" json:"slack_client_secret,omitempty" scope:"admin"`
	SlackTeam          string `gorm:"column:slack_team" json:"slack_team,omitempty" scope:"admin"`
}