community
/
docker-distribution
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: note restriction on URL format of mirrors 

Signed-off-by: David Karlsson <david.karlsson@docker.com>
This commit is contained in:
David Karlsson 2023-05-31 20:20:52 +02:00
parent ba46c769b3
commit 9d1f71c801
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/recipes/mirror.md
View File

@ -31,6 +31,18 @@ relying entirely on your local registry is the simplest scenario.
It's currently not possible to mirror another private registry. Only the central
Hub can be mirrored.
The URL of a pull-through registry mirror must be the root of a domain.
No path components other than an optional trailing slash (`/`) are allowed.
The following table shows examples of allowed and disallowed mirror URLs.
| URL | Allowed |
| -------------------------------------- | ------- |
| `https://mirror.company.example` | Yes |
| `https://mirror.company.example/` | Yes |
| `https://mirror.company.example/foo` | No |
| `https://mirror.company.example#bar` | No |
| `https://mirror.company.example?baz=1` | No |
> **Note**
>
> Mirrors of Docker Hub are still subject to Docker's [fair usage policy](https://www.docker.com/pricing/resource-consumption-updates){: target="blank" rel="noopener" class=“”}.
@ -110,10 +122,14 @@ and add the `registry-mirrors` key and value, to make the change persistent.
```json
{
"registry-mirrors": ["https://<my-docker-mirror-host>"]
"registry-mirrors": ["https://mirror.company.example"]
}
```
> **Note**
>
> The mirror URL must be the root of the domain.
Save the file and reload Docker for the change to take effect.
> Some log messages that appear to be errors are actually informational messages.