aero

README

Aero

An interception-based web proxy. Only prerelease builds are available.

Basic Example

You can find a basic example of Aero here

Documentation

Index

• type Aero
  • func New(log *logrus.Logger, client *fasthttp.Client, config Config) (*Aero, error)
• type Config
  • func DefaultConfig() Config

Types

type Aero

type Aero struct {
	// contains filtered or unexported fields
}

Aero represents an instance of the Aero proxy

func New

func New(log *logrus.Logger, client *fasthttp.Client, config Config) (*Aero, error)

New creates and starts a new Aero instance

type Config

type Config struct {
	// SSL contains the SSL configuration information.
	SSL struct {
		// Cert is the path to the SSL certificate file.
		Cert string
		// Key is the path to the SSL key file.
		Key string
		// Enabled indicates whether SSL is enabled.
		Enabled bool
	}
	HTTP struct {
		// Addr is the address the proxy will listen on.
		Addr string
		// Prefix is the prefix used to access the HTTP proxy.
		Prefix string
		// Static is the path to the static files.
		Static string
	}
	WS struct {
		// Prefix is the prefix used to access the WebSocket proxy.
		Prefix string
	}
}

Config is the configuration of an Aero instance.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns a configuration with the default values filled out.