Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add an example for configuring a custom DockerContainer with exposed port and environment variale #711

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions core/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,18 @@ Using `DockerContainer` and `DockerImage` to create a container:

The `DockerImage` class is used to build the image from the specified path and tag.
The `DockerContainer` class is then used to create a container from the image.


Creating a container with an exposed port and a custom environment variable:

.. doctest::

>>> from testcontainers.core.container import DockerContainer
>>> from testcontainers.core.waiting_utils import wait_for_logs

>>> container = DockerContainer("stain/jena-fuseki:latest")
>>> container.with_exposed_ports(3030)
>>> container.with_env("ADMIN_PASSWORD", "password")
>>> container.start()
>>> delay = wait_for_logs(container, "Fuseki is available")
>>> container_url = f"http://{container.get_container_host_ip()}:{container.get_exposed_port(3030)}"