ns

README

night-stalker

Documentation

Index

• type App
  • func New(options AppOptions) (*App, error)
  • func (app *App) Start() error
  • func (app *App) Stop()
• type AppOptions
• type SteamCredentials

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func New

func New(options AppOptions) (*App, error)

func (*App) Start

func (app *App) Start() error

func (*App) Stop

func (app *App) Stop()

type AppOptions

type AppOptions struct {
	Log             *nslog.Logger
	DB              *gorm.DB
	Redis           *nsrds.Redis
	Credentials     *SteamCredentials
	ShutdownTimeout time.Duration
}

type SteamCredentials

type SteamCredentials struct {
	// Steam API key.
	APIKey string
	// Steam username.
	Username string
	// Steam password.
	Password string
	// Steam Guard email code.
	AuthCode string
	// Steam Guard mobile two-factor authentication code.
	TwoFactorCode string
	// If set to true, ns will save a login key and next logins won't need a password.
	// ns will never save the password.
	RememberPassword bool
}

SteamCredentials contains Steam authentication information.