Nginx¶

Not available until the next release main

Introduction¶

The Testcontainers module for Nginx, a high-performance web server commonly used as a reverse proxy, load balancer, and HTTP cache.

Adding this module to your project dependencies¶

Please run the following command to add the Nginx module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/nginx

Usage example¶

Creating a Nginx container

ctx := context.Background()

nginxContainer, err := nginx.Run(ctx, "nginx:1.25")
defer func() {
    if err := testcontainers.TerminateContainer(nginxContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

Module Reference¶

Run function¶

Not available until the next release main

The Nginx module exposes one entrypoint function to create the Nginx container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)

context.Context, the Go context.
string, the Docker image to use.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Image¶

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "nginx:1.25").

Container Options¶

When starting the Nginx container, you can pass options in a variadic way to configure it.

WithConfigFile¶

Not available until the next release main

WithConfigFile mounts a custom nginx.conf file at /etc/nginx/nginx.conf in the container, replacing the default Nginx main configuration. The hostPath argument must be an absolute path to the configuration file on the host.

nginx.Run(ctx, "nginx:1.25", nginx.WithConfigFile("/path/to/nginx.conf"))

WithCustomConfig¶

Not available until the next release main

WithCustomConfig mounts a configuration snippet at /etc/nginx/conf.d/default.conf in the container. Use this option to customise the default virtual-host behaviour (locations, upstreams, proxy settings, etc.) without replacing the entire main configuration. The hostPath argument must be an absolute path to the configuration file on the host.

nginx.Run(ctx, "nginx:1.25", nginx.WithCustomConfig("/path/to/default.conf"))

The following options are exposed by the testcontainers package.

Basic Options¶

WithExposedPorts Since v0.37.0
WithEnv Since v0.29.0
WithWaitStrategy Since v0.20.0
WithAdditionalWaitStrategy Since v0.38.0
WithWaitStrategyAndDeadline Since v0.20.0
WithAdditionalWaitStrategyAndDeadline Since v0.38.0
WithEntrypoint Since v0.37.0
WithEntrypointArgs Since v0.37.0
WithCmd Since v0.37.0
WithCmdArgs Since v0.37.0
WithLabels Since v0.37.0

Lifecycle Options¶

WithLifecycleHooks Since v0.38.0
WithAdditionalLifecycleHooks Since v0.38.0
WithStartupCommand Since v0.25.0
WithAfterReadyCommand Since v0.28.0

Files & Mounts Options¶

Build Options¶

WithDockerfile Since v0.37.0

Logging Options¶

Image Options¶

Networking Options¶

Advanced Options¶

WithHostPortAccess Since v0.31.0
WithConfigModifier Since v0.20.0 · Chainable since main
WithHostConfigModifier Since v0.20.0 · Chainable since main
WithEndpointSettingsModifier Since v0.20.0 · Chainable since main
CustomizeRequest Since v0.20.0
WithName Since v0.38.0
WithNoStart Since v0.38.0
WithProvider Since v0.39.0

Experimental Options¶

WithReuseByName Since v0.37.0

Container Methods¶

The Nginx container exposes the following methods:

HTTPEndpoint¶

Not available until the next release main

HTTPEndpoint returns the HTTP endpoint of the running Nginx container in the form http://host:mappedPort, using the container's mapped port 80.

Get HTTP endpoint

httpEndpoint, err := ctr.HTTPEndpoint(ctx)

HTTPSEndpoint¶

Not available until the next release main

HTTPSEndpoint returns the HTTPS endpoint of the running Nginx container in the form https://host:mappedPort, using the container's mapped port 443.

httpsEndpoint, err := nginxContainer.HTTPSEndpoint(ctx)