vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add some clarifying documentation for pull through cache configuration

Browse source 
Signed-off-by: Richard Scothern <richard.scothern@gmail.com>
This commit is contained in:
Richard Scothern 2015-08-26 11:02:05 -07:00
parent b78a858b5d
commit 246138598d
2 changed files with 59 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

57
docs/configuration.md
View file

@ -216,6 +216,10 @@ information about each option that appears later in this page.
timeout: 3s
interval: 10s
threshold: 3
proxy:
remoteurl: https://registry-1.docker.io
username: [username]
password: [password]
In some instances a configuration option is **optional** but it contains child
options marked as **required**. This indicates that you can omit the parent with
@ -1940,6 +1944,59 @@ The TCP address to connect to, including a port number.
</tr>
</table>
## Proxy
proxy:
remoteurl: https://registry-1.docker.io
username: [username]
password: [password]
Proxy enables a registry to be configured as a pull through cache to the official Docker Hub. See [mirror.md](mirror.md) for more information
<table>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>remoteurl</code>
</td>
<td>
yes
</td>
<td>
The URL of the official Docker Hub
</td>
</tr>
<tr>
<td>
<code>username</code>
</td>
<td>
no
</td>
<td>
The username of the Docker Hub account
</td>
</tr>
<tr>
<td>
<code>password</code>
</td>
<td>
no
</td>
<td>
The password for the official Docker Hub account
</td>
</tr>
</table>
To enable pulling private repositories (e.g. `batman/robin`) a username and password for user `batman` must be specified. Note: These private repositories will be stored in the proxy cache's storage and relevant measures should be taken to protect access to this.
## Example: Development configuration
The following is a simple example you can use for local development: