Skip to content

Add documentation for opt-in IPv6 for containers #2677

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 1, 2025
Merged

Add documentation for opt-in IPv6 for containers #2677

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 21 additions & 6 deletions docs/api/supervisor/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1516,18 +1516,20 @@ Returns information about the docker instance.

**Returned data:**

key | type | description
-- | -- | --
version | string | The version of the docker engine
storage | string | The storage type
logging | string | The logging type
registries | dictionary | A dictionary of dictionaries containing `username` and `password` keys for registries.
| key | type | description |
| ----------- | ------ | ---------------------------------- |
| version | string | The version of the docker engine |
| enable_ipv6 | bool | Enable/Disable IPv6 for containers |
| storage | string | The storage type |
| logging | string | The logging type |
| registries | dictionary | A dictionary of dictionaries containing `username` and `password` keys for registries. |

**Example response:**

```json
{
"version": "1.0.1",
"enable_ipv6": true,
"storage": "overlay2",
"logging": "journald",
"registries": {}
Expand All @@ -1536,6 +1538,19 @@ registries | dictionary | A dictionary of dictionaries containing `username` and

</ApiEndpoint>

<ApiEndpoint path="/docker/options" method="post">
Set docker options

**Payload:**

| key | type | optional | description |
| ----------- | ---- | -------- | ---------------------------------- |
| enable_ipv6 | bool | True | Enable/Disable IPv6 for containers |

**You need to supply at least one key in the payload.**

</ApiEndpoint>

<ApiEndpoint path="/docker/registries" method="get">
Get all configured container registries, this returns a dict with the registry hostname as the key, and a dictionary containing the username configured for that registry.

Expand Down