server

Documentation

Index

• Variables
• func CDNMaxedOut(c *fiber.Ctx) error
• func PublicMaxedOut(c *fiber.Ctx) error
• type Server
  • func New(config *types.Config, w_log *logger.Wrapper, db *bolt.DB) (server Server)
  • func (s *Server) AdminLogin(context *fiber.Ctx) error
  • func (s *Server) AdminLogout(context *fiber.Ctx) error
  • func (s *Server) Get(bucket_name string, key string) (result string)
  • func (s *Server) GetLogMessages(c *fiber.Ctx) error
  • func (s *Server) GetOBJ(bucket_name string, key string) (result interface{})
  • func (s *Server) LogRequest(context *fiber.Ctx) error
  • func (s *Server) LoginPage(context *fiber.Ctx) error
  • func (s *Server) RenderFailedLogin(context *fiber.Ctx) error
  • func (s *Server) RenderHomePage(context *fiber.Ctx) error
  • func (s *Server) Set(bucket_name string, key string, value string)
  • func (s *Server) SetOBJ(bucket_name string, key string, obj interface{})
  • func (s *Server) SetupAdminRoutes()
  • func (s *Server) SetupPublicRoutes()
  • func (s *Server) Start()
  • func (s *Server) StaticHandler(prefix string, fsys fs.FS) fiber.Handler
  • func (s *Server) ValidateAdmin(context *fiber.Ctx) (result bool)
  • func (s *Server) ValidateAdminLoginCredentials(context *fiber.Ctx) (result bool)
  • func (s *Server) ValidateAdminMW(context *fiber.Ctx) error

Variables

var ADMIN_HTML_FILE fs.File

var ADMIN_HTML_FILE_SIZE int

var CDNFiles embed.FS

var CDNFilesFS fs.FS

var CDNLimter = rate_limiter.New(rate_limiter.Config{
	Max:        6,
	Expiration: 1 * time.Second,
	KeyGenerator: func(c *fiber.Ctx) string {
		return c.Get("x-forwarded-for")
	},
	LimitReached:      CDNMaxedOut,
	LimiterMiddleware: rate_limiter.SlidingWindow{},
})

var HOME_HTML_FILE fs.File

var HOME_HTML_FILE_SIZE int

var HTMLFiles embed.FS

var HTMLFilesFS fs.FS

var LOGIN_HTML_FILE fs.File

var LOGIN_HTML_FILE_SIZE int

var PublicLimter = rate_limiter.New(rate_limiter.Config{
	Max:        3,
	Expiration: 1 * time.Second,
	KeyGenerator: func(c *fiber.Ctx) string {
		return c.Get("x-forwarded-for")
	},
	LimitReached:      PublicMaxedOut,
	LimiterMiddleware: rate_limiter.SlidingWindow{},
})

Functions

func CDNMaxedOut

func CDNMaxedOut(c *fiber.Ctx) error

func PublicMaxedOut

func PublicMaxedOut(c *fiber.Ctx) error

Types

type Server

type Server struct {
	FiberApp *fiber.App      `yaml:"fiber_app"`
	Config   *types.Config   `yaml:"config"`
	Location *time.Location  `yaml:"-"`
	DB       *bolt.DB        `yaml:"-"`
	LOG      *logger.Wrapper `yaml:"-"`
}

func New

func New(config *types.Config, w_log *logger.Wrapper, db *bolt.DB) (server Server)

func (*Server) AdminLogin

func (s *Server) AdminLogin(context *fiber.Ctx) error

POST http://localhost:5950/admin/login

func (*Server) AdminLogout

func (s *Server) AdminLogout(context *fiber.Ctx) error

func (*Server) Get

func (s *Server) Get(bucket_name string, key string) (result string)

func (*Server) GetLogMessages

func (s *Server) GetLogMessages(c *fiber.Ctx) error

func (*Server) GetOBJ

func (s *Server) GetOBJ(bucket_name string, key string) (result interface{})

func (*Server) LogRequest

func (s *Server) LogRequest(context *fiber.Ctx) error

func (*Server) LoginPage

func (s *Server) LoginPage(context *fiber.Ctx) error

func (*Server) RenderFailedLogin

func (s *Server) RenderFailedLogin(context *fiber.Ctx) error

func (*Server) RenderHomePage

func (s *Server) RenderHomePage(context *fiber.Ctx) error

func (*Server) Set

func (s *Server) Set(bucket_name string, key string, value string)

func (*Server) SetOBJ

func (s *Server) SetOBJ(bucket_name string, key string, obj interface{})

func (*Server) SetupAdminRoutes

func (s *Server) SetupAdminRoutes()

func (*Server) SetupPublicRoutes

func (s *Server) SetupPublicRoutes()

func (*Server) Start

func (s *Server) Start()

func (*Server) StaticHandler

func (s *Server) StaticHandler(prefix string, fsys fs.FS) fiber.Handler

Custom static file handler for embedded files

func (*Server) ValidateAdmin

func (s *Server) ValidateAdmin(context *fiber.Ctx) (result bool)

func (*Server) ValidateAdminLoginCredentials

func (s *Server) ValidateAdminLoginCredentials(context *fiber.Ctx) (result bool)

func (*Server) ValidateAdminMW

func (s *Server) ValidateAdminMW(context *fiber.Ctx) error