Search or ask Docker

RegistryServiceConfig

RegistryServiceConfig schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

RegistryServiceConfig stores daemon registry services configuration.
IndexConfigs

Type: object

All schema constraints and annotations
{
  "additionalProperties": {
    "$ref": "#/components/schemas/IndexInfo"
  },
  "example": {
    "127.0.0.1:5000": {
      "Mirrors": [],
      "Name": "127.0.0.1:5000",
      "Official": false,
      "Secure": false
    },
    "[2001:db8:a0b:12f0::1]:80": {
      "Mirrors": [],
      "Name": "[2001:db8:a0b:12f0::1]:80",
      "Official": false,
      "Secure": false
    },
    "docker.io": {
      "Mirrors": [
        "https://hub-mirror.corp.example.com:5000/"
      ],
      "Name": "docker.io",
      "Official": true,
      "Secure": true
    },
    "registry.internal.corp.example.com:3000": {
      "Mirrors": [],
      "Name": "registry.internal.corp.example.com:3000",
      "Official": false,
      "Secure": false
    }
  },
  "type": "object"
}
InsecureRegistryCIDRs

Type: array

List of IP ranges of insecure registries, using the CIDR syntax (RFC 4632). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication.

By default, local registries (::1/128 and 127.0.0.0/8) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure.

This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax.

Registries can also be marked insecure by hostname. Those registries are listed under IndexConfigs and have their Secure field set to false.

Warning: Using this option can be useful when running a local registry, but introduces security vulnerabilities. This option should therefore ONLY be used for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of IP ranges of insecure registries, using the CIDR syntax\n([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries\naccept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates\nfrom unknown CAs) communication.\n\nBy default, local registries (`::1/128` and `127.0.0.0/8`) are configured as\ninsecure. All other registries are secure. Communicating with an\ninsecure registry is not possible if the daemon assumes that registry\nis secure.\n\nThis configuration override this behavior, insecure communication with\nregistries whose resolved IP address is within the subnet described by\nthe CIDR syntax.\n\nRegistries can also be marked insecure by hostname. Those registries\nare listed under `IndexConfigs` and have their `Secure` field set to\n`false`.\n\n\u003e **Warning**: Using this option can be useful when running a local\n\u003e registry, but introduces security vulnerabilities. This option\n\u003e should therefore ONLY be used for testing purposes. For increased\n\u003e security, users should add their CA to their system's list of trusted\n\u003e CAs instead of enabling this option.\n",
  "example": [
    "::1/128",
    "127.0.0.0/8"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Mirrors

Type: array

List of registry URLs that act as a mirror for the official (docker.io) registry.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of registry URLs that act as a mirror for the official\n(`docker.io`) registry.\n",
  "example": [
    "https://hub-mirror.corp.example.com:5000/",
    "https://[2001:db8:a0b:12f0::1]/"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "RegistryServiceConfig stores daemon registry services configuration.\n",
  "properties": {
    "IndexConfigs": {
      "additionalProperties": {
        "$ref": "#/components/schemas/IndexInfo"
      },
      "example": {
        "127.0.0.1:5000": {
          "Mirrors": [],
          "Name": "127.0.0.1:5000",
          "Official": false,
          "Secure": false
        },
        "[2001:db8:a0b:12f0::1]:80": {
          "Mirrors": [],
          "Name": "[2001:db8:a0b:12f0::1]:80",
          "Official": false,
          "Secure": false
        },
        "docker.io": {
          "Mirrors": [
            "https://hub-mirror.corp.example.com:5000/"
          ],
          "Name": "docker.io",
          "Official": true,
          "Secure": true
        },
        "registry.internal.corp.example.com:3000": {
          "Mirrors": [],
          "Name": "registry.internal.corp.example.com:3000",
          "Official": false,
          "Secure": false
        }
      },
      "type": "object"
    },
    "InsecureRegistryCIDRs": {
      "description": "List of IP ranges of insecure registries, using the CIDR syntax\n([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries\naccept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates\nfrom unknown CAs) communication.\n\nBy default, local registries (`::1/128` and `127.0.0.0/8`) are configured as\ninsecure. All other registries are secure. Communicating with an\ninsecure registry is not possible if the daemon assumes that registry\nis secure.\n\nThis configuration override this behavior, insecure communication with\nregistries whose resolved IP address is within the subnet described by\nthe CIDR syntax.\n\nRegistries can also be marked insecure by hostname. Those registries\nare listed under `IndexConfigs` and have their `Secure` field set to\n`false`.\n\n\u003e **Warning**: Using this option can be useful when running a local\n\u003e registry, but introduces security vulnerabilities. This option\n\u003e should therefore ONLY be used for testing purposes. For increased\n\u003e security, users should add their CA to their system's list of trusted\n\u003e CAs instead of enabling this option.\n",
      "example": [
        "::1/128",
        "127.0.0.0/8"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Mirrors": {
      "description": "List of registry URLs that act as a mirror for the official\n(`docker.io`) registry.\n",
      "example": [
        "https://hub-mirror.corp.example.com:5000/",
        "https://[2001:db8:a0b:12f0::1]/"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  "x-nullable": true
}