Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/docker-library/docs into …
Browse files Browse the repository at this point in the history
…patch-1
  • Loading branch information
Simran-B committed Sep 16, 2024
2 parents 97b42df + 114eeef commit 0047507
Show file tree
Hide file tree
Showing 378 changed files with 5,092 additions and 4,196 deletions.
9 changes: 9 additions & 0 deletions .ci/check-metadata.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/usr/bin/env bash
set -Eeuo pipefail

cd "$(dirname "$(readlink -f "$BASH_SOURCE")")/.."

# metadata.sh takes directories with a 'metadata.json' in them
# metadata.json is expected in every repo
# "." so that the canonical source metadata.json is checked too
./metadata.sh */ .
15 changes: 10 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,35 @@ jobs:
markdownfmt:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: docker pull tianon/markdownfmt
- run: .ci/check-markdownfmt.sh
ymlfmt:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: docker pull tianon/ymlfmt
- run: .ci/check-ymlfmt.sh
short:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: .ci/check-short.sh
required-files:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: .ci/check-required-files.sh
no-readme:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
- run: .ci/check-pr-no-readme.sh
if: ${{ github.event_name == 'pull_request' }}
metadata:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: .ci/check-metadata.sh
2 changes: 1 addition & 1 deletion .template-helpers/generate-dockerfile-links-partial.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ if [ -z "${BASHBREW_LIBRARY:-}" ]; then
repo="https://github.com/docker-library/official-images/raw/master/library/$repo"
fi

if [ -n "$ARCH_SPECIFIC_DOCS" ] && archTags="$(bashbrew cat --format '{{ range .Entries }}{{ if .HasArchitecture arch }}{{ .Tags | first }}{{ "\n" }}{{ end }}{{ end }}' "$repo")" && [ -z "$archTags" ]; then
if [ -n "$ARCH_SPECIFIC_DOCS" ] && archTags="$(bashbrew list --uniq --arch-filter "$repo")" && [ -z "$archTags" ]; then
echo "**WARNING:** THIS IMAGE *IS NOT SUPPORTED* ON THE \`$BASHBREW_ARCH\` ARCHITECTURE"
exit
fi
Expand Down
10 changes: 4 additions & 6 deletions .template-helpers/generate-dockerfile-links-partial.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,13 @@ This template defines the "Supported tags and Dockerfile links" portion of an im
{{- $url = $url | ternary $url (hasPrefix "https://git.launchpad.net/" $repoUrlBase | ternary (print $repoUrlBase "/tree/" $dockerfilePath "?h=" ($e.ArchGitFetch $arch) "&id=" $gitCommit) "") -}}
{{- /* TODO decide what to do (if anything) about other non-GitHub repos with respect to URL */ -}}

{{- if $i -}}
{{- "\n" -}}
{{- end -}}

- {{- "\t" -}}
{{- if $url -}} [ {{- end -}}
` {{- $e.Tags | join "`, `" -}} `
{{- if $url -}} ]( {{- $url -}} ) {{- end -}}

{{- "\n\n" -}}
{{- end -}}
{{- "\n\n" -}}

{{- if (len $sharedTagGroups) -}}
{{- "## Shared Tags\n\n" -}}
Expand All @@ -53,7 +50,7 @@ This template defines the "Supported tags and Dockerfile links" portion of an im
{{- if (len $entries) -}}
{{- "-\t`" -}}
{{ .SharedTags | join "`, `" }}
{{- "`:\n" -}}
{{- "`:\n\n" -}}

{{- range $i, $e := $entries -}}
{{- $arch := $archSpecific | ternary arch ($e.HasArchitecture arch | ternary arch ($e.Architectures | first)) -}}
Expand Down Expand Up @@ -81,6 +78,7 @@ This template defines the "Supported tags and Dockerfile links" portion of an im

{{- "\n" -}}
{{- end -}}
{{- "\n" -}}
{{- end -}}
{{- end -}}
{{- "\n" -}}
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM perl:5.30-buster
FROM perl:5.39-bookworm

