server

README

server

A simple http server with logging and configs, using http.ListenAndServe

Usage

	// Setup server
	server, err := server.New()
	if err != nil {
		fmt.Printf("Error creating server %s", err)
		return
	}

	// Write to log 
	server.Logf("#info Starting server in %s mode on port %d", server.Mode(), server.Port())

	// Start the server
	err = server.Start()
	if err != nil {
		server.Fatalf("Error starting server %s", err)
	}

Documentation

Overview

Package server offers a simple server with logging and configs

Index

• type Logger
• type Server
  • func New() (*Server, error)
  • func (s *Server) Config(key string) string
  • func (s *Server) ConfigBool(key string) bool
  • func (s *Server) ConfigInt(key string) int64
  • func (s *Server) Configuration() map[string]string
  • func (s *Server) ConfiguredTLSServer(certManager *autocert.Manager) *http.Server
  • func (s *Server) Fatal(format string)
  • func (s *Server) Fatalf(format string, v ...interface{})
  • func (s *Server) Log(message string)
  • func (s *Server) Logf(format string, v ...interface{})
  • func (s *Server) Mode() string
  • func (s *Server) Port() int
  • func (s *Server) PortString() string
  • func (s *Server) Production() bool
  • func (s *Server) Start() error
  • func (s *Server) StartRedirectAll(p int, url string)
  • func (s *Server) StartTLS(cert, key string) error
  • func (s *Server) StartTLSAutocert(email string, domains string) error
  • func (s *Server) Timef(format string, start time.Time, v ...interface{})

Types

type Logger

type Logger interface {
	Printf(format string, args ...interface{})
}

Logger interface for a simple logger (the stdlib log pkg and the fragmenta log pkg conform)

type Server

type Server struct {
	// Our internal logger instance
	Logger Logger
	// contains filtered or unexported fields
}

Server holds the config and logger for the app

func New

func New() (*Server, error)

New creates a new server instance

func (*Server) Config

func (s *Server) Config(key string) string

Config returns a specific configuration value or "" if no value

func (*Server) ConfigBool

func (s *Server) ConfigBool(key string) bool

ConfigBool returns the current configuration value as bool (yes=true, no=false), or false if no value

func (*Server) ConfigInt

func (s *Server) ConfigInt(key string) int64

ConfigInt returns the current configuration value as int64, or 0 if no value

func (*Server) Configuration

func (s *Server) Configuration() map[string]string

Configuration returns the map of configuration keys to values

func (*Server) ConfiguredTLSServer

func (s *Server) ConfiguredTLSServer(certManager *autocert.Manager) *http.Server

ConfiguredTLSServer returns a TLS server instance with a secure config this server has read/write timeouts set to 20 seconds, prefers server cipher suites and only uses certain accelerated curves see - https://blog.gopheracademy.com/advent-2016/exposing-go-on-the-internet/

func (*Server) Fatal

func (s *Server) Fatal(format string)

Fatal logs the message, and then exits with status 1

func (*Server) Fatalf

func (s *Server) Fatalf(format string, v ...interface{})

Fatalf the message with the given arguments to our internal logger, and then exits with status 1

func (*Server) Log

func (s *Server) Log(message string)

Log logs the message to our internal logger

func (*Server) Logf

func (s *Server) Logf(format string, v ...interface{})

Logf logs the message with the given arguments to our internal logger

func (*Server) Mode

func (s *Server) Mode() string

Mode returns the mode (production or development)

func (*Server) Port

func (s *Server) Port() int

Port returns the port of the server

func (*Server) PortString

func (s *Server) PortString() string

PortString returns a string port suitable for passing to http.Server

func (*Server) Production

func (s *Server) Production() bool

Production tells the caller if this server is in production mode or not?

func (*Server) Start

func (s *Server) Start() error

Start starts an http server on the given port

func (*Server) StartRedirectAll

func (s *Server) StartRedirectAll(p int, url string)

StartRedirectAll starts redirecting from port given to the given url this should be called before StartTLS if redirecting to https

func (*Server) StartTLS

func (s *Server) StartTLS(cert, key string) error

StartTLS starts an https server on the given port with tls cert/key from config keys.

func (*Server) StartTLSAutocert

func (s *Server) StartTLSAutocert(email string, domains string) error

StartTLSAutocert starts an https server on the given port by requesting certs from an ACME provider. The server must be on a public IP which matches the DNS for the domains.

func (*Server) Timef

func (s *Server) Timef(format string, start time.Time, v ...interface{})

Timef logs a time since starting, when used with defer at the start of a function to time Usage: defer s.Timef("Completed %s in %s",time.Now(),args...)