<!--

********************************************************************************

WARNING:

    DO NOT EDIT "debian/README.md"

    IT IS AUTO-GENERATED

    (from the other files in "debian/" combined with a set of templates)

********************************************************************************

-->

# Quick reference

-	**Maintained by**:  
	Debian Developers [tianon](https://qa.debian.org/developer.php?login=tianon) and [paultag](https://qa.debian.org/developer.php?login=paultag)

-	**Where to get help**:  
	[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)

# Supported tags and respective `Dockerfile` links

-	[`bookworm`, `bookworm-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/bookworm/Dockerfile)
-	[`bookworm-backports`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/bookworm/backports/Dockerfile)
-	[`bookworm-slim`, `bookworm-20220822-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/bookworm/slim/Dockerfile)
-	[`bullseye`, `bullseye-20220822`, `11.4`, `11`, `latest`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/bullseye/Dockerfile)
-	[`bullseye-backports`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/bullseye/backports/Dockerfile)
-	[`bullseye-slim`, `bullseye-20220822-slim`, `11.4-slim`, `11-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/bullseye/slim/Dockerfile)
-	[`buster`, `buster-20220822`, `10.12`, `10`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/buster/Dockerfile)
-	[`buster-backports`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/buster/backports/Dockerfile)
-	[`buster-slim`, `buster-20220822-slim`, `10.12-slim`, `10-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/buster/slim/Dockerfile)
-	[`experimental`, `experimental-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/experimental/Dockerfile)
-	[`oldstable`, `oldstable-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/oldstable/Dockerfile)
-	[`oldstable-backports`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/oldstable/backports/Dockerfile)
-	[`oldstable-slim`, `oldstable-20220822-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/oldstable/slim/Dockerfile)
-	[`rc-buggy`, `rc-buggy-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/rc-buggy/Dockerfile)
-	[`sid`, `sid-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/sid/Dockerfile)
-	[`sid-slim`, `sid-20220822-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/sid/slim/Dockerfile)
-	[`stable`, `stable-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/stable/Dockerfile)
-	[`stable-backports`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/stable/backports/Dockerfile)
-	[`stable-slim`, `stable-20220822-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/stable/slim/Dockerfile)
-	[`testing`, `testing-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/testing/Dockerfile)
-	[`testing-backports`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/testing/backports/Dockerfile)
-	[`testing-slim`, `testing-20220822-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/testing/slim/Dockerfile)
-	[`unstable`, `unstable-20220822`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/unstable/Dockerfile)
-	[`unstable-slim`, `unstable-20220822-slim`](https://github.com/debuerreotype/docker-debian-artifacts/blob/e5c204e07387a56c1680483ff7cba16c22146657/unstable/slim/Dockerfile)

# Quick reference (cont.)

-	**Where to file issues**:  
	[https://github.com/debuerreotype/docker-debian-artifacts/issues](https://github.com/debuerreotype/docker-debian-artifacts/issues)

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

-	**Published image artifact details**:  
	[repo-info repo's `repos/debian/` directory](https://github.com/docker-library/repo-info/blob/master/repos/debian) ([history](https://github.com/docker-library/repo-info/commits/master/repos/debian))  
	(image metadata, transfer size, etc)

-	**Image updates**:  
	[official-images repo's `library/debian` label](https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fdebian)  
	[official-images repo's `library/debian` file](https://github.com/docker-library/official-images/blob/master/library/debian) ([history](https://github.com/docker-library/official-images/commits/master/library/debian))

-	**Source of this description**:  
	[docs repo's `debian/` directory](https://github.com/docker-library/docs/tree/master/debian) ([history](https://github.com/docker-library/docs/commits/master/debian))

# What is Debian?

Debian is an operating system which is composed primarily of free and open-source software, most of which is under the GNU General Public License, and developed by a group of individuals known as the Debian project. Debian is one of the most popular Linux distributions for personal computers and network servers, and has been used as a base for several other Linux distributions.

> [wikipedia.org/wiki/Debian](https://en.wikipedia.org/wiki/Debian)

![logo](https://raw.githubusercontent.com/docker-library/docs/b449be7df57e9ed9086bb5821bfb5d6cdc5d67a4/debian/logo.png)

# About this image

The `debian:latest` tag will always point the latest stable release. Stable releases are also tagged with their version (ie, `debian:11` is an alias for `debian:bullseye`, `debian:10` is an alias for `debian:buster`, etc).

The rolling tags (`debian:stable`, `debian:testing`, etc) use the rolling suite names in their `/etc/apt/sources.list` file (ie, `deb http://deb.debian.org/debian testing main`).

The mirror of choice for these images is [the deb.debian.org CDN pointer/redirector](https://deb.debian.org) so that it's as reliable as possible for the largest subset of users (and is also the default mirror for `debootstrap` as of [2016-10-20](https://anonscm.debian.org/cgit/d-i/debootstrap.git/commit/?id=9e8bc60ad1ccf3a25ce7890526b70059f3e770de)). See the [deb.debian.org homepage](https://deb.debian.org) for more information.

If you find yourself needing a Debian release which is EOL (and thus only available from [archive.debian.org](http://archive.debian.org)), you should check out [the `debian/eol` image](https://hub.docker.com/r/debian/eol/), which includes tags for Debian releases as far back as Potato (Debian 2.2), the first release to fully utilize APT.

## Locales

Given that it is a faithful "minbase" install of Debian, this image only includes the `C`, `C.UTF-8`, and `POSIX` locales by default. For most uses requiring a UTF-8 locale, `C.UTF-8` is likely sufficient (`-e LANG=C.UTF-8` or `ENV LANG C.UTF-8`).

For uses where that is not sufficient, other locales can be installed/generated via the `locales` package. [PostgreSQL has a good example of doing so](https://github.com/docker-library/postgres/blob/69bc540ecfffecce72d49fa7e4a46680350037f9/9.6/Dockerfile#L21-L24), copied below:

```dockerfile
RUN apt-get update && apt-get install -y locales && rm -rf /var/lib/apt/lists/* \
	&& localedef -i en_US -c -f UTF-8 -A /usr/share/locale/locale.alias en_US.UTF-8
ENV LANG en_US.utf8
```

## How It's Made

The rootfs tarballs for this image are built using [the reproducible-Debian-rootfs tool, `debuerreotype`](https://github.com/debuerreotype/debuerreotype), with an explicit goal being that they are transparent and reproducible. Using the same toolchain, it should be possible to regenerate (clean-room!) the same tarballs used for building the official Debian images. [The `examples/debian.sh` script in that debuerreotype repository](https://github.com/debuerreotype/debuerreotype/blob/master/examples/debian.sh) (and the `debian-all.sh` companion/wrapper) is the canonical entrypoint used for creating the artifacts published in this image (via a process similar to the `docker-run.sh` included in the root of that repository).

Additionally, the scripts in [https://github.com/debuerreotype/docker-debian-artifacts](https://github.com/debuerreotype/docker-debian-artifacts) are used to create each tag's `Dockerfile` and collect architecture-specific tarballs into [`dist-ARCH` branches on the same repository](https://github.com/debuerreotype/docker-debian-artifacts/branches), which also contain extra metadata about the artifacts included in each build, such as explicit package versions included in the base image (`rootfs.manifest`), the exact snapshot.debian.org timestamp used for `debuerreotype` invocation (`rootfs.debuerreotype-epoch`), the `sources.list` found in the image (`rootfs.sources-list`) and the one used during image creation (`rootfs.sources-list-snapshot`), etc.

For convenience, the SHA256 checksum (and full build command) for each of the primary `rootfs.tar.xz` artifacts are also published at [docker.debian.net](https://docker.debian.net/).

# Image Variants

## `debian:<suite>-slim`

These tags are an experiment in providing a slimmer base (removing some extra files that are normally not necessary within containers, such as man pages and documentation), and are definitely subject to change.

See the `debuerreotype-slimify` script (`debuerreotype` linked above) for more details about what gets removed during the "slimification" process.

# License

View [license information](https://www.debian.org/social_contract#guidelines) for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in [the `repo-info` repository's `debian/` directory](https://github.com/docker-library/repo-info/tree/master/repos/debian).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
