proxycontainer

Documentation

Index

• Variables
• func Create(ctx context.Context, docker client.CommonAPIClient, output terminal.Outputer, ...) error
• func FindAndStart(ctx context.Context, docker client.ContainerAPIClient) (types.Container, error)

Variables

var (
	// ProxyImage is the docker hub image with the current CLI version
	ProxyImage = fmt.Sprintf("craftcms/nitro-proxy:%s", version.Version)

	// ProxyName is the name of the proxy container (e.g. nitro-proxy)
	ProxyName = "nitro-proxy"

	// ErrNoProxyContainer is returned when the proxy container is not found
	ErrNoProxyContainer = fmt.Errorf("unable to locate the proxy container")
)

Functions

func Create

func Create(ctx context.Context, docker client.CommonAPIClient, output terminal.Outputer, networkID string) error

Create is used to create a new proxy container for the nitro development environment.

func FindAndStart

func FindAndStart(ctx context.Context, docker client.ContainerAPIClient) (types.Container, error)

FindAndStart will look for the proxy container and verify the container is started. It will return the ErrNoProxyContainer error if it is unable to locate the proxy container. It is NOT responsible for creating the proxy container as that is handled in the initialize package.