serveropts

Documentation

Overview

Package serveropts contains an echo server options wrapper

Index

• type ServerOption
  • func WithAnalytics() ServerOption
  • func WithAuth() ServerOption
  • func WithCORS() ServerOption
  • func WithCacheHeaders() ServerOption
  • func WithConfigProvider(cfgProvider config.ConfigProvider) ServerOption
  • func WithEmailManager() ServerOption
  • func WithGeneratedKeys() ServerOption
  • func WithGraphRoute(srv *server.Server, c *generated.Client) ServerOption
  • func WithHTTPS() ServerOption
  • func WithLogger(l *zap.SugaredLogger) ServerOption
  • func WithMiddleware() ServerOption
  • func WithOTP() ServerOption
  • func WithRateLimiter() ServerOption
  • func WithReadyChecks(c *entx.EntClientConfig, f *fgax.Client, r *redis.Client) ServerOption
  • func WithRedirects() ServerOption
  • func WithSecureMW() ServerOption
  • func WithSentry() ServerOption
  • func WithSessionManager(rc *redis.Client) ServerOption
  • func WithTaskManager() ServerOption
• type ServerOptions
  • func NewServerOptions(opts []ServerOption, cfgLoc string) *ServerOptions
  • func (so *ServerOptions) AddServerOptions(opt ServerOption)

Types

type ServerOption

type ServerOption interface {
	// contains filtered or unexported methods
}

func WithAnalytics

func WithAnalytics() ServerOption

WithAnalytics sets up the PostHog analytics manager

func WithAuth

func WithAuth() ServerOption

WithAuth supplies the authn and jwt config for the server

func WithCORS

func WithCORS() ServerOption

WithCORS sets up the CORS middleware for the server

func WithCacheHeaders

func WithCacheHeaders() ServerOption

WithCacheHeaders sets up the cache control headers for the server

func WithConfigProvider

func WithConfigProvider(cfgProvider config.ConfigProvider) ServerOption

WithConfigProvider supplies the config for the server

func WithEmailManager

func WithEmailManager() ServerOption

WithEmailManager sets up the default SendGrid email manager to be used to send emails to users on registration, password reset, etc

func WithGeneratedKeys

func WithGeneratedKeys() ServerOption

WithGeneratedKeys will generate a public/private key pair that can be used for jwt signing. This should only be used in a development environment

func WithGraphRoute

func WithGraphRoute(srv *server.Server, c *generated.Client) ServerOption

WithGraphRoute adds the graph handler to the server

func WithHTTPS

func WithHTTPS() ServerOption

WithHTTPS sets up TLS config settings for the server

func WithLogger

func WithLogger(l *zap.SugaredLogger) ServerOption

WithLogger supplies the logger for the server

func WithMiddleware

func WithMiddleware() ServerOption

WithMiddleware adds the middleware to the server

func WithOTP

func WithOTP() ServerOption

WithOTP sets up the OTP provider

func WithRateLimiter

func WithRateLimiter() ServerOption

WithRateLimiter sets up the rate limiter for the server

func WithReadyChecks

func WithReadyChecks(c *entx.EntClientConfig, f *fgax.Client, r *redis.Client) ServerOption

WithReadyChecks adds readiness checks to the server

func WithRedirects

func WithRedirects() ServerOption

WithRedirects sets up the redirects for the server

func WithSecureMW

func WithSecureMW() ServerOption

WithSecureMW sets up the secure middleware for the server

func WithSentry

func WithSentry() ServerOption

WithSentry sets up the sentry middleware for error tracking

func WithSessionManager

func WithSessionManager(rc *redis.Client) ServerOption

WithSessionManager sets up the default session manager with a 10 minute ttl with persistence to redis

func WithTaskManager

func WithTaskManager() ServerOption

WithTaskManager sets up the default Marionette task manager to be used for delegating background tasks

type ServerOptions

type ServerOptions struct {
	ConfigProvider serverconfig.ConfigProvider
	Config         serverconfig.Config
}

func NewServerOptions

func NewServerOptions(opts []ServerOption, cfgLoc string) *ServerOptions

func (*ServerOptions) AddServerOptions

func (so *ServerOptions) AddServerOptions(opt ServerOption)

AddServerOptions applies a server option after the initial setup this should be used when information is not available on NewServerOptions