Skip to content

Commit d3aa4c8

Browse files
committed
feat: Add documentation for opt-in IPv6 for containers
Signed-off-by: David Rapan <[email protected]>
1 parent c3019bd commit d3aa4c8

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

docs/api/supervisor/endpoints.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1516,18 +1516,20 @@ Returns information about the docker instance.
15161516

15171517
**Returned data:**
15181518

1519-
key | type | description
1520-
-- | -- | --
1521-
version | string | The version of the docker engine
1522-
storage | string | The storage type
1523-
logging | string | The logging type
1524-
registries | dictionary | A dictionary of dictionaries containing `username` and `password` keys for registries.
1519+
| key | type | description |
1520+
| ----------- | ------ | ---------------------------------- |
1521+
| version | string | The version of the docker engine |
1522+
| enable_ipv6 | bool | Enable/Disable IPv6 for containers |
1523+
| storage | string | The storage type |
1524+
| logging | string | The logging type |
1525+
| registries | dictionary | A dictionary of dictionaries containing `username` and `password` keys for registries. |
15251526

15261527
**Example response:**
15271528

15281529
```json
15291530
{
15301531
"version": "1.0.1",
1532+
"enable_ipv6": true,
15311533
"storage": "overlay2",
15321534
"logging": "journald",
15331535
"registries": {}
@@ -1536,6 +1538,19 @@ registries | dictionary | A dictionary of dictionaries containing `username` and
15361538

15371539
</ApiEndpoint>
15381540

1541+
<ApiEndpoint path="/docker/options" method="post">
1542+
Set docker options
1543+
1544+
**Payload:**
1545+
1546+
| key | type | optional | description |
1547+
| ----------- | ---- | -------- | ---------------------------------- |
1548+
| enable_ipv6 | bool | True | Enable/Disable IPv6 for containers |
1549+
1550+
**You need to supply at least one key in the payload.**
1551+
1552+
</ApiEndpoint>
1553+
15391554
<ApiEndpoint path="/docker/registries" method="get">
15401555
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.
15411556

0 commit comments

Comments
 (0)