Skip to content

Commit

Permalink
docs: add general Docker requirements (#565)
Browse files Browse the repository at this point in the history
* chore: move system requirements to its own folder

* docs: add a general Docker requirements overview page
  • Loading branch information
mdelapenya committed Oct 13, 2022
1 parent 9860647 commit c0d73a6
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 2 deletions.
12 changes: 12 additions & 0 deletions docs/system_requirements/index.md
@@ -0,0 +1,12 @@
# General Docker requirements

## Overview

Testcontainers requires a Docker-API compatible container runtime.
During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows.
These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary.

It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives.
However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available and additional manual configuration might be necessary.
If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests,
please contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/).
File renamed without changes.
File renamed without changes.
5 changes: 3 additions & 2 deletions mkdocs.yml
Expand Up @@ -51,8 +51,9 @@ nav:
- examples/nginx.md
- examples/redis.md
- System Requirements:
- features/using_colima.md
- features/using_podman.md
- system_requirements/index.md
- system_requirements/using_colima.md
- system_requirements/using_podman.md
- Contributing:
- contributing.md
- contributing_docs.md
Expand Down

0 comments on commit c0d73a6

Please sign in to comment.