Skip to content
This repository was archived by the owner on Apr 7, 2025. It is now read-only.

Commit 0dce785

Browse files
jCOTINEAUtianonyosifkitdocker-library-botkozlovic
authored
Sync upstream Docker official image documentation (#16)
* Link to more Stack Exchange sites Also, link directly to their "What topics can I ask about here?" pages instead of to a search. * Run update.sh * Run update.sh * Run update.sh * [nats] Release v2.9.3 Details can be found [here](https://github.com/nats-io/nats-server/releases/tag/v2.9.3) Signed-off-by: Ivan Kozlovic <[email protected]> * Readme Typo when referring to pre-existing db folder (docker-library#2212) * Run update.sh * Run update.sh * Run update.sh * [nats-streaming] Release v0.25.2 Details can be found [here](https://github.com/nats-io/nats-streaming-server/releases/tag/v0.25.2) Signed-off-by: Ivan Kozlovic <[email protected]> * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Update the HAProxy Docs URL see https://www.mail-archive.com/[email protected]/msg42790.html * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Add Alpine locale information for Postgres 15 (docker-library#2220) * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Update community Slack link * Run update.sh * Update forwarded ports in example docker run commands (docker-library#2224) * Update ports in example docker run commands * Run update.sh * Tidy up port list * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * [varnish] add a few words about port variables * ubuntu: Update Git references to Launchpad Ubuntu base images rootfs tarballs are now fetched from Launchpad Git repository. The location https://partner-images.canonical.com/oci/ is no longer used. Update links in the documentation to refer to the https://git.launchpad.net/cloud-images/+oci/ubuntu-base Git repository URL instead. The Launchpad Git repository URL is also set in github-repo file. This shouldn't matter because the fact that an URL is a GitHub URL is used only to fetch badges from open-source CI/CD services, and in case the URL is not a GitHub URL, the HTTP request will just fail, and no badge will be included. * remove line in jetty docs about JDK9 and HTTP2 (docker-library#2230) Signed-off-by: Lachlan Roberts <[email protected]> * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * [nats] Release v2.9.8 Details can be found [here](https://github.com/nats-io/nats-server/releases/tag/v2.9.8) Signed-off-by: Waldemar Quevedo <[email protected]> * Run update.sh * Update the phpMyAdmin image docs Ref: docker-library/official-images#13594 * Run update.sh * Run update.sh * Run update.sh * Remove "neo4j" short tags special case > Now that we're only supporting 3 images, would it be possible to get the supported tags listed on https://hub.docker.com/_/neo4j?tab=description again? * Run update.sh * Run update.sh * Run update.sh * update emqx docs * Influxdb: rearrange readme (docker-library#2236) * Influxdb: Add quick start * influxdb: re-arrange upgrade instructions. Upgrading from version 1.x is no longer as important, and can be moved below the general use instructions for version 2.x * influxDB: formatting * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Update for Convertigo 8.1.0 documentation: use PouchDB and configure SSL (docker-library#2244) * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * update emqx tagline and what is emqx section * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Update "arbitrary --user" notes for postgres nss_wrapper is now available in alpine, too. * Improve Hashicorp Vault docker run example for server mode (docker-library#2246) * Improve Hashicorp Vault docker run example for server mode to actually be directly usable and fix backend to current wording of storage * Upgrade hashicorp vault readme by suggestions from mladlow making it explicit that docker run example is not meant for productional use Co-authored-by: Theo Diefenthal <[email protected]> * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Fix badges urls apply changes for badges/shields#8671 * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Add new env var docs for develop tag (docker-library#2255) * Add package install directions * change irc servers * fix formatting * Update server env docs ...and remove old dns module comment * Finish sentence * typo fix * Add new env var docs for develop * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Change from WEBrick to Puma Ever since docker-library/redmine#261 the default uses puma instead of WEBrick. Puma is considered production-ready whereas WEBrick was not recommended for production. * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh * Run update.sh Signed-off-by: Ivan Kozlovic <[email protected]> Signed-off-by: Lachlan Roberts <[email protected]> Signed-off-by: Waldemar Quevedo <[email protected]> Co-authored-by: Tianon Gravi <[email protected]> Co-authored-by: yosifkit <[email protected]> Co-authored-by: Docker Library Bot <[email protected]> Co-authored-by: Ivan Kozlovic <[email protected]> Co-authored-by: Alberto Roura <[email protected]> Co-authored-by: Tim Düsterhus <[email protected]> Co-authored-by: wglambert <[email protected]> Co-authored-by: udkyo <[email protected]> Co-authored-by: Guillaume Quintard <[email protected]> Co-authored-by: Tomáš Virtus <[email protected]> Co-authored-by: Lachlan <[email protected]> Co-authored-by: Waldemar Quevedo <[email protected]> Co-authored-by: William Desportes <[email protected]> Co-authored-by: Ivan Dyachkov <[email protected]> Co-authored-by: kalleguld <[email protected]> Co-authored-by: Albert Nicolas <[email protected]> Co-authored-by: Wolfgang Walther <[email protected]> Co-authored-by: Theo Diefenthal <[email protected]> Co-authored-by: Theo Diefenthal <[email protected]> Co-authored-by: Geo <[email protected]> Co-authored-by: Pete <[email protected]>
1 parent 20ea786 commit 0dce785

File tree

505 files changed

+11817
-7566
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

505 files changed

+11817
-7566
lines changed

.ci/check-pr-no-readme.sh

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ set -Eeuo pipefail
44
cd "$(dirname "$(readlink -f "$BASH_SOURCE")")/.."
55

66
git fetch -q https://github.com/docker-library/docs.git master
7-
if [ -n "$(git diff --numstat FETCH_HEAD...HEAD -- '*/README.md')" ]; then
7+
numstat="$(git diff --numstat FETCH_HEAD...HEAD -- '*/README.md')"
8+
if [ -n "$numstat" ]; then
89
echo >&2 'Error: at least one repo README.md has changed'
910
echo >&2 'These files are autogenerated, so it is unnecessary to modify them'
1011
echo >&2 'Please update content.md and docker-library-bot will take care of README.md'
11-
echo >&2 'See: https://github.com/docker-library/docs/#image-namereadmemd'
12+
echo >&2 'See: https://github.com/docker-library/docs/#readmemd'
1213
echo >&2
1314
exit 1
1415
fi

.github/workflows/ci.yml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: GitHub CI
22

3+
permissions:
4+
contents: read
5+
36
on:
47
pull_request:
58
push:
@@ -16,28 +19,30 @@ jobs:
1619
markdownfmt:
1720
runs-on: ubuntu-latest
1821
steps:
19-
- uses: actions/checkout@v2
22+
- uses: actions/checkout@v3
2023
- run: docker pull tianon/markdownfmt
2124
- run: .ci/check-markdownfmt.sh
2225
ymlfmt:
2326
runs-on: ubuntu-latest
2427
steps:
25-
- uses: actions/checkout@v2
28+
- uses: actions/checkout@v3
2629
- run: docker pull tianon/ymlfmt
2730
- run: .ci/check-ymlfmt.sh
2831
short:
2932
runs-on: ubuntu-latest
3033
steps:
31-
- uses: actions/checkout@v2
34+
- uses: actions/checkout@v3
3235
- run: .ci/check-short.sh
3336
required-files:
3437
runs-on: ubuntu-latest
3538
steps:
36-
- uses: actions/checkout@v2
39+
- uses: actions/checkout@v3
3740
- run: .ci/check-required-files.sh
3841
no-readme:
3942
runs-on: ubuntu-latest
4043
steps:
41-
- uses: actions/checkout@v2
44+
- uses: actions/checkout@v3
45+
with:
46+
fetch-depth: 0
4247
- run: .ci/check-pr-no-readme.sh
4348
if: ${{ github.event_name == 'pull_request' }}

.template-helpers/generate-dockerfile-links-partial.tmpl

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,26 @@ This template defines the "Supported tags and Dockerfile links" portion of an im
2121
{{- $froms := $.ArchDockerFroms $arch $e -}}
2222

2323
{{- $gitRepo := $e.ArchGitRepo $arch -}}
24+
{{- $gitCommit := $e.ArchGitCommit $arch -}}
25+
{{- $dir := .ArchDirectory $arch -}}
26+
{{- $dockerfile := .ArchFile $arch -}}
27+
{{- $dockerfilePath := eq $dir "." | ternary $dockerfile (join "/" $dir $dockerfile) -}}
2428
{{- $repoUrlBase := $gitRepo | replace "git://" "https://" | trimSuffixes ".git" -}}
25-
{{- $isGitHub := hasPrefix "https://github.com/" $repoUrlBase -}}
29+
{{- $url := hasPrefix "https://github.com/" $repoUrlBase | ternary (join "/" $repoUrlBase "blob" $gitCommit $dockerfilePath) "" -}}
30+
{{- /* handle https://gitlab.../.../... style URLs (by reasonably assuming they're a gitlab instance) */ -}}
31+
{{- $url = $url | ternary $url (hasPrefix "https://gitlab." $repoUrlBase | ternary (join "/" $repoUrlBase "-/blob" $gitCommit $dockerfilePath) "") -}}
32+
{{- /* handle https://git.launchpad.net/ URLs */ -}}
33+
{{- $url = $url | ternary $url (hasPrefix "https://git.launchpad.net/" $repoUrlBase | ternary (print $repoUrlBase "/tree/" $dockerfilePath "?h=" ($e.ArchGitFetch $arch) "&id=" $gitCommit) "") -}}
34+
{{- /* TODO decide what to do (if anything) about other non-GitHub repos with respect to URL */ -}}
2635

2736
{{- if $i -}}
2837
{{- "\n" -}}
2938
{{- end -}}
3039

3140
- {{- "\t" -}}
32-
{{- if $isGitHub -}} [ {{- end -}}
33-
{{- $dir := .ArchDirectory $arch -}}
34-
{{- $dockerfile := .ArchFile $arch -}}
35-
{{- $dockerfilePath := eq $dir "." | ternary $dockerfile (join "/" $dir $dockerfile) -}}
41+
{{- if $url -}} [ {{- end -}}
3642
` {{- $e.Tags | join "`, `" -}} `
37-
{{- $gitCommit := $e.ArchGitCommit $arch -}}
38-
{{- if $isGitHub -}} ]( {{- $repoUrlBase -}} /blob/ {{- $gitCommit -}} / {{- $dockerfilePath -}} ) {{- end -}}
39-
{{- /* TODO decide what to do (if anything) about non-GitHub repos with respect to URL */ -}}
43+
{{- if $url -}} ]( {{- $url -}} ) {{- end -}}
4044
{{- end -}}
4145
{{- "\n\n" -}}
4246

@@ -58,18 +62,22 @@ This template defines the "Supported tags and Dockerfile links" portion of an im
5862
{{- $froms := $.ArchDockerFroms $arch $e -}}
5963

6064
{{- $gitRepo := $e.ArchGitRepo $arch -}}
61-
{{- $repoUrlBase := $gitRepo | replace "git://" "https://" | trimSuffixes ".git" -}}
62-
{{- $isGitHub := hasPrefix "https://github.com/" $repoUrlBase -}}
63-
64-
{{- "\t-\t" -}}
65-
{{- if $isGitHub -}} [ {{- end -}}
65+
{{- $gitCommit := $e.ArchGitCommit $arch -}}
6666
{{- $dir := .ArchDirectory $arch -}}
6767
{{- $dockerfile := .ArchFile $arch -}}
6868
{{- $dockerfilePath := eq $dir "." | ternary $dockerfile (join "/" $dir $dockerfile) -}}
69+
{{- $repoUrlBase := $gitRepo | replace "git://" "https://" | trimSuffixes ".git" -}}
70+
{{- $url := hasPrefix "https://github.com/" $repoUrlBase | ternary (join "/" $repoUrlBase "blob" $gitCommit $dockerfilePath) "" -}}
71+
{{- /* handle https://gitlab.../.../... style URLs (by reasonably assuming they're a gitlab instance) */ -}}
72+
{{- $url = $url | ternary $url (hasPrefix "https://gitlab." $repoUrlBase | ternary (join "/" $repoUrlBase "-/blob" $gitCommit $dockerfilePath) "") -}}
73+
{{- /* handle https://git.launchpad.net/ URLs */ -}}
74+
{{- $url = $url | ternary $url (hasPrefix "https://git.launchpad.net/" $repoUrlBase | ternary (print $repoUrlBase "/tree/" $dockerfilePath "?h=" ($e.ArchGitFetch $arch) "&id=" $gitCommit) "") -}}
75+
{{- /* TODO decide what to do (if anything) about other non-GitHub repos with respect to URL */ -}}
76+
77+
{{- "\t-\t" -}}
78+
{{- if $url -}} [ {{- end -}}
6979
` {{- $e.Tags | first -}} `
70-
{{- $gitCommit := $e.ArchGitCommit $arch -}}
71-
{{- if $isGitHub -}} ]( {{- $repoUrlBase -}} /blob/ {{- $gitCommit -}} / {{- $dockerfilePath -}} ) {{- end -}}
72-
{{- /* TODO decide what to do (if anything) about non-GitHub repos with respect to URL */ -}}
80+
{{- if $url -}} ]( {{- $url -}} ) {{- end -}}
7381

7482
{{- "\n" -}}
7583
{{- end -}}

.template-helpers/get-help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](http://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
1+
[the Docker Community Slack](https://dockr.ly/comm-slack), [Server Fault](https://serverfault.com/help/on-topic), [Unix & Linux](https://unix.stackexchange.com/help/on-topic), or [Stack Overflow](https://stackoverflow.com/help/on-topic)

.template-helpers/template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
(image metadata, transfer size, etc)
2424

2525
- **Image updates**:
26-
[official-images PRs with label `library/%%REPO%%`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2F%%REPO%%)
26+
[official-images repo's `library/%%REPO%%` label](https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2F%%REPO%%)
2727
[official-images repo's `library/%%REPO%%` file](https://github.com/docker-library/official-images/blob/master/library/%%REPO%%) ([history](https://github.com/docker-library/official-images/commits/master/library/%%REPO%%))
2828

2929
- **Source of this description**:

.template-helpers/variant-alpine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## `%%IMAGE%%:<version>-alpine`
22

3-
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
3+
This image is based on the popular [Alpine Linux project](https://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
44

5-
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
5+
This variant is useful when final image size being as small as possible is your primary concern. The main caveat to note is that it does use [musl libc](https://musl.libc.org) instead of [glibc and friends](https://www.etalabs.net/compare_libcs.html), so software will often run into issues depending on the depth of their libc requirements/assumptions. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
66

77
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).

.template-helpers/variant.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ if [ -n "$text" ]; then
102102
default+=$'\n' # parameter expansion eats the trailing newline
103103

104104
if [ "$repo" != 'debian' ] && [ "$repo" != 'ubuntu' ]; then
105-
# what is 'jessie', 'stretch' and 'sid'
105+
# what is 'bullseye', 'buster' and 'sid'
106106
# https://github.com/docker-library/python/issues/343
107107
debian=( $(bashbrew list --uniq "$(_repo 'debian')" | grep -vE 'stable|slim|backports|experimental|testing' | cut -d: -f2) )
108108
ubuntu=( $(bashbrew list "$(_repo 'ubuntu')" | grep -vE 'devel|latest|[0-9]' | cut -d: -f2) )

0 commit comments

Comments
 (0)