RUN set -eux; \
apt-get update; \
Expand Down
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/
6. [`license.md`](#licensemd)
7. [`logo.png`](#logopng)
8. [`maintainer.md`](#maintainermd)
9. [`README-short.txt`](#readme-shorttxt)
10. [`stack.yml`](#stackyml)
9. [`metadata.json`](#metadatajson)
10. [`README-short.txt`](#readme-shorttxt)
11. [`stack.yml`](#stackyml)
5. [Files for main Docs repo](#files-for-main-docs-repo)
1. [`update.sh`](#updatesh)
2. [`markdownfmt.sh` and `ymlfmt.sh`](#markdownfmtsh-and-ymlfmtsh)
Expand All @@ -61,6 +62,7 @@ After opening your Pull Request the changes will be checked by an automated `mar
- Create a `license.md` (required)
- Create a `maintainer.md` (required)
- Create a `github-repo` (required)
- Create a `metadata.json` (required)
- Add a `logo.png` (recommended)

Optionally:
Expand Down Expand Up @@ -128,6 +130,18 @@ The image is automatically scaled to a 120 pixel square for the top of the Docke

This file should contain a link to the maintainers of the Dockerfile.

## `metadata.json`

This file contains data about the repo for Docker Hub. The minimum file is defined below. `./metadata.sh [repo-name]` must be used to correctly format it (use `-w` to apply its suggested format changes). Only three sorted unique Docker Hub categories are allowed. `metadata.json` in the root contains the list of categories to choose from. See descriptions for the categories on the [Docker docs site](https://docs.docker.com/docker-hub/repos/categories/).

```json
{
"hub": {
"categories": []
}
}
```

## `README-short.txt`

This is the short description for the Docker Hub, limited to 100 characters in a single line.
Expand Down
2 changes: 1 addition & 1 deletion adminer/README-short.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Database management in a single PHP file.
DEPRECATED; Database management in a single PHP file.
13 changes: 10 additions & 3 deletions adminer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ WARNING:
-->

# **DEPRECATION NOTICE**

Adminer is [no longer maintained (upstream)](https://www.youtube.com/watch?v=OrOtiu_nfHE&lc=Ugy8pAL8wgAL3_iKkzZ4AaABAg.9pj_kQ2rkuw9pp813OyHha):

> I've stopped working on it but maybe I'll return to it some day.
See also [TimWolla/docker-adminer#147](https://github.com/TimWolla/docker-adminer/issues/147). Users are strongly encouraged to seek alternatives.

# Quick reference

- **Maintained by**:
Expand All @@ -24,16 +32,15 @@ WARNING:

# Supported tags and respective `Dockerfile` links

- [`4.8.1-standalone`, `4-standalone`, `standalone`, `4.8.1`, `4`, `latest`](https://github.com/TimWolla/docker-adminer/blob/c9c54b18f79a66409a3153a94f629ea68f08647c/4/Dockerfile)
- [`4.8.1-fastcgi`, `4-fastcgi`, `fastcgi`](https://github.com/TimWolla/docker-adminer/blob/c9c54b18f79a66409a3153a94f629ea68f08647c/4/fastcgi/Dockerfile)
**No supported tags**

# Quick reference (cont.)

- **Where to file issues**:
[https://github.com/TimWolla/docker-adminer/issues](https://github.com/TimWolla/docker-adminer/issues?q=)

- **Supported architectures**: ([more info](https://github.com/docker-library/official-images#architectures-other-than-amd64))
[`amd64`](https://hub.docker.com/r/amd64/adminer/), [`arm32v5`](https://hub.docker.com/r/arm32v5/adminer/), [`arm32v7`](https://hub.docker.com/r/arm32v7/adminer/), [`arm64v8`](https://hub.docker.com/r/arm64v8/adminer/), [`i386`](https://hub.docker.com/r/i386/adminer/), [`mips64le`](https://hub.docker.com/r/mips64le/adminer/), [`ppc64le`](https://hub.docker.com/r/ppc64le/adminer/), [`s390x`](https://hub.docker.com/r/s390x/adminer/)
**No supported architectures**

- **Published image artifact details**:
[repo-info repo's `repos/adminer/` directory](https://github.com/docker-library/repo-info/blob/master/repos/adminer) ([history](https://github.com/docker-library/repo-info/commits/master/repos/adminer))
Expand Down
5 changes: 5 additions & 0 deletions adminer/deprecated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Adminer is [no longer maintained (upstream)](https://www.youtube.com/watch?v=OrOtiu_nfHE&lc=Ugy8pAL8wgAL3_iKkzZ4AaABAg.9pj_kQ2rkuw9pp813OyHha):

> I've stopped working on it but maybe I'll return to it some day.
See also [TimWolla/docker-adminer#147](https://github.com/TimWolla/docker-adminer/issues/147). Users are strongly encouraged to seek alternatives.
7 changes: 7 additions & 0 deletions adminer/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"hub": {
"categories": [
"databases-and-storage"
]
}
}
7 changes: 4 additions & 3 deletions aerospike/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ WARNING:

# Supported tags and respective `Dockerfile` links

- [`ee-7.1.0.0`, `ee-7.1.0.0_1`](https://github.com/aerospike/aerospike-server.docker/blob/af847cba3ce8e7d4f8207106d6bf5ae59e749473/enterprise/ubuntu22.04/Dockerfile)
- [`ce-7.1.0.0`, `ce-7.1.0.0_1`](https://github.com/aerospike/aerospike-server.docker/blob/af847cba3ce8e7d4f8207106d6bf5ae59e749473/community/ubuntu22.04/Dockerfile)
- [`ee-7.1.0.5`, `ee-7.1.0.5_1`](https://github.com/aerospike/aerospike-server.docker/blob/ea12c2c1fcc26f2f3aa270fba7af8b32a0ca0026/enterprise/ubuntu22.04/Dockerfile)

- [`ce-7.1.0.5`, `ce-7.1.0.5_1`](https://github.com/aerospike/aerospike-server.docker/blob/ea12c2c1fcc26f2f3aa270fba7af8b32a0ca0026/community/ubuntu22.04/Dockerfile)

# Quick reference (cont.)

Expand All @@ -52,7 +53,7 @@ WARNING:

[Aerospike](http://aerospike.com) is a distributed NoSQL database purposefully designed for high performance web scale applications. Aerospike supports key-value and document data models, and has multiple data types including List, Map, HyperLogLog, GeoJSON, and Blob. Aerospike's patented hybrid memory architecture delivers predictable high performance at scale and high data density per node.

![logo](https://raw.githubusercontent.com/docker-library/docs/9944063c59872460e15f6ecb19c1419c8124752f/aerospike/logo.png)
![logo](https://raw.githubusercontent.com/docker-library/docs/42ae663b4b922326e5c55c7c513c8d04a11f9aaf/aerospike/logo.png)

## Getting Started

Expand Down
Binary file modified aerospike/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions aerospike/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"hub": {
"categories": [
"databases-and-storage"
]
}
}
11 changes: 7 additions & 4 deletions almalinux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,13 @@ WARNING:

# Supported tags and respective `Dockerfile` links

- [`8`, `8.9`, `8.9-20240410`](https://github.com/AlmaLinux/container-images/blob/7aee1db985cc9ebb0347f2f4875f301fa4b09ab7/default/amd64/Dockerfile)
- [`8-minimal`, `8.9-minimal`, `8.9-minimal-20240410`](https://github.com/AlmaLinux/container-images/blob/265e51205d22917cbc7c60839c131dea85296705/minimal/amd64/Dockerfile)
- [`latest`, `9`, `9.4`, `9.4-20240506`](https://github.com/AlmaLinux/container-images/blob/35df378109dcb34fe4aa7c6105ec748bafcda307/default/amd64/Dockerfile)
- [`minimal`, `9-minimal`, `9.4-minimal`, `9.4-minimal-20240506`](https://github.com/AlmaLinux/container-images/blob/35df378109dcb34fe4aa7c6105ec748bafcda307/minimal/amd64/Dockerfile)
- [`8`, `8.10`, `8.10-20240723`](https://github.com/AlmaLinux/container-images/blob/584b31e78a465a342845694393b2347ad4dfb553/default/amd64/Dockerfile)

- [`8-minimal`, `8.10-minimal`, `8.10-minimal-20240723`](https://github.com/AlmaLinux/container-images/blob/584b31e78a465a342845694393b2347ad4dfb553/minimal/amd64/Dockerfile)

- [`latest`, `9`, `9.4`, `9.4-20240723`](https://github.com/AlmaLinux/container-images/blob/c7a0d7b57007f9b09b3f9e997df54f89d023bf60/default/amd64/Dockerfile)

- [`minimal`, `9-minimal`, `9.4-minimal`, `9.4-minimal-20240723`](https://github.com/AlmaLinux/container-images/blob/c7a0d7b57007f9b09b3f9e997df54f89d023bf60/minimal/amd64/Dockerfile)

# Quick reference (cont.)

Expand Down
7 changes: 7 additions & 0 deletions almalinux/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"hub": {
"categories": [
"operating-systems"
]
}
}
14 changes: 9 additions & 5 deletions alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ WARNING:

# Supported tags and respective `Dockerfile` links

- [`20240329`, `edge`](https://github.com/alpinelinux/docker-alpine/blob/a89bb0df27ce47646e8f9955934f0d0093c2d18e/x86_64/Dockerfile)
- [`3.19.1`, `3.19`, `3`, `latest`](https://github.com/alpinelinux/docker-alpine/blob/7385303148c97ef32a3f225ec03bafa46b689d12/x86_64/Dockerfile)
- [`3.18.6`, `3.18`](https://github.com/alpinelinux/docker-alpine/blob/08dbcabbd55e7430a326b582e544c6e1695126f3/x86_64/Dockerfile)
- [`3.17.7`, `3.17`](https://github.com/alpinelinux/docker-alpine/blob/1041155cbf4b410b02729c23a198d632945a1744/x86_64/Dockerfile)
- [`3.16.9`, `3.16`](https://github.com/alpinelinux/docker-alpine/blob/9c372c82f691cfe76c2058d75e2c4f9cd589d4c5/x86_64/Dockerfile)
- [`20240807`, `edge`](https://github.com/alpinelinux/docker-alpine/blob/35654ae14e617434d5ca29771296f6b9485eaa85/x86_64/Dockerfile)

- [`3.20.3`, `3.20`, `3`, `latest`](https://github.com/alpinelinux/docker-alpine/blob/7d63673353bd39d92ba42f6effcc199aeebd45ee/x86_64/Dockerfile)

- [`3.19.4`, `3.19`](https://github.com/alpinelinux/docker-alpine/blob/0822e580809e816cdd92fdfc2677e71d01cba38c/x86_64/Dockerfile)

- [`3.18.9`, `3.18`](https://github.com/alpinelinux/docker-alpine/blob/a8be5a35dd72f90cb18dc7d450dca5212f6ad70f/x86_64/Dockerfile)

- [`3.17.10`, `3.17`](https://github.com/alpinelinux/docker-alpine/blob/1d3ddcf4766ef6085fe6005ce3ec8ca4e6b45ddd/x86_64/Dockerfile)

# Quick reference (cont.)

Expand Down
7 changes: 7 additions & 0 deletions alpine/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"hub": {
"categories": [
"operating-systems"
]
}
}
3 changes: 3 additions & 0 deletions alt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,11 @@ WARNING:
# Supported tags and respective `Dockerfile` links

- [`p10`, `latest`](https://github.com/alt-cloud/docker-brew-alt/blob/924b51de1708a3c8b0dd76193a414460ff721c35/x86_64/Dockerfile)

- [`sisyphus`](https://github.com/alt-cloud/docker-brew-alt/blob/fc69e420b7b8c5b62cd3d8b13562f122ecdcc2d7/x86_64/Dockerfile)

- [`p11`](https://github.com/alt-cloud/docker-brew-alt/blob/342757f6f3ca8c82bb6a4169ceef071ff3a8a879/x86_64/Dockerfile)

# Quick reference (cont.)

- **Where to file issues**:
Expand Down
7 changes: 7 additions & 0 deletions alt/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"hub": {
"categories": [
"operating-systems"
]
}
}
Loading

0 comments on commit 0047507

Please sign in to comment.