nginx

package

v0.0.114 Latest Latest Go to latest Published: Apr 14, 2020 License: Apache-2.0 Imports: 12 Imported by: 0

Details

View Source

const (
	// Dependency is the key used in the build plan by this buildpack
	Dependency = "nginx"
	Mainline   = "mainline"
	Stable     = "stable"
)

This section is empty.

func CheckPortExistsInConf(nginxConfPath string, log logger.Logger) error

CheckPortExistsInConf will validate that a `listen {{port}}` directive has been added by the user, if not it prints a warning to the user

func LoadMainlineVersion(metadata buildpack.Metadata) string

LoadMainlineVersion out of buildpack.toml

func LoadStableVersion(metadata buildpack.Metadata) string

LoadStableVersion out of buildpack.toml

type BuildpackYAML struct {
	Config Config `yaml:"nginx"`
}

BuildpackYAML defines configuration options allowed to end users

func LoadBuildpackYAML(appRoot string) (BuildpackYAML, error)

LoadBuildpackYAML reads `buildpack.yml` and NGINX specific config options in it

type Config struct {
	Version string `yaml:"version"`
}

Config is used by BuildpackYAML and defines NGINX specific config options available to users

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

Contributor is responsible for deciding what this buildpack will contribute during build

func NewContributor(context build.Build) (c Contributor, willContribute bool, err error)

NewContributor will create a new Contributor object

func (c Contributor) Contribute() error

Contribute will install NGINX, configure required env variables & set a start command

func (c Contributor) Setup() error