ranger

Sep 28, 2023

Changes in this version

+ const AssetsURLEnvVar

type Ranger

+ func (r *Ranger) AssetsURL() *url.URL

Sep 18, 2023

Changes in this version

+ const SessionMaxAgeEnvVar

May 30, 2023

Changes in this version

+ func MaintModeHandler(p *template.Parser, l logger.Logger, contact string) http.HandlerFunc

May 15, 2023

Changes in this version

type Config

+ MaintMode bool

May 2, 2023

Changes in this version

type Ranger

+ func BuildWorkerCore(cfg WorkerConfig) (*Ranger, error)

+ type WorkerConfig struct

+ Migrations []postgres.Migration

Apr 14, 2023

Changes in this version

+ const AppDescEnvVar

+ const AppTitleEnvVar

+ const BaseURLEnvVar

+ const ContactUsEnvVar

+ const SessionAuthKeyEnvVar

+ const SessionEncryptKeyEnvVar

+ func NewPostgresConfig(env trails.Environment) *postgres.CxnConfig

type Config

+ FS fs.FS

+ Migrations []postgres.Migration

+ Shutdowns []ShutdownFn

+ func (c *Config[U]) UseDBMock(mockdb *postgres.MockDatabaseService)

+ func (c *Config[U]) UseLogOutput(w io.Writer)

+ func (c Config[U]) Valid() error

+ type Metadata struct

+ Contact string

+ Desc string

+ Title string

type Ranger

+ func (r *Ranger) BaseURL() *url.URL

+ func (r *Ranger) Context() (context.Context, context.CancelFunc)

+ func (r *Ranger) DB() postgres.DatabaseService

+ func (r *Ranger) Env() trails.Environment

+ func (r *Ranger) Metadata() Metadata

+ func (r *Ranger) SessionStore() session.SessionStorer

Mar 30, 2023

Changes in this version

+ type Config struct

+ type RangerUser interface

Aug 30, 2022

Changes in this version

+ const DefaultHost

Aug 26, 2022

Changes in this version

type RangerOption

+ func WithCancelableContext(ctx context.Context, cancel context.CancelFunc) RangerOption

Jul 15, 2022

Changes in this version

+ const DefaultPort

+ const DefaultServerIdleTimeout

+ const DefaultServerReadTimeout

+ const DefaultServerWriteTimeout

+ var ErrBadConfig = errors.New("bad config")

+ var ErrNotExist = errors.New("not exist")

+ var ErrNotValid = errors.New("invalid")

+ type Environment string

+ const Development

+ const Production

+ const Review

+ const Staging

+ const Testing

+ func (e Environment) String() string

+ func (e Environment) Valid() error

+ type OptFollowup func() error

+ type Ranger struct

+ func New(opts ...RangerOption) (*Ranger, error)

+ func (r *Ranger) EmitDB() postgres.DatabaseService

+ func (r *Ranger) EmitKeyring() keyring.Keyringable

+ func (r *Ranger) EmitSessionStore() session.SessionStorer

+ func (r *Ranger) Guide() error

+ func (r *Ranger) Shutdown() error

+ type RangerOption func(rng *Ranger) (OptFollowup, error)

+ func DefaultContext() RangerOption

+ func DefaultDB(list []postgres.Migration) RangerOption

+ func DefaultKeyring(keys ...keyring.Keyable) RangerOption

+ func DefaultLogger(opts ...logger.LoggerOptFn) RangerOption

+ func DefaultParser(files fs.FS, opts ...template.ParserOptFn) RangerOption

+ func DefaultResponder(opts ...resp.ResponderOptFn) RangerOption

+ func DefaultRouter() RangerOption

+ func DefaultSessionStore(opts ...session.ServiceOpt) RangerOption

+ func WithContext(ctx context.Context) RangerOption

+ func WithDB(db postgres.DatabaseService) RangerOption

+ func WithEnv(envVar string) RangerOption

+ func WithKeyring(k keyring.Keyringable) RangerOption

+ func WithLogger(l logger.Logger) RangerOption

+ func WithResponder(r *resp.Responder) RangerOption

+ func WithRouter(r router.Router) RangerOption

+ func WithServer(s *http.Server) RangerOption

+ func WithSessionStore(store session.SessionStorer) RangerOption

+ func WithShutdowns(shutdownFns ...ShutdownFn) RangerOption

+ func WithUserSessions(users middleware.UserStorer) RangerOption

+ type ShutdownFn func(context.Context) error