docs/clearlinux/README.md

64 lines
3.1 KiB
Markdown

<!--
********************************************************************************
WARNING:
DO NOT EDIT "clearlinux/README.md"
IT IS AUTO-GENERATED
(from the other files in "clearlinux/" combined with a set of templates)
********************************************************************************
-->
# Supported tags and respective `Dockerfile` links
- [`latest`, `base` (*Dockerfile*)](https://github.com/clearlinux/docker-brew-clearlinux/blob/1856b9f9d8340774f4a77171bac9e1476fc0b8c1/Dockerfile)
# Quick reference
- **Where to get help**:
[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
- **Where to file issues**:
[https://github.com/clearlinux/docker-brew-clearlinux/issues](https://github.com/clearlinux/docker-brew-clearlinux/issues)
- **Maintained by**:
[Intel Corporation](https://github.com/clearlinux/docker-brew-clearlinux)
- **Published image artifact details**:
[repo-info repo's `repos/clearlinux/` directory](https://github.com/docker-library/repo-info/blob/master/repos/clearlinux) ([history](https://github.com/docker-library/repo-info/commits/master/repos/clearlinux))
(image metadata, transfer size, etc)
- **Image updates**:
[official-images PRs with label `library/clearlinux`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fclearlinux)
[official-images repo's `library/clearlinux` file](https://github.com/docker-library/official-images/blob/master/library/clearlinux) ([history](https://github.com/docker-library/official-images/commits/master/library/clearlinux))
- **Source of this description**:
[docs repo's `clearlinux/` directory](https://github.com/docker-library/docs/tree/master/clearlinux) ([history](https://github.com/docker-library/docs/commits/master/clearlinux))
- **Supported Docker versions**:
[the latest release](https://github.com/docker/docker-ce/releases/latest) (down to 1.6 on a best-effort basis)
# Clear Linux OS
This serves as the official [Clear Linux OS](https://clearlinux.org) image.
![logo](https://raw.githubusercontent.com/docker-library/docs/dbe1941be63c87cc691b59d50f830f9dd7d69df9/clearlinux/logo.png)
The `clearlinux:latest` tag will point to `clearlinux:base` which will track toward the latest release version of the distribution.
This image contains the os-core and os-core-update bundles, the latter can be used to add additional Clear Linux OS components (see [here](https://clearlinux.org/documentation/swupdate_about_sw_update.html) for more details about swupd and [here](https://clearlinux.org/documentation/bundles_overview.html) for more information on bundles).
The following Dockerfile will install the editors and dev-utils bundles on top of the base image
```sh
FROM clearlinux:base
RUN swupd bundle-add editors dev-utils
```
Where editors contains the usual suspects for command line editors and dev-utils contains some handy development tools like strace, gdb and valgrind.