mirror of https://github.com/docker/docs.git
hub and registry: fix formatting (#17988)
* fix formatting hub and registry Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
This commit is contained in:
parent
b45087c12c
commit
18a0fc487f
|
|
@ -42,6 +42,7 @@ when the tests succeed.
|
||||||
4. Select the **source repository** to build the Docker images from.
|
4. Select the **source repository** to build the Docker images from.
|
||||||
|
|
||||||
> Note
|
> Note
|
||||||
|
>
|
||||||
> You might need to specify an organization or user from
|
> You might need to specify an organization or user from
|
||||||
> the source code provider. Once you select a user, source code
|
> the source code provider. Once you select a user, source code
|
||||||
> repositories appear in the **Select repository** drop-down list.
|
> repositories appear in the **Select repository** drop-down list.
|
||||||
|
|
|
||||||
|
|
@ -45,14 +45,15 @@ over the repository can change the repository logo.
|
||||||
1. Sign in to [Docker Hub](https://hub.docker.com).
|
1. Sign in to [Docker Hub](https://hub.docker.com).
|
||||||
2. Go to the page of the repository that you want to change the logo for.
|
2. Go to the page of the repository that you want to change the logo for.
|
||||||
3. Select the upload logo button, represented by a camera icon
|
3. Select the upload logo button, represented by a camera icon
|
||||||
({: .inline height="22px" })
|
({{< inline-image src="images/upload_logo_sm.png" alt="camera icon" >}})
|
||||||
overlaying the current repository logo.
|
overlaying the current repository logo.
|
||||||
4. In the dialog that opens, select the PNG image that you want to upload to
|
4. In the dialog that opens, select the PNG image that you want to upload to
|
||||||
set it as the logo for the repository.
|
set it as the logo for the repository.
|
||||||
|
|
||||||
#### Remove the logo
|
#### Remove the logo
|
||||||
|
|
||||||
Select the **Clear** button ({: .inline width="20px" }) to remove a logo.
|
Select the **Clear** button ({{< inline-image src="images/clear_logo_sm.png"
|
||||||
|
alt="clear button" >}}) to remove a logo.
|
||||||
|
|
||||||
Removing the logo makes the repository default to using the organization logo, if set, or the following default logo if not.
|
Removing the logo makes the repository default to using the organization logo, if set, or the following default logo if not.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -62,15 +62,16 @@ over the repository can change the repository logo.
|
||||||
|
|
||||||
1. Sign in to [Docker Hub](https://hub.docker.com).
|
1. Sign in to [Docker Hub](https://hub.docker.com).
|
||||||
2. Go to the page of the repository that you want to change the logo for.
|
2. Go to the page of the repository that you want to change the logo for.
|
||||||
3. Select the upload logo button, represented by a camera icon
|
3. Select the upload logo button, represented by a camera icon ({{< inline-image
|
||||||
({: .inline height="22px" })
|
src="./images/upload_logo_sm.png" alt="camera icon" >}}) overlaying the
|
||||||
overlaying the current repository logo.
|
current repository logo.
|
||||||
4. In the dialog that opens, select the PNG image that you want to upload to
|
4. In the dialog that opens, select the PNG image that you want to upload to
|
||||||
set it as the logo for the repository.
|
set it as the logo for the repository.
|
||||||
|
|
||||||
#### Remove the logo
|
#### Remove the logo
|
||||||
|
|
||||||
Select the **Clear** button ({: .inline width="20px" }) to remove a logo.
|
Select the **Clear** button ({{< inline-image src="images/clear_logo_sm.png"
|
||||||
|
alt="clear button" >}}) to remove a logo.
|
||||||
|
|
||||||
Removing the logo makes the repository default to using the organization logo, if set, or the following default logo if not.
|
Removing the logo makes the repository default to using the organization logo, if set, or the following default logo if not.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ You can use webhooks to cause an action in another service in response to a push
|
||||||
## Create a webhook
|
## Create a webhook
|
||||||
|
|
||||||
To create a webhook:
|
To create a webhook:
|
||||||
1. In your chosen respository, select the **Webhooks** tabThen:
|
1. In your chosen repository, select the **Webhooks** tab.
|
||||||
2. Provide a name for the webhook
|
2. Provide a name for the webhook
|
||||||
3. Provide a destination webhook URL. This is where webhook POST requests are delivered.
|
3. Provide a destination webhook URL. This is where webhook POST requests are delivered.
|
||||||
4. Select **Create**.
|
4. Select **Create**.
|
||||||
|
|
|
||||||
|
|
@ -398,7 +398,8 @@ The simplest way to achieve access restriction is through basic authentication
|
||||||
This example uses native basic authentication using `htpasswd` to store the
|
This example uses native basic authentication using `htpasswd` to store the
|
||||||
secrets.
|
secrets.
|
||||||
|
|
||||||
> **Warning**:
|
> **Warning**
|
||||||
|
>
|
||||||
> You **cannot** use authentication with authentication schemes that send
|
> You **cannot** use authentication with authentication schemes that send
|
||||||
> credentials as clear text. You must
|
> credentials as clear text. You must
|
||||||
> [configure TLS first](deploying.md#run-an-externally-accessible-registry) for
|
> [configure TLS first](deploying.md#run-an-externally-accessible-registry) for
|
||||||
|
|
@ -458,9 +459,11 @@ secrets.
|
||||||
Test that you can now pull an image from the registry or push an image to
|
Test that you can now pull an image from the registry or push an image to
|
||||||
the registry.
|
the registry.
|
||||||
|
|
||||||
> **X509 errors**: X509 errors usually indicate that you are attempting to use
|
> **X509 errors**
|
||||||
> a self-signed certificate without configuring the Docker daemon correctly.
|
>
|
||||||
> See [run an insecure registry](insecure.md).
|
> X509 errors usually indicate that you are attempting to use a self-signed
|
||||||
|
> certificate without configuring the Docker daemon correctly. See [run an
|
||||||
|
> insecure registry](insecure.md).
|
||||||
|
|
||||||
### More advanced authentication
|
### More advanced authentication
|
||||||
|
|
||||||
|
|
@ -503,7 +506,6 @@ registry:
|
||||||
|
|
||||||
Replace `/path` with the directory which contains the `certs/` and `auth/`
|
Replace `/path` with the directory which contains the `certs/` and `auth/`
|
||||||
directories.
|
directories.
|
||||||
{ .warning }
|
|
||||||
|
|
||||||
Start your registry by issuing the following command in the directory containing
|
Start your registry by issuing the following command in the directory containing
|
||||||
the `docker-compose.yml` file:
|
the `docker-compose.yml` file:
|
||||||
|
|
|
||||||
|
|
@ -82,9 +82,12 @@ the blobs and if a blob's content address digest is not in the mark set, the
|
||||||
process deletes it.
|
process deletes it.
|
||||||
|
|
||||||
|
|
||||||
> **Note**: You should ensure that the registry is in read-only mode or not running at
|
> **Note**
|
||||||
> all. If you were to upload an image while garbage collection is running, there is the
|
>
|
||||||
> risk that the image's layers are mistakenly deleted leading to a corrupted image.
|
> You should ensure that the registry is in read-only mode or not running at
|
||||||
|
> all. If you were to upload an image while garbage collection is running, there
|
||||||
|
> is the risk that the image's layers are mistakenly deleted leading to a
|
||||||
|
> corrupted image.
|
||||||
|
|
||||||
This type of garbage collection is known as stop-the-world garbage collection.
|
This type of garbage collection is known as stop-the-world garbage collection.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,8 @@ involves security trade-offs and additional configuration steps.
|
||||||
|
|
||||||
## Deploy a plain HTTP registry
|
## Deploy a plain HTTP registry
|
||||||
|
|
||||||
> **Warning**:
|
> **Warning**
|
||||||
|
>
|
||||||
> It's not possible to use an insecure registry with basic authentication.
|
> It's not possible to use an insecure registry with basic authentication.
|
||||||
{ .warning }
|
{ .warning }
|
||||||
|
|
||||||
|
|
@ -55,9 +56,11 @@ Repeat these steps on every Engine host that wants to access your registry.
|
||||||
|
|
||||||
## Use self-signed certificates
|
## Use self-signed certificates
|
||||||
|
|
||||||
> **Warning**:
|
> **Warning**
|
||||||
> Using this along with basic authentication requires to **also** trust the certificate into the OS cert store for some versions of docker (see below)
|
>
|
||||||
{ .warning }
|
> Using this along with basic authentication requires to **also** trust the
|
||||||
|
certificate into the OS cert store for some versions of docker (see below)
|
||||||
|
{.warning }
|
||||||
|
|
||||||
This is more secure than the insecure registry solution.
|
This is more secure than the insecure registry solution.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -96,14 +96,20 @@ proxy:
|
||||||
password: [password]
|
password: [password]
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Warning**: If you specify a username and password, it's very important to
|
> **Warning**
|
||||||
> understand that private resources that this user has access to Docker Hub is
|
>
|
||||||
> made available on your mirror. **You must secure your mirror** by
|
> If you specify a username and password, it's very important to understand that
|
||||||
> implementing authentication if you expect these resources to stay private!
|
> private resources that this user has access to Docker Hub is made available on
|
||||||
|
> your mirror. **You must secure your mirror** by implementing authentication if
|
||||||
|
> you expect these resources to stay private!
|
||||||
|
{ .warning }
|
||||||
|
|
||||||
> **Warning**: For the scheduler to clean up old entries, `delete` must
|
> **Warning**
|
||||||
> be enabled in the registry configuration. See
|
>
|
||||||
> [Registry Configuration](../configuration.md) for more details.
|
> For the scheduler to clean up old entries, `delete` must be enabled in the
|
||||||
|
> registry configuration. See [Registry Configuration](../configuration.md) for
|
||||||
|
> more details.
|
||||||
|
{ .warning }
|
||||||
|
|
||||||
### Configure the Docker daemon
|
### Configure the Docker daemon
|
||||||
|
|
||||||
|
|
@ -119,11 +125,14 @@ and add the `registry-mirrors` key and value, to make the change persistent.
|
||||||
|
|
||||||
Save the file and reload Docker for the change to take effect.
|
Save the file and reload Docker for the change to take effect.
|
||||||
|
|
||||||
> Some log messages that appear to be errors are actually informational messages.
|
> **Note**
|
||||||
>
|
>
|
||||||
> Check the `level` field to determine whether
|
> Some log messages that appear to be errors are actually informational
|
||||||
> the message is warning you about an error or is giving you information.
|
> messages.
|
||||||
> For example, this log message is informational:
|
>
|
||||||
|
> Check the `level` field to determine whether the message is warning you about
|
||||||
|
> an error or is giving you information. For example, this log message is
|
||||||
|
> informational:
|
||||||
>
|
>
|
||||||
> ```conf
|
> ```conf
|
||||||
> time="2017-06-02T15:47:37Z" level=info msg="error statting local store, serving from upstream: unknown blob" go.version=go1.7.4
|
> time="2017-06-02T15:47:37Z" level=info msg="error statting local store, serving from upstream: unknown blob" go.version=go1.7.4
|
||||||
|
|
|
||||||
|
|
@ -43,10 +43,12 @@ you want through the secondary authentication mechanism implemented inside your
|
||||||
proxy, it also requires that you move TLS termination from the Registry to the
|
proxy, it also requires that you move TLS termination from the Registry to the
|
||||||
proxy itself.
|
proxy itself.
|
||||||
|
|
||||||
> **Note**: Docker does not recommend binding your registry to `localhost:5000` without
|
> **Note**
|
||||||
> authentication. This creates a potential loophole in your Docker Registry security.
|
>
|
||||||
> As a result, anyone who can log on to the server where your Docker Registry is running
|
> Docker does not recommend binding your registry to `localhost:5000` without
|
||||||
> can push images without authentication.
|
> authentication. This creates a potential loophole in your Docker Registry
|
||||||
|
> security. As a result, anyone who can log on to the server where your Docker
|
||||||
|
> Registry is running can push images without authentication.
|
||||||
|
|
||||||
Furthermore, introducing an extra http layer in your communication pipeline
|
Furthermore, introducing an extra http layer in your communication pipeline
|
||||||
makes it more complex to deploy, maintain, and debug. Make sure the extra
|
makes it more complex to deploy, maintain, and debug. Make sure the extra
|
||||||
|
|
@ -159,7 +161,9 @@ Review the [requirements](index.md#requirements), then follow these steps.
|
||||||
$ docker run --rm --entrypoint htpasswd httpd:2 -Bbn testuser testpassword > auth/nginx.htpasswd
|
$ docker run --rm --entrypoint htpasswd httpd:2 -Bbn testuser testpassword > auth/nginx.htpasswd
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note**: If you do not want to use `bcrypt`, you can omit the `-B` parameter.
|
> **Note**
|
||||||
|
>
|
||||||
|
> If you do not want to use `bcrypt`, you can omit the `-B` parameter.
|
||||||
|
|
||||||
4. Copy your certificate files to the `auth/` directory.
|
4. Copy your certificate files to the `auth/` directory.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue