Documentation for Docker Official Images in docker-library https://github.com/docker-library/official-images
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Docker Library Bot bfb81f6629 Run update.sh 5 days ago
.ci Fix dead link in CI 9 months ago
.common-templates Fixed maintainer.md 3 years ago
.github/workflows Ensure exit code on git diff can cause failure as well 1 year ago
.template-helpers Adjust variant-alpine wording 11 months ago
adminer Run update.sh 3 months ago
aerospike Run update.sh 3 months ago
almalinux Run update.sh 2 months ago
alpine Run update.sh 2 months ago
alt Run update.sh 4 months ago
amazoncorretto Run update.sh 1 month ago
amazonlinux Run update.sh 1 week ago
arangodb Run update.sh 2 months ago
archlinux Run update.sh 1 week ago
backdrop Run update.sh 1 year ago
bash Run update.sh 1 week ago
bonita Run update.sh 3 months ago
buildpack-deps Run update.sh 1 month ago
busybox Run update.sh 3 weeks ago
caddy Run update.sh 2 months ago
cassandra Run update.sh 4 months ago
centos Run update.sh 4 months ago
chronograf Run update.sh 3 months ago
cirros Run update.sh 11 months ago
clearlinux Run update.sh 1 week ago
clefos Run update.sh 1 year ago
clojure Run update.sh 2 weeks ago
composer Run update.sh 1 week ago
consul Run update.sh 5 days ago
convertigo Run update.sh 1 month ago
couchbase Run update.sh 1 month ago
couchdb Run update.sh 2 weeks ago
crate Run update.sh 1 month ago
dart Run update.sh 7 days ago
debian Run update.sh 4 weeks ago
docker Run update.sh 2 weeks ago
drupal Run update.sh 6 days ago
eclipse-mosquitto Run update.sh 2 months ago
eclipse-temurin Run update.sh 6 days ago
eggdrop Run update.sh 4 weeks ago
elasticsearch Run update.sh 6 days ago
elixir Run update.sh 1 month ago
erlang Run update.sh 1 week ago
express-gateway Run update.sh 9 months ago
fedora Run update.sh 2 months ago
flink Run update.sh 1 month ago
fluentd Run update.sh 4 months ago
friendica Run update.sh 2 weeks ago
gazebo Run update.sh 1 month ago
gcc Run update.sh 6 months ago
geonetwork Run update.sh 1 month ago
ghost Run update.sh 6 days ago
golang Run update.sh 7 days ago
gradle Run update.sh 4 weeks ago
groovy Run update.sh 3 weeks ago
haproxy Run update.sh 7 days ago
haskell Run update.sh 2 weeks ago
haxe Run update.sh 6 days ago
hello-world Run update.sh 4 months ago
hitch Run update.sh 1 month ago
httpd Run update.sh 4 weeks ago
hylang Run update.sh 7 days ago
ibm-semeru-runtimes Run update.sh 1 month ago
ibmjava Run update.sh 2 months ago
influxdb Run update.sh 2 months ago
irssi Run update.sh 6 months ago
jetty Run update.sh 2 months ago
jobber Run update.sh 1 year ago
joomla Run update.sh 1 month ago
jruby Run update.sh 2 months ago
julia Run update.sh 7 days ago
kapacitor Run update.sh 3 months ago
kibana Run update.sh 6 days ago
kong Run update.sh 1 month ago
lightstreamer Run update.sh 2 weeks ago
logstash Run update.sh 6 days ago
mageia Run update.sh 10 months ago
mariadb Run update.sh 2 months ago
matomo Run update.sh 1 month ago
maven Run update.sh 1 week ago
mediawiki Run update.sh 1 month ago
memcached Run update.sh 2 months ago
mongo Run update.sh 7 days ago
mongo-express Run update.sh 7 months ago
monica Run update.sh 6 days ago
mono Run update.sh 2 months ago
mysql Run update.sh 3 months ago
nats Run update.sh 5 days ago
nats-streaming Run update.sh 2 months ago
neo4j Run update.sh 6 days ago
neurodebian Run update.sh 5 months ago
nextcloud Run update.sh 2 months ago
nginx Run update.sh 3 weeks ago
node Run update.sh 1 week ago
notary Run update.sh 7 months ago
odoo Run update.sh 1 week ago
open-liberty Run update.sh 2 months ago
openjdk Run update.sh 7 days ago
oraclelinux Run update.sh 7 days ago
orientdb Run update.sh 3 weeks ago
percona Run update.sh 3 weeks ago
perl Run update.sh 2 months ago
photon Run update.sh 5 days ago
php Run update.sh 1 month ago
php-zendserver Run update.sh 8 months ago
phpmyadmin Run update.sh 8 months ago
plone Run update.sh 2 months ago
postfixadmin Run update.sh 5 months ago
postgres Run update.sh 2 weeks ago
pypy Run update.sh 3 months ago
python Run update.sh 7 days ago
r-base Run update.sh 3 months ago
rabbitmq Run update.sh 2 weeks ago
rakudo-star Run update.sh 8 months ago
redis Run update.sh 2 months ago
redmine Run update.sh 2 weeks ago
registry Run update.sh 1 year ago
rethinkdb Run update.sh 3 months ago
rocket.chat Run update.sh 1 week ago
rockylinux Run update.sh 1 month ago
ros Run update.sh 2 months ago
ruby Run update.sh 3 weeks ago
rust Run update.sh 6 days ago
sapmachine Run update.sh 3 months ago
scratch Add a quote blurb from the upstream docs to the scratch description 5 years ago
silverpeas Run update.sh 1 month ago
sl Run update.sh 2 weeks ago
solr Run update.sh 4 weeks ago
sonarqube Run update.sh 4 weeks ago
spiped Run update.sh 3 weeks ago
storm Run update.sh 3 months ago
swift Run update.sh 1 month ago
swipl Run update.sh 1 week ago
teamspeak Run update.sh 7 months ago
telegraf Run update.sh 2 weeks ago
tomcat Run update.sh 4 weeks ago
tomee Run update.sh 6 days ago
traefik Run update.sh 7 days ago
ubuntu Run update.sh 2 weeks ago
varnish Run update.sh 2 months ago
vault Run update.sh 4 weeks ago
websphere-liberty Run update.sh 2 months ago
wordpress Run update.sh 7 days ago
xwiki Run update.sh 2 weeks ago
yourls Run update.sh 4 months ago
znc Run update.sh 4 months ago
zookeeper Run update.sh 8 months ago
.dockerignore Add simple .dockerignore 7 years ago
Dockerfile Update to Mojolicious 8.35 2 years ago
LICENSE Remove ending year from LICENSE 4 years ago
README.md Update Table of Contents 4 months ago
generate-repo-stub-readme.sh Adjust repo stub disclaimer to exclude repos where it makes no sense 7 months ago
markdownfmt.sh Add "ymlfmt" for enforcing consistent YAML whitespace 4 years ago
parallel-update.sh Add "parallel update" script to generate multiple markdown files simultaneously 2 years ago
push.pl Move/rename sponsored links section 4 months ago
push.sh Add logo pushing ability for library/ images! 2 years ago
update.sh Add an additional clarifying note to the top of the per-architecture repositories 2 years ago
ymlfmt.sh Add "ymlfmt" for enforcing consistent YAML whitespace 4 years ago

README.md

What is this?

This repository contains the image documentation for each of the Docker Official Images. See docker-library/official-images for more information about the program in general.

All Markdown files here are run through tianon's fork of markdownfmt, and verified as formatted correctly via GitHub Actions.

  • GitHub CI status badge
  • library update.sh status badge
    • amd64 update.sh status badge
    • arm32v5 update.sh status badge
    • arm32v6 update.sh status badge
    • arm32v7 update.sh status badge
    • arm64v8 update.sh status badge
    • i386 update.sh status badge
    • ppc64le update.sh status badge
    • s390x update.sh status badge
    • windows-amd64 update.sh status badge

Table of Contents

  1. What is this?
    1. Table of Contents
  2. How do I update an image's docs
  3. How do I add a new image's docs
  4. Files related to an image's docs
    1. folder <image name>
    2. README.md
    3. content.md
    4. get-help.md
    5. github-repo
    6. license.md
    7. logo.png
    8. maintainer.md
    9. README-short.txt
    10. stack.yml
  5. Files for main Docs repo
    1. update.sh
    2. markdownfmt.sh and ymlfmt.sh
    3. .template-helpers/generate-dockerfile-links-partial.sh
    4. .template-helpers/
  6. Scripts unrelated to templates
    1. generate-repo-stub-readme.sh
    2. push.pl and push.sh
  7. Issues and Contributing

How do I update an image's docs

Edit the content.md for an image; not the README.md as it's auto-generated from the contents of the other files in that repo. To see the changes to the README.md, run ./update.sh myimage from the repo root, but do not add the README.md changes to your pull request. See also markdownfmt.sh point below.

After opening your Pull Request the changes will be checked by an automated markdownfmt.sh before it can be merged. A common issue is incorrect spacing such as with two lines missing an empty line between them (double-spaced).

How do I add a new image's docs

  • create a folder for my image: mkdir myimage
  • create a README-short.txt (required, 100 char max)
  • create a content.md (required)
  • create a license.md (required)
  • create a maintainer.md (required)
  • create a github-repo (required)
  • add a logo.png (recommended)

Optionally:

  • run ./markdownfmt.sh -l myimage to list any files that are non-compliant to tianon/markdownfmt.
    Any files in the list will result in a failed build during continuous integration.
    • run ./markdownfmt.sh -d myimage to see a diff of changes required to pass.
  • run ./update.sh myimage to generate myimage/README.md for manual review of the generated copy.
    Note: do not actually commit the README.md file; it is automatically generated/committed before being uploaded to Docker Hub.

Files related to an image's docs

folder <image name>

This is where all the partial (e.g. content.md) and generated files (e.g. README.md) for a given image reside, (e.g. golang/). It must match the name of the image used in docker-library/official-images.

README.md

This file is generated using update.sh. Do not commit or edit this file; it is regenerated periodically by a bot.

content.md

This file contains the main content of your image's long description. The basic parts you should have are a "What Is" section and a "How To" section. The following is a basic layout:

# What is XYZ?

// about what the contained software is

%%LOGO%%

# How to use this image

// descriptions and examples of common use cases for the image
// make use of subsections as necessary

get-help.md

This file is an optional override of the default get-help.md. This is the content of the "Where to get help" part of the "Quick reference" at the top of the generated README. We recommend linking to the best places for community support like forums, chat rooms, or mailing lists.

github-repo

This file should contain the URL to the GitHub repository for the Dockerfiles that become the images. The file should be in a single line ending in a newline with no extraneous whitespace. Only one GitHub repo per image repository is supported. It is used in generating links. Here is an example for golang:

https://github.com/docker-library/golang

license.md

This file should contain a link to the license for the main software in the image. Here is an example for golang:

View [license information](http://golang.org/LICENSE) for the software contained in this image.

logo.png

Logo for the contained software. While there are not hard rules on formatting, most existing logos are square or landscape and stay within a few hundred pixels of width. Alternatively, a logo.svg can be used instead, but only one logo file will apply. To use it within content.md, put %%LOGO%% as shown above in the basic content.md layout.

The image is automatically scaled to a 120 pixel square for the top of the Docker Hub page and Hub search results.

maintainer.md

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

README-short.txt

This is the short description for the Docker Hub, limited to 100 characters in a single line.

Go (golang) is a general purpose, higher-level, imperative programming language.

stack.yml

This optional file contains a small, working Compose file for Docker Swarm showing off how to use the image. To use the stack.yml, add %%STACK%% to the content.md and this will embed the YAML along with a link to directly try it in Play with Docker.

The file must work via docker stack deploy since that is how Play with Docker will launch it, but it is helpful for users to try locally if it works for docker-compose as well. Other official images may be referenced within the YAML to demonstrate the functionality of the image, but no images external to the Docker Official Images program may be referenced.

Files for main Docs repo

update.sh

This is the main script used to generate the README.md files for each image. The generated file is committed along with the files used to generate it. Accepted arguments are which image(s) you want to update or no arguments to update all of them.

This script assumes bashbrew is in your PATH (for scraping relevant tag information from the library manifest file for each repository).

markdownfmt.sh and ymlfmt.sh

These two scripts are for verifying the formatting of Markdown (.md) and YAML (.yml) files, respectively. markdownfmt.sh uses the tianon/markdownfmt image and ymlfmt.sh uses the tianon/ymlfmt image.

This script is used by update.sh to create the "Supported tags and respective Dockerfile links" section of each generated README.md from the information in the official-images library/ manifests.

.template-helpers/

The scripts and Markdown files in here are used in building an image's README.md file in combination with its individual files.

Scripts unrelated to templates

generate-repo-stub-readme.sh

This is used to generate a simple README.md to put in the image's repo. We use this in Git repositories within https://github.com/docker-library to simplify our maintenance, but it is not required for anyone else. Argument is the name of the image, like golang and it then outputs the readme to standard out.

push.pl and push.sh

These are used by us to push the actual content of the READMEs to the Docker Hub as special access is required to modify the Hub description contents. The Dockerfile is used to create a suitable environment for push.pl.

Issues and Contributing

If you would like to make a new Official Image, be sure to follow the guidelines.

Feel free to make a pull request for fixes and improvements to current documentation. For questions or problems on this repo come talk to us via the #docker-library IRC channel on Libera.Chat or open up an issue.