chissy

package module

v0.0.0-...-d9790bb Latest Latest Go to latest Published: Feb 5, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kaatinga/chissy

Links

Open Source Insights

README ¶

chissy

Documentation ¶

Overview ¶

Package chissy package is intended for quick web service development.

Index ¶

func RedirectToHTTPS(domains []string) http.Handler
func Static(r chi.Router, path string, root http.FileSystem)
type Config
- func NewConfig() *Config
type ExtraFunc
type SSL
type SetUpHandlers

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RedirectToHTTPS ¶

func RedirectToHTTPS(domains []string) http.Handler

func Static ¶

func Static(r chi.Router, path string, root http.FileSystem)

Static conveniently sets up a http.FileServer handler to serve static files from a http.FileSystem.

Types ¶

type Config ¶

type Config struct {
	ProductionMode    bool          `env:"PROD"`
	LocalhostDomain   string        `env:"LOCALHOST_DOMAIN" validate:"required_if=ProductionMode false"`
	SSL               SSL           `validate:"required_if=ProductionMode true"`
	Port              uint16        `env:"PORT" validate:"min=80,max=65535"`
	ReadTimeout       time.Duration `env:"READ_TIMEOUT" default:"1m"`
	ReadHeaderTimeout time.Duration `env:"READ_HEADER_TIMEOUT" default:"15s"`
	WriteTimeout      time.Duration `env:"WRITE_TIMEOUT" default:"1m"`
	// contains filtered or unexported fields
}

Config - http service configuration compatible to settings package. https://github.com/kaatinga/settings

func NewConfig ¶

func NewConfig() *Config

NewConfig creates new config model that later can be processed by settings package or updated manually.

func (*Config) Init ¶

func (c *Config) Init()

func (*Config) Launch ¶

func (c *Config) Launch(setupHandlers SetUpHandlers, extrafuncs ...ExtraFunc) error

Launch enables the configured web server with the handlers that announced in a function matched with SetUpHandlers type.

func (*Config) Terminate ¶

func (c *Config) Terminate()

type ExtraFunc ¶

type ExtraFunc func() error

type SSL ¶

type SSL struct {
	Domains    string `env:"DOMAINS" validate:"required"`
	Email      string `env:"EMAIL" validate:"email"`
	DomainList []string
}

type SetUpHandlers ¶

type SetUpHandlers func(r *chi.Mux)

SetUpHandlers type to announce handlers.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL