Commit graph

1842 commits

Author SHA1 Message Date
iasoon
8628eab487 fix json syntax error in error api spec
Signed-off-by: Ilion Beyst <ilion.beyst@gmail.com>
2022-06-12 12:29:45 +02:00
Milos Gajdos
5fe693474e
Merge pull request #2291 from lucab/ups/spec-fixes
docs/spec: provide valid manifest examples
2022-04-22 18:01:03 +01:00
Wang Yan
9332c3cc7b
Merge pull request #3498 from hasheddan/md-links-oauth
(docs) Fix rendering of markdown links in OAuth docs HTML
2022-04-23 00:33:20 +08:00
duanhongyi
15de9e21ba Add forcepathstyle parameter for s3
Signed-off-by: duanhongyi <duanhongyi@doopai.com>
2022-04-20 08:44:12 +08:00
Radon Rosborough
d64056afdc Explain important caveat in htpasswd tutorial
Signed-off-by: Radon Rosborough <radon.neon@gmail.com>
2022-04-15 20:02:57 -07:00
Simone Locci
80952c9e2b
Rename s3accelerate parameter to accelerate
Signed-off-by: Simone Locci <simonelocci88@gmail.com>
2022-04-04 19:35:21 +02:00
Kirat Singh
51c0c8148a
Add new parameter s3accelerate to S3 storage driver.
If s3accelerate is set to true then we turn on S3 Transfer
Acceleration via the AWS SDK.  It defaults to false since this is an
opt-in feature on the S3 bucket.

Signed-off-by: Kirat Singh <kirat.singh@wsq.io>
Signed-off-by: Simone Locci <simonelocci88@gmail.com>
2022-04-04 19:34:57 +02:00
Sebastiaan van Stijn
3b83bce74d
docs: update some URLs and remove some of the Docker branding
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-01-19 10:39:26 +01:00
Sebastiaan van Stijn
ae24899119
Remove code related to building docs with Hugo
This code was outdated and no longer maintained, and mainly
used to pre-flight docs changes before publishing to docs.docker.com

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-01-19 10:39:24 +01:00
Sebastiaan van Stijn
ff0c463f2b
Remove docs.docker.com "include" directives
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-01-19 10:39:17 +01:00
Sebastiaan van Stijn
ef8966aacd Merge remote-tracking branch 'distribution_docs/migrate_distribution_docs' into restore_docs3
Restore the documentation that was moved to https://github.com/docker/docker.github.io

 Conflicts:
	docs/compatibility.md
	docs/deploying.md
	docs/deprecated.md
	docs/garbage-collection.md
	docs/glossary.md
	docs/help.md
	docs/images/notifications.png
	docs/index.md
	docs/insecure.md
	docs/introduction.md
	docs/migration.md
	docs/notifications.md
	docs/recipes/apache.md
	docs/recipes/index.md
	docs/recipes/mirror.md
	docs/recipes/nginx.md
	docs/recipes/osx-setup-guide.md
	docs/recipes/osx/config.yml
	docs/storage-drivers/azure.md
	docs/storage-drivers/filesystem.md
	docs/storage-drivers/gcs.md
	docs/storage-drivers/index.md
	docs/storage-drivers/inmemory.md
	docs/storage-drivers/oss.md
	docs/storage-drivers/s3.md
	docs/storage-drivers/swift.md
2022-01-14 15:02:27 +01:00
Sebastiaan van Stijn
342aff714c
Revert "Remove old documentation source, add README on migration"
This reverts commit da8bcbb302.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-01-14 13:06:13 +01:00
Usha Mandya
846be37893 Update note on Docker official images
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-01-12 23:08:26 +05:30
Adam Kaplan
e2caaf9cba Add dualstack option to S3 storage driver
Allow the storage driver to optionally use AWS SDK's dualstack mode.
This allows the registry to communicate with S3 in IPv6 environments.

Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
2022-01-04 17:19:05 -05:00
Ben Emamian
f2f9b29658 Update insecure.md 2021-11-01 12:53:08 +11:00
Peter Dave Hello
f6a54b0d29 Update most links to use https by default
Reference:

- #11640
- 430bf25958

Signed-off-by: Peter Dave Hello <hsu@peterdavehello.org>
2021-10-12 15:45:57 +08:00
hasheddan
dea56fae96
(docs) Fix rendering of markdown links in OAuth docs HTML
Fixes link rendering in HTML portion of the OAuth docs by converting
them to anchor tags.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2021-09-14 08:52:19 -04:00
Sebastiaan van Stijn
7b77a24bb2 Revert "Remove info on service accounts"
This reverts commit 715959c171.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-02 23:00:07 +02:00
Usha Mandya
715959c171 Remove info on service accounts
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-09-02 11:58:42 +01:00
Justin Cormack
1660df4b60
Change should to must in v2 spec
We found some examples of manifests with URLs specififed that did
not provide a digest or size. This breaks the security model by allowing
the content to change, as it no longer provides a Merkle tree. This
was not intended, so explicitly disallow by tightening wording.

Signed-off-by: Justin Cormack <justin.cormack@docker.com>
2021-08-20 12:14:42 +01:00
Sebastiaan van Stijn
072bad48b1 Add missing code-hints, and minor markdown edits
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
  put in separate blocks. With the "console" code-hint, this
  is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
  numbered-list to be interrupted.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-16 12:59:23 +02:00
Sebastiaan van Stijn
9b971331af Desktop: move "docker-for-windows" to "desktop/windows"
Unifying all content related to Docker Desktop to be withing the desktop
directory.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-14 13:28:15 +02:00
Sebastiaan van Stijn
31c9a9d737 Desktop: move "docker-for-mac" to "desktop/mac"
Unifying all content related to Docker Desktop to be withing the desktop
directory.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-14 13:07:41 +02:00
Daniel Helfand
576f4fc074 fix broken link for setting up local registry with auth 2021-08-12 11:56:31 -05:00
Sebastiaan van Stijn
ee8c75cbd1 registry: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:19:57 +02:00
Brandon Mitchell
9c7967a32d Update PUT and PATCH APIs
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2021-06-29 14:16:33 -04:00
Brandon Mitchell
3f09e31ea6 Fixing http status for PUT/PATCH APIs
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2021-06-28 15:23:04 -04:00
Wang Yan
263da70ea6
Merge pull request #3410 from khaosdoctor/patch-1
Fix html not rendering markdown link properly
2021-06-27 17:44:10 +08:00
Usha Mandya
85730e9d66 Merge pull request #12937 from matthewbalvanz-wf/patch-1
Indent webhook notifications Authorization header
2021-06-25 11:37:43 +01:00
Usha Mandya
4ff7f21b2d Update pull limits for service accounts
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-06-25 09:38:16 +01:00
João Pereira
6d75bd043a
Merge pull request #3425 from lostsquirrel/patch-1
Fix the /v2/_catalog n parameter description
2021-06-17 11:10:14 +01:00
lostsquirrel
6d9a3aba04 fix the /v2/_catalog n parameter description
If `n` is not present only 100 entries returned

