fcrozat/distribution
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update some URLs and remove some of the Docker branding

Browse Source 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2022-01-19 10:31:42 +01:00
parent ae24899119
commit 3b83bce74d
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
6 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuration.md
View File

@ -1238,7 +1238,7 @@ Use the `manifests` subsection to configure validation of manifests. If
#### `urls` #### `urls`
The `allow` and `deny` options are each a list of The `allow` and `deny` options are each a list of
[regular expressions](https://godoc.org/regexp/syntax) that restrict the URLs in [regular expressions](https://pkg.go.dev/regexp/syntax) that restrict the URLs in
pushed manifests. pushed manifests.
If `allow` is unset, pushing a manifest containing URLs fails. If `allow` is unset, pushing a manifest containing URLs fails.

8
docs/notifications.md
View File

@ -75,9 +75,9 @@ repository | string | Repository identifies the named repository.
fromRepository | string | FromRepository identifies the named repository which a blob was mounted from if appropriate. fromRepository | string | FromRepository identifies the named repository which a blob was mounted from if appropriate.
url | string | URL provides a direct link to the content. url | string | URL provides a direct link to the content.
tag | string | Tag identifies a tag name in tag events. tag | string | Tag identifies a tag name in tag events.
request | [RequestRecord](https://godoc.org/github.com/docker/distribution/notifications#RequestRecord) | Request covers the request that generated the event. request | [RequestRecord](https://pkg.go.dev/github.com/distribution/distribution/notifications#RequestRecord) | Request covers the request that generated the event.
actor | [ActorRecord](https://godoc.org/github.com/docker/distribution/notifications#ActorRecord). | Actor specifies the agent that initiated the event. For most situations, this could be from the authorization context of the request. actor | [ActorRecord](https://pkg.go.dev/github.com/distribution/distribution/notifications#ActorRecord). | Actor specifies the agent that initiated the event. For most situations, this could be from the authorization context of the request.
source | [SourceRecord](https://godoc.org/github.com/docker/distribution/notifications#SourceRecord) | Source identifies the registry node that generated the event. Put differently, while the actor "initiates" the event, the source "generates" it. source | [SourceRecord](https://pkg.go.dev/github.com/distribution/distribution/notifications#SourceRecord) | Source identifies the registry node that generated the event. Put differently, while the actor "initiates" the event, the source "generates" it.
@ -344,5 +344,5 @@ which can be wired up to achieve interesting behavior. If this system doesn't
provide acceptable guarantees, adding a transactional `Sink` to the registry provide acceptable guarantees, adding a transactional `Sink` to the registry
is a possibility, although it may have an effect on request service time. is a possibility, although it may have an effect on request service time.
See the See the
[godoc](https://godoc.org/github.com/docker/distribution/notifications#Sink) [godoc](https://pkg.go.dev/github.com/distribution/distribution/notifications#Sink)
for more information. for more information.

8
docs/recipes/nginx.md
View File

@ -40,9 +40,9 @@ 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**: It is not recommended to bind your registry to `localhost:5000` without
> authentication. This creates a potential loophole in your Docker Registry security. > authentication. This creates a potential loophole in your registry security.
> As a result, anyone who can log on to the server where your Docker Registry is running > As a result, anyone who can log on to the server where your registry is running
> can push images without authentication. > 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
@ -70,7 +70,7 @@ proxy_set_header X-Forwarded-Proto $scheme;
Otherwise Nginx resets the ELB's values, and the requests are not routed Otherwise Nginx resets the ELB's values, and the requests are not routed
properly. For more information, see properly. For more information, see
[#970](https://github.com/docker/distribution/issues/970). [#970](https://github.com/distribution/distribution/issues/970).
## Setting things up ## Setting things up

18
docs/recipes/osx-setup-guide.md
View File

@ -33,11 +33,11 @@ If you don't, the TLDR is:
If you want to understand, you should read [How to Write Go Code](https://golang.org/doc/code.html). If you want to understand, you should read [How to Write Go Code](https://golang.org/doc/code.html).
## Checkout the Docker Distribution source tree ## Checkout the source tree
mkdir -p $GOPATH/src/github.com/docker mkdir -p $GOPATH/src/github.com/distribution
git clone https://github.com/docker/distribution.git $GOPATH/src/github.com/docker/distribution git clone https://github.com/distribution/distribution.git $GOPATH/src/github.com/distribution/distribution
cd $GOPATH/src/github.com/docker/distribution cd $GOPATH/src/github.com/distribution/distribution
## Build the binary ## Build the binary
@ -52,23 +52,23 @@ Copy the registry configuration file in place:
mkdir /Users/Shared/Registry mkdir /Users/Shared/Registry
cp docs/osx/config.yml /Users/Shared/Registry/config.yml cp docs/osx/config.yml /Users/Shared/Registry/config.yml
## Run the Docker Registry under launchd ## Run the registry under launchd
Copy the Docker registry plist into place: Copy the registry plist into place:
plutil -lint docs/recipes/osx/com.docker.registry.plist plutil -lint docs/recipes/osx/com.docker.registry.plist
cp docs/recipes/osx/com.docker.registry.plist ~/Library/LaunchAgents/ cp docs/recipes/osx/com.docker.registry.plist ~/Library/LaunchAgents/
chmod 644 ~/Library/LaunchAgents/com.docker.registry.plist chmod 644 ~/Library/LaunchAgents/com.docker.registry.plist
Start the Docker registry: Start the registry:
launchctl load ~/Library/LaunchAgents/com.docker.registry.plist launchctl load ~/Library/LaunchAgents/com.docker.registry.plist
### Restart the docker registry service ### Restart the registry service
launchctl stop com.docker.registry launchctl stop com.docker.registry
launchctl start com.docker.registry launchctl start com.docker.registry
### Unload the docker registry service ### Unload the registry service
launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist

2
docs/spec/auth/scope.md
View File

@ -100,7 +100,7 @@ alpha-numeric := /[a-z0-9]+/
separator := /[_.]|__|[-]*/ separator := /[_.]|__|[-]*/
``` ```
Full reference grammar is defined Full reference grammar is defined
[here](https://godoc.org/github.com/distribution/distribution/reference). Currently [here](https://pkg.go.dev/github.com/distribution/distribution/reference). Currently
the scope name grammar is a subset of the reference grammar. the scope name grammar is a subset of the reference grammar.
> **NOTE:** that the `resourcename` may contain one `:` due to a possible port > **NOTE:** that the `resourcename` may contain one `:` due to a possible port

2
docs/storage-drivers/index.md
View File

@ -3,7 +3,7 @@ description: Explains how to use storage drivers
keywords: registry, on-prem, images, tags, repository, distribution, storage drivers, advanced keywords: registry, on-prem, images, tags, repository, distribution, storage drivers, advanced
redirect_from: redirect_from:
- /registry/storagedrivers/ - /registry/storagedrivers/
title: Docker Registry storage driver title: Registry storage driver
--- ---
This document describes the registry storage driver model, implementation, and explains how to contribute new storage drivers. This document describes the registry storage driver model, implementation, and explains how to contribute new storage drivers.