diff --git a/README.md b/README.md index 66e4b08e7197..3f32c49cf84a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ - -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/bitnami/containers/blob/main/CONTRIBUTING.md) +

+ +

+ +

+ + + +

# The Bitnami Containers Library @@ -9,10 +16,10 @@ Popular applications, provided by [Bitnami](https://bitnami.com), containerized * Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems. * With Bitnami images the latest bug fixes and features are available as soon as possible. -* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs. -* All our images are based on [**minideb**](https://github.com/bitnami/minideb) -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or **scratch** -an explicitly empty image-. +* Bitnami containers, virtual machines, and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs. +* All our images are based on [**minideb**](https://github.com/bitnami/minideb) -a minimalist Debian-based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or **scratch** -an explicitly empty image-. * All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images. -* Bitnami container images are released on a regular basis with the latest distribution packages available. +* Bitnami container images are released regularly with the latest distribution packages available. Looking to use our applications in production? Try [VMware Tanzu Application Catalog](https://bitnami.com/enterprise), the enterprise edition of Bitnami Application Catalog. @@ -21,32 +28,32 @@ Looking to use our applications in production? Try [VMware Tanzu Application Cat The recommended way to get any of the Bitnami Images is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/). ```console -docker pull bitnami/APP +$ docker pull bitnami/APP ``` To use a specific version, you can pull a versioned tag. ```console -docker pull bitnami/APP:[TAG] +$ docker pull bitnami/APP:[TAG] ``` -If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the `docker build` command. +If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile, and executing the `docker build` command. ```console -git clone https://github.com/bitnami/containers.git -cd bitnami/APP/VERSION/OPERATING-SYSTEM -docker build -t bitnami/APP . +$ git clone https://github.com/bitnami/containers.git +$ cd bitnami/APP/VERSION/OPERATING-SYSTEM +$ docker build -t bitnami/APP . ``` -> Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` placeholders in the example command above with the correct values. +> Remember to replace the `APP`, `VERSION`, and `OPERATING-SYSTEM` placeholders in the example command above with the correct values. ## Run the application using Docker Compose The main folder of each application contains a functional `docker-compose.yml` file. Run the application using it as shown below: ```console -curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/APP/docker-compose.yml > docker-compose.yml -docker-compose up -d +$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/APP/docker-compose.yml > docker-compose.yml +$ docker-compose up -d ``` > Remember to replace the `APP` placeholder in the example command above with the correct value.