Signed-off-by: lisong <lisong@cdsunrise.net>
2021-06-17 17:33:55 +08:00
João Pereira
5641309112
Update API spec
Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>
2021-06-15 15:24:32 +01:00
jerae-duffin
3d71710133 Updated service account links (#12953)
updated service account links
2021-06-04 18:45:50 +01:00
Ben De St Paer-Gotch
1777a5ba63 Updating registry help (#12948)
* Update help.md

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-06-03 12:07:21 +01:00
Matthew Balvanz
1fa75f3129 Indent webhook notifications Authorization header
Since `Authorization` is intended to be a header applied to HTTP requests it should be indented to place it in the YAML map named `headers` instead of being a sibling of it.
2021-06-02 08:45:45 -05:00
João Pereira
1398d3b5c6
Remove unrelated spec update
Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>
2021-05-28 10:12:01 +01:00
João Pereira
6ae6df7d75
Add tag delete API
Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>
2021-05-27 23:27:02 +01:00
João Pereira
d80a63f1ea
Merge pull request #3143 from eyJhb/pagination
OCI: Add pagination on `/v2/<name>/tags/list`
2021-05-22 15:05:18 +01:00
Robert Kaussow
09334b5e3b
fix typo
Signed-off-by: Robert Kaussow <mail@geeklabor.de>
2021-05-08 22:43:35 +02:00
Robert Kaussow
8e8d509958
add documentation how to access pull-through proxy stats
Signed-off-by: Robert Kaussow <mail@geeklabor.de>
2021-05-08 13:04:16 +02:00
Lucas Santos
fefc0e2b24
Fix html not rendering markdown link properly
Signed-off-by: Lucas Santos <lhs.santoss@gmail.com>
2021-05-04 13:04:56 -03:00
Usha Mandya
fe4fad3bff Merge pull request #12266 from novakivanovski/patch-1
Self-signed certificate with Kubernetes fix
2021-04-27 10:36:41 +01:00
eyjhb
9cf39997af
added pagination error to api docs
Signed-off-by: eyjhb <eyjhbb@gmail.com>
2021-04-23 18:06:04 +02:00
João Pereira
a27b0c4952
Merge pull request #3161 from bloodorangeio/redis-tls
Add configuration option for Redis TLS
2021-04-23 16:52:54 +01:00
Usha Mandya
b70327a8ec Merge pull request #12702 from stefanloerwald/patch-2
Fixes docker/distribution-library-image/issues/107
2021-04-23 11:00:08 +01:00
Ben De St Paer-Gotch
a49afdbd98 Adding in points to clarify usage of official images (#12713)
* Adding in points to clarify usage of official images

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-04-20 11:39:12 +01:00
Stefan Lörwald
0a7648edb5 Fixes docker/distribution-library-image/issues/107
The registry docker image no longer contains htpasswd.
2021-04-19 12:05:01 +02:00
Simon
b2ac3a2884 TASK: Add codeblocks to code examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-04 12:06:54 +01:00
Wang Yan
89337b7a25
Merge pull request #3371 from AkihiroSuda/remove-wrong-arm
docs/spec/manifest-v2-2.md: fix ARM variant
2021-03-04 10:57:22 +08:00
Josh Dolitsky
32ccbf193d
Add configuration option for Redis TLS
Signed-off-by: Josh Dolitsky <josh@dolit.ski>
2021-03-01 18:55:56 -05:00
David Luu
1e625d0076 Added flag for user configurable cipher suites
Configuration of list of cipher suites allows a user to disable use
of weak ciphers or continue to support them for legacy usage if they
so choose.

List of available cipher suites at:
https://golang.org/pkg/crypto/tls/#pkg-constants

Default cipher suites have been updated to:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305
- TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_AES_128_GCM_SHA256
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_256_GCM_SHA384

MinimumTLS has also been updated to include TLS 1.3 as an option
and now defaults to TLS 1.2 since 1.0 and 1.1 have been deprecated.

Signed-off-by: David Luu <david@davidluu.info>
2021-02-25 14:19:56 -06:00
Akihiro Suda
c432849e44
docs/spec/manifest-v2-2.md: fix ARM variant
The correct `vairant` string for ARM v6 is "v6", not "armv6l".

There is no known implementation that actually uses "armv6l".

See the discussion in opencontainers/image-spec PR 817

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2021-02-25 17:51:26 +09:00
Sebastiaan van Stijn
1d33874951
go.mod: change imports to github.com/distribution/distribution/v3
Go 1.13 and up enforce import paths to be versioned if a project
contains a go.mod and has released v2 or up.

The current v2.x branches (and releases) do not yet have a go.mod,
and therefore are still allowed to be imported with a non-versioned
import path (go modules add a `+incompatible` annotation in that case).

However, now that this project has a `go.mod` file, incompatible
import paths will not be accepted by go modules, and attempting
to use code from this repository will fail.

This patch uses `v3` for the import-paths (not `v2`), because changing
import paths itself is a breaking change, which means that  the
next release should increment the "major" version to comply with
SemVer (as go modules dictate).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-02-08 18:30:46 +01:00
Novak Ivanovski
e7dc768ae5 Self-signed certificate with Kubernetes fix
In Go 1.15 there is common name deprecation for using Common name:
https://golang.google.cn/doc/go1.15#commonname

This causes the self-signed cert to be rejected by some Kubernetes platforms:
https://stackoverflow.com/questions/64814173/how-do-i-use-sans-with-openssl-instead-of-common-name

Fix is to add this field to the cert.
2021-02-05 23:58:09 -05:00
Patrick Easters
639de6a02f Fix typo for digest regexp
Signed-off-by: Patrick Easters <peasters@redhat.com>
2021-02-05 14:52:27 -05:00
Usha Mandya
977c98e06f Fix broken links
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-28 10:07:41 +00:00
t-eimizu
78242c79ea Update insecure.md for Docker Desktop (#11964)
* Update insecure.md for Docker Desktop

Docker Desktop does not have "preferences" menu today.
It's changed to "Settings" > "Docker Engine" .

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-01-06 13:41:47 +01:00
Sebastiaan van Stijn
430bf25958 update http://dockr.ly links to use TLS
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-27 12:38:17 +01:00
Sebastiaan van Stijn
82f04d0335 Remove references to obsolete engine versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-26 15:45:07 +01:00
Usha Mandya
2059160c94 Remove Docker Toolbox docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2020-10-20 18:05:36 +01:00
Sebastiaan van Stijn
e02cd8124d Use https:// for links and examples
Found these using `http://[^lp10\*`<][^o]` (to exclude "localhost" and IP-addresses)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:09:11 +02:00
Sebastiaan van Stijn
3ec5e7e073 Add rel="noopener" to external links
See https://web.dev/external-anchors-use-rel-noopener/

Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-12 13:09:30 +02:00
Dan Fredell
eaeb31604e Add azure config container example (#11152)
* Add azure config container example

I was getting errors on setting up azure, this was because I was putting the full https url into the container field. There error wasn't helpful and nor was the docs.

* Update azure.md

Reword the registry azure container example.
2020-07-22 13:38:20 +01:00
Sebastiaan van Stijn
7728c5e445
docs: add redirect for old URL
Looks like there's some projects refering to this old URL:
https://grep.app/search?q=https%3A//docs.docker.com/reference/api/registry_api/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-07-08 12:18:31 +02:00
Usha Mandya
dc7801c55b Add note on Docker Hub 2020-07-03 15:25:54 +01:00
Sebastiaan van Stijn
989101c8c8 Remove some references to enterprise products
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-07-02 23:36:48 +02:00
Giovanni Toraldo
40f4476dab Remove not really implemented s3accelerate option (#10993)
ref https://github.com/docker/distribution/pull/2166
2020-06-12 14:56:12 +01:00
Sebastiaan van Stijn
b338d2f6ac Get Docker: fix broken links and wrap markdown to 80 char (#10691)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-24 12:20:18 +01:00
Sebastiaan van Stijn
aee0eeb354 registry: use relative markdown links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:43 +02:00
Sebastiaan van Stijn
267e231de0 Fix various links that were generating URLs with .md (#10548)
* Fix incorrect links in compose section

there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* engine/swarm: update links

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Fix various broken links

There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-01 12:05:50 +01:00
Usha Mandya
cb2a09fac2 Update tables from html to markdown format (#10360) 2020-02-27 10:34:24 +00:00
Eugene Lubarsky
5e3911c2e6 update registry s3 storage driver docs to add skipverify flag 2020-02-24 21:53:08 +11:00
ollypom
fdb1abd387 Added Nginx Recipe Redirect 2020-01-10 12:39:40 +00:00
Tom Hayward
0f5e2753a6 Fix typo cloudfront updatefrenquency
Signed-off-by: Tom Hayward <thayward@infoblox.com>
2019-12-13 12:11:42 -08:00
Adrian Plata
b4694b0d2d Fixing broken table
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-11-26 17:38:40 -08:00
syntaxkim
f580993c80 fix typo
myregistrydomain.com/my-ubuntu -> myregistry.domain.com/my-ubuntu
2019-10-31 17:46:24 +09:00
Sebastiaan van Stijn
fdee6a2ecf Merge pull request #9270 from das7pad/patch-1
[sec] nginx/compose: Drop aforementioned loophole
2019-09-13 00:39:11 +02:00
Adrian Plata
07a50201c9 Adding deprecated schema instructions
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-09-03 11:44:28 -07:00
Dawn W Docker
d61670894a removing section for Chinese mirror 2019-08-27 14:54:22 -07:00
Jakob Ackermann
dfcc7bccca [sec] nginx/compose: Drop aforementioned loophole 2019-08-18 19:57:15 +02:00
Tariq Ibrahim
8f9c8094fb
replace rsc.io/letsencrypt in favour of golang.org/x/crypto
Signed-off-by: Tariq Ibrahim <tariq181290@gmail.com>
2019-06-04 12:04:18 -07:00
Maria Bermudez
414cebd40e Update link to DTR 2019-05-12 20:02:12 -07:00
Ryan Abrams
3226863cbc
Merge pull request #2849 from Shawnpku/master
support Alibaba Cloud CDN storage middleware
2019-04-16 18:43:06 -07:00
Shawn Chen
fd77cf43a6 change package name & format document
Signed-off-by: Shawn Chen <chen8132@gmail.com>
2019-03-18 11:35:46 +08:00
Vishesh Jindal
e1e72e9563
Fix cloudfront documentation formatting
Signed-off-by: Vishesh Jindal <vishesh92@gmail.com>
2019-03-02 08:58:52 +05:30
Ryan Abrams
c192a281f8
Merge pull request #2813 from lucab/ups/spec-json-binary
registry: fix binary JSON content-type
2019-03-01 14:26:54 -08:00
Maria Bermudez
3be1cdec0e Update help.md 2019-02-15 14:05:58 -08:00
Shawnpku
3aa2a282f7 support alicdn middleware
Signed-off-by: Shawnpku <chen8132@gmail.com>
2019-02-11 15:11:26 +08:00
Sebastiaan van Stijn
297ba124e6 Use consistent formatting for notes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-02-09 00:49:57 +01:00
Maria Bermudez
415f4f4837 Merge pull request #8057 from Mueslint/patch-2
Update deploying.md
2019-02-04 10:24:21 -08:00
L-Hudson
3aa9c1e8f8 Merge pull request #6912 from perlun/patch-1
nginx.md: Add note about potential security isues
2019-01-23 15:17:53 -05:00
Anne Henmi
43b914b687 Update nginx.md
Fixed security warning, changed to "anyone who can log on to the server where your Docker Registry is running"
2019-01-22 16:16:38 -07:00
Aleksejs Sinicins
b98fb58a09 Document registry s3 transfer acceleration option.
https://github.com/docker/distribution/pull/2166
2019-01-21 21:16:51 +02:00
Muesli
560471b555 Update deploying.md
FIX syntax for zsh / mac os x term
2019-01-21 16:56:33 +01:00
L-Hudson
582d8e62dc Revert "Fix error (small change, only 1 line)" 2019-01-17 13:52:54 -05:00
Cheng Zheng
0620562750 Fix error 2019-01-17 20:42:17 +08:00
Derek McGowan
b75069ef13
Merge pull request #2791 from AliyunContainerService/support-oss-byok
Support BYOK for OSS storage driver
2019-01-16 16:37:37 -08:00
paigehargrave
af3ab22278 Merge branch 'master' into name-change-for-Docker-Desktop 2019-01-14 11:14:48 -05:00
Luca Bruno
15b0204758
registry: fix binary JSON content-type
This fixes registry endpoints to return the proper `application/json`
content-type for JSON content, also updating spec examples for that.

As per IETF specification and IANA registry [0], the `application/json`
type is a binary media, so the content-type label does not need any
text-charset selector. Additionally, the media type definition
explicitly states that it has no required nor optional parameters,
which makes the current registry headers non-compliant.

[0]: https://www.iana.org/assignments/media-types/application/json

Signed-off-by: Luca Bruno <lucab@debian.org>
2019-01-14 09:04:42 +00:00