nginx

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func GetServer(net, addr string) string
• func Run(config Config, params map[string]interface{}, opts ...Option) error
• type Config
  • func (c *Config) Build(params map[string]interface{}) ([]byte, error)
• type Option
  • func WithTLS(tls httputil.TLSConfig) Option

Functions

func GetServer

func GetServer(net, addr string) string

GetServer returns a string for an nginx server directive value.

func Run

func Run(config Config, params map[string]interface{}, opts ...Option) error

Run injects params into an nginx configuration template and runs it.

Types

type Config

type Config struct {
	Binary string `yaml:"binary"`

	Root bool `yaml:"root"`

	// Name defines the default nginx template for each component.
	Name string `yaml:"name"`

	// TemplatePath takes precedence over Name, overwrites default template.
	TemplatePath string `yaml:"template_path"`

	CacheDir string `yaml:"cache_dir"`

	LogDir string `yaml:"log_dir"`

	// Optional log path overrides.
	StdoutLogPath string `yaml:"stdout_log_path"`
	AccessLogPath string `yaml:"access_log_path"`
	ErrorLogPath  string `yaml:"error_log_path"`
	// contains filtered or unexported fields
}

Config defines nginx configuration.

func (*Config) Build

func (c *Config) Build(params map[string]interface{}) ([]byte, error)

Build builds nginx config.

type Option

type Option func(*Config)

Option allows setting optional nginx configuration.

func WithTLS

func WithTLS(tls httputil.TLSConfig) Option

WithTLS configures nginx configuration with tls.