proxy

Documentation

Index

• Constants
• func AddService(filepath string, service Service) error
• func NewErgoProxy(config *Config) *httputil.ReverseProxy
• func RemoveService(filepath string, service Service) error
• func ServeProxy(config *Config) error
• type Config
  • func NewConfig() *Config
  • func (c *Config) AddService(service Service) error
  • func (c *Config) GetProxyPacURL() string
  • func (c *Config) GetService(host string) (*Service, error)
  • func (c *Config) LoadServices() error
  • func (c *Config) OverrideBy(new *Config)
  • func (c *Config) WatchConfigFile(tickerChan <-chan time.Time)
• type Service
  • func NewService(name string, rawURL string) (Service, error)
  • func UnsafeNewService(name string, rawURL string) Service
  • func (s Service) Empty() bool
  • func (s Service) GetOriginalURL() *url.URL
  • func (s Service) GetServiceURL(localTLD string) string
  • func (s Service) String() string

Constants

const (
	PortEnv       = "ERGO_PORT"
	DomainEnv     = "ERGO_DOMAIN"
	VerboseEnv    = "ERGO_VERBOSE"
	ConfigFileEnv = "ERGO_CONFIG_FILE"

	PortDefault           = "2000"
	DomainDefault         = ".dev"
	ConfigFilePathDefault = "./.ergo"
)

Defines the name of ergo env variable for configuration.

Functions

func AddService

func AddService(filepath string, service Service) error

AddService adds new service to the filepath

func NewErgoProxy

func NewErgoProxy(config *Config) *httputil.ReverseProxy

NewErgoProxy returns the new reverse proxy.

func RemoveService

func RemoveService(filepath string, service Service) error

RemoveService removes a service from the filepath

func ServeProxy

func ServeProxy(config *Config) error

ServeProxy listens & serves the HTTP proxy.

Types

type Config

type Config struct {
	Port       string
	Domain     string
	Verbose    bool
	Services   map[string]Service
	ConfigFile string
	// contains filtered or unexported fields
}

Config holds the configuration for the proxy.

func NewConfig

func NewConfig() *Config

NewConfig gets the defaults config.

func (*Config) AddService

func (c *Config) AddService(service Service) error

AddService add a service using the correct key

func (*Config) GetProxyPacURL

func (c *Config) GetProxyPacURL() string

GetProxyPacURL returns the correct url for the pac file

func (*Config) GetService

func (c *Config) GetService(host string) (*Service, error)

GetService gets the service for the given host.

func (*Config) LoadServices

func (c *Config) LoadServices() error

LoadServices loads the services from filepath, returns an error if the configuration could not be parsed

func (*Config) OverrideBy

func (c *Config) OverrideBy(new *Config)

OverrideBy makes sure that it sets the correct config based on the defaults and the passed by argument

func (*Config) WatchConfigFile

func (c *Config) WatchConfigFile(tickerChan <-chan time.Time)

WatchConfigFile listen for file changes and updates the config services

type Service

type Service struct {
	Name string
	URL  *url.URL
}

Service holds the details of the service (Name and URL)

func NewService

func NewService(name string, rawURL string) (Service, error)

NewService creates a new service from a name and a URL

func UnsafeNewService

func UnsafeNewService(name string, rawURL string) Service

UnsafeNewService creates a new service from a name and a URL without checking if the URL is valid. Must only be used in tests

func (Service) Empty

func (s Service) Empty() bool

Empty service means no name or no url

func (Service) GetOriginalURL

func (s Service) GetOriginalURL() *url.URL

GetOriginalURL returns the original URL of the service

func (Service) GetServiceURL

func (s Service) GetServiceURL(localTLD string) string

GetServiceURL returns the local URL to be used by the proxy server to redirect all request to the service

func (Service) String

func (s Service) String() string

String returns a string representation of the service Example:

Service{Name: "test", URL: "http://localhost:8080"}
produces the string "test http://localhost:8080"