bitnami
/
containers
mirror of https://github.com/bitnami/containers.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[bitnami/*] Fix markdown linter issues (#23945) 

* [bitnami/*] Fix markdown linter issues

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Add leftovers

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Update CODE_OF_CONDUCT.md

Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com>
Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com>

* Update CONTRIBUTING.md

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Update bitnami/zookeeper/README.md

Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com>
Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com>

* Linter fix

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Order lists

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Fix markdown

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Order lists

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

---------

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>
Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com>
Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com>
This commit is contained in:
Carlos Rodríguez Hernández 2023-02-16 11:38:13 +01:00 committed by GitHub
parent 9d243a6d23
commit d7bd442eba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
218 changed files with 6677 additions and 6711 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -25,7 +25,7 @@
### Applicable issues
<!-- Enter any applicable Issues here (You can reference an issue using #) -->
- fixes #
- fixes #
### Additional information

4
CODE_OF_CONDUCT.md
View File

@ -12,6 +12,6 @@ If you are subjected to or witness unacceptable behavior, or have any other conc
If you have suggestions to improve this Code of Conduct, please submit an issue or PR.
**Attribution**
## Attribution
This Code of Conduct is adapted from the Angular project available at this page: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
This Code of Conduct is adapted from the Angular project available at this page: <https://github.com/angular/code-of-conduct/blob/main/CODE_OF_CONDUCT.md>

9
CONTRIBUTING.md
View File

@ -14,9 +14,10 @@ Any type of contribution is welcome: new features, bug fixes, documentation impr
### Requirements
When submitting a PR make sure that:
- It must pass CI jobs for linting and test the changes (if any).
- It must follow [container best practices](https://engineering.bitnami.com/articles/best-practices-writing-a-dockerfile.html).
- The title of the PR is clear enough and starts with "[bitnami/<container-name>]"
- The title of the PR is clear enough and starts with "[bitnami/container-name]"
- If necessary, add information to the repository's `README.md`.
#### Sign Your Work
@ -25,7 +26,9 @@ The sign-off is a simple line at the end of the explanation for a commit. All co
Then you just add a line to every git commit message:
Signed-off-by: Joe Smith <joe.smith@example.com>
```text
Signed-off-by: Joe Smith <joe.smith@example.com>
```
Use your real name (sorry, no pseudonyms or anonymous contributions.)
@ -33,7 +36,7 @@ If you set your `user.name` and `user.email` git configs, you can sign your comm
Note: If your git config information is set properly then viewing the `git log` information for your commit will look something like this:
```
```text
Author: Joe Smith <joe.smith@example.com>
Date: Thu Feb 2 11:41:15 2018 -0800

16
README.md
View File

@ -19,21 +19,21 @@ Popular applications, provided by [Bitnami](https://bitnami.com), containerized
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.
```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.
@ -43,8 +43,8 @@ $ docker build -t bitnami/APP .
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.
@ -70,7 +70,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.

8
bitnami/acmesolver/README.md
View File

@ -12,14 +12,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/acmesolver:latest
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/acmesolver:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/acmesolver/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/acmesolver/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Configuration](#configuration) section for a more secure deployment.
@ -71,7 +71,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

28
bitnami/airflow-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name airflow-exporter bitnami/airflow-exporter:latest
docker run --name airflow-exporter bitnami/airflow-exporter:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Airflow Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/airflow-exporter).
```console
$ docker pull bitnami/airflow-exporter:latest
docker pull bitnami/airflow-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/airflow-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/airflow-exporter:[TAG]
docker pull bitnami/airflow-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create airflow-exporter-network --driver bridge
docker network create airflow-exporter-network --driver bridge
```
#### Step 2: Launch the airflow-exporter container within your network
@ -76,7 +76,7 @@ $ docker network create airflow-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `airflow-exporter-network` network.
```console
$ docker run --name airflow-exporter-node1 --network airflow-exporter-network bitnami/airflow-exporter:latest
docker run --name airflow-exporter-node1 --network airflow-exporter-network bitnami/airflow-exporter:latest
```
#### Step 3: Run another containers
@ -92,7 +92,7 @@ Find all the configuration options in the [Airflow Prometheus Exporter documenta
The Bitnami Airflow Exporter Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs airflow-exporter
docker logs airflow-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -106,7 +106,7 @@ Bitnami provides up-to-date versions of Airflow Exporter, including security pat
#### Step 1: Get the updated image
```console
$ docker pull bitnami/airflow-exporter:latest
docker pull bitnami/airflow-exporter:latest
```
#### Step 2: Stop the running container
@ -114,13 +114,13 @@ $ docker pull bitnami/airflow-exporter:latest
Stop the currently running container using the command
```console
$ docker stop airflow-exporter
docker stop airflow-exporter
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v airflow-exporter
docker rm -v airflow-exporter
```
#### Step 4: Run the new image
@ -128,7 +128,7 @@ $ docker rm -v airflow-exporter
Re-create your container from the new image.
```console
$ docker run --name airflow-exporter bitnami/airflow-exporter:latest
docker run --name airflow-exporter bitnami/airflow-exporter:latest
```
## Contributing
@ -147,7 +147,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

298
bitnami/airflow-scheduler/README.md
View File

@ -13,8 +13,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
### Docker Compose
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-scheduler/docker-compose.yml
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-scheduler/docker-compose.yml
docker-compose up
```
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
@ -50,8 +50,8 @@ You will need an [Airflow Webserver](https://github.com/bitnami/containers/tree/
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/airflow-scheduler/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-scheduler/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-scheduler/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -60,82 +60,82 @@ If you want to run the application manually instead of using `docker-compose`, t
1. Create a network
```console
$ docker network create airflow-tier
```
```console
docker network create airflow-tier
```
2. Create a volume for PostgreSQL persistence and create a PostgreSQL container
```console
$ docker volume create --name postgresql_data
$ docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume postgresql_data:/bitnami/postgresql \
bitnami/postgresql:latest
```
```console
docker volume create --name postgresql_data
docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume postgresql_data:/bitnami/postgresql \
bitnami/postgresql:latest
```
3. Create a volume for Redis(R) persistence and create a Redis(R) container
```console
$ docker volume create --name redis_data
$ docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume redis_data:/bitnami \
bitnami/redis:latest
```
```console
docker volume create --name redis_data
docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume redis_data:/bitnami \
bitnami/redis:latest
```
4. Launch the Apache Airflow Scheduler web container
4. Launch the {{ .Name }} web container
```console
$ docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
```console
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
5. Launch the Apache Airflow Scheduler scheduler container
5. Launch the {{ .Name }} scheduler container
```console
$ docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
```console
docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
6. Launch the Apache Airflow Scheduler worker container
6. Launch the {{ .Name }} worker container
```console
$ docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
--net airflow-tier \
bitnami/airflow-worker:latest
```
```console
docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
--net airflow-tier \
bitnami/airflow-worker:latest
```
Access your application at `http://your-ip:8080`
Access your application at `http://your-ip:8080`
### Persisting your application
@ -206,78 +206,78 @@ services:
1. Create a network (if it does not exist)
```console
$ docker network create airflow-tier
```
```console
docker network create airflow-tier
```
2. Create the PostgreSQL container with host volumes
```console
$ docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume /path/to/postgresql-persistence:/bitnami \
bitnami/postgresql:latest
```
```console
docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume /path/to/postgresql-persistence:/bitnami \
bitnami/postgresql:latest
```
3. Create the Redis(R) container with host volumes
```console
$ docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume /path/to/redis-persistence:/bitnami \
bitnami/redis:latest
```
```console
docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume /path/to/redis-persistence:/bitnami \
bitnami/redis:latest
```
4. Create the Airflow container
```console
$ docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
```console
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
5. Create the Apache Airflow Scheduler container
5. Create the {{ .Name }} container
```console
$ docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
```console
docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
6. Create the Airflow Worker container
```console
$ docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
--net airflow-tier \
bitnami/airflow-worker:latest
```
```console
docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
--net airflow-tier \
bitnami/airflow-worker:latest
```
## Configuration
@ -289,30 +289,30 @@ This container supports the installation of additional python modules at start-u
The Apache Airflow Scheduler instance can be customized by specifying environment variables on the first run. The following environment values are provided to customize Apache Airflow Scheduler:
###### Apache Airflow Scheduler configuration
#### Apache Airflow Scheduler configuration
- `AIRFLOW_EXECUTOR`: Apache Airflow Scheduler executor. Default: **SequentialExecutor**
- `AIRFLOW_FERNET_KEY`: Apache Airflow Scheduler Fernet key. No defaults.
- `AIRFLOW_SECRET_KEY`: Apache Airflow Scheduler Secret key. No defaults.
- `AIRFLOW_WEBSERVER_HOST`: Apache Airflow Scheduler webserver host. Default: **airflow**
- `AIRFLOW_WEBSERVER_PORT_NUMBER`: Apache Airflow Scheduler webserver port. Default: **8080**
- `AIRFLOW_LOAD_EXAMPLES`: To load example tasks into the application. Default: **yes**
- `AIRFLOW_HOSTNAME_CALLABLE`: Method to obtain the hostname. No defaults.
* `AIRFLOW_EXECUTOR`: Apache Airflow Scheduler executor. Default: **SequentialExecutor**
* `AIRFLOW_FERNET_KEY`: Apache Airflow Scheduler Fernet key. No defaults.
* `AIRFLOW_SECRET_KEY`: Apache Airflow Scheduler Secret key. No defaults.
* `AIRFLOW_WEBSERVER_HOST`: Apache Airflow Scheduler webserver host. Default: **airflow**
* `AIRFLOW_WEBSERVER_PORT_NUMBER`: Apache Airflow Scheduler webserver port. Default: **8080**
* `AIRFLOW_LOAD_EXAMPLES`: To load example tasks into the application. Default: **yes**
* `AIRFLOW_HOSTNAME_CALLABLE`: Method to obtain the hostname. No defaults.
###### Use an existing database
#### Use an existing database
- `AIRFLOW_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
- `AIRFLOW_DATABASE_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
- `AIRFLOW_DATABASE_NAME`: Database name that Apache Airflow Scheduler will use to connect with the database. Default: **bitnami_airflow**
- `AIRFLOW_DATABASE_USERNAME`: Database user that Apache Airflow Scheduler will use to connect with the database. Default: **bn_airflow**
- `AIRFLOW_DATABASE_PASSWORD`: Database password that Apache Airflow Scheduler will use to connect with the database. No defaults.
- `AIRFLOW_DATABASE_USE_SSL`: Set to yes if the database uses SSL. Default: **no**
- `AIRFLOW_REDIS_USE_SSL`: Set to yes if Redis(R) uses SSL. Default: **no**
- `REDIS_HOST`: Hostname for Redis(R) server. Default: **redis**
- `REDIS_PORT_NUMBER`: Port used by Redis(R) server. Default: **6379**
- `REDIS_USER`: USER that Apache Airflow Scheduler will use to connect with Redis(R). No defaults.
- `REDIS_PASSWORD`: Password that Apache Airflow Scheduler will use to connect with Redis(R). No defaults.
- `REDIS_DATABASE`: Database number for Redis(R) server. Default: **1**
* `AIRFLOW_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
* `AIRFLOW_DATABASE_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
* `AIRFLOW_DATABASE_NAME`: Database name that Apache Airflow Scheduler will use to connect with the database. Default: **bitnami_airflow**
* `AIRFLOW_DATABASE_USERNAME`: Database user that Apache Airflow Scheduler will use to connect with the database. Default: **bn_airflow**
* `AIRFLOW_DATABASE_PASSWORD`: Database password that Apache Airflow Scheduler will use to connect with the database. No defaults.
* `AIRFLOW_DATABASE_USE_SSL`: Set to yes if the database uses SSL. Default: **no**
* `AIRFLOW_REDIS_USE_SSL`: Set to yes if Redis(R) uses SSL. Default: **no**
* `REDIS_HOST`: Hostname for Redis(R) server. Default: **redis**
* `REDIS_PORT_NUMBER`: Port used by Redis(R) server. Default: **6379**
* `REDIS_USER`: USER that Apache Airflow Scheduler will use to connect with Redis(R). No defaults.
* `REDIS_PASSWORD`: Password that Apache Airflow Scheduler will use to connect with Redis(R). No defaults.
* `REDIS_DATABASE`: Database number for Redis(R) server. Default: **1**
> In addition to the previous environment variables, all the parameters from the configuration file can be overwritten by using environment variables with this format: `AIRFLOW__{SECTION}__{KEY}`. Note the double underscores.
@ -339,7 +339,7 @@ services:
#### Specifying Environment variables on the Docker command line
```console
$ docker run -d --name airflow -p 8080:8080 \
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
@ -357,8 +357,8 @@ $ docker run -d --name airflow -p 8080:8080 \
### 1.10.15-debian-10-r18 and 2.0.1-debian-10-r52
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
## Contributing

298
bitnami/airflow-worker/README.md
View File

@ -13,8 +13,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
### Docker Compose
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-worker/docker-compose.yml
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-worker/docker-compose.yml
docker-compose up
```
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
@ -50,8 +50,8 @@ You will need an [Airflow Webserver](https://github.com/bitnami/containers/tree/
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/airflow-worker/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-worker/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow-worker/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -60,83 +60,83 @@ If you want to run the application manually instead of using `docker-compose`, t
1. Create a network
```console
$ docker network create airflow-tier
```
```console
docker network create airflow-tier
```
2. Create a volume for PostgreSQL persistence and create a PostgreSQL container
```console
$ docker volume create --name postgresql_data
$ docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume postgresql_data:/bitnami/postgresql \
bitnami/postgresql:latest
```
```console
docker volume create --name postgresql_data
docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume postgresql_data:/bitnami/postgresql \
bitnami/postgresql:latest
```
3. Create a volume for Redis(R) persistence and create a Redis(R) container
```console
$ docker volume create --name redis_data
$ docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume redis_data:/bitnami \
bitnami/redis:latest
```
```console
docker volume create --name redis_data
docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume redis_data:/bitnami \
bitnami/redis:latest
```
4. Launch the Apache Airflow Worker web container
4. Launch the {{ .Name }} web container
```console
$ docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
```console
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
5. Launch the Apache Airflow Worker scheduler container
5. Launch the {{ .Name }} scheduler container
```console
$ docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
```console
docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
6. Launch the Apache Airflow Worker worker container
6. Launch the {{ .Name }} worker container
```console
$ docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_QUEUE=new_queue \
--net airflow-tier \
bitnami/airflow-worker:latest
```
```console
docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_QUEUE=new_queue \
--net airflow-tier \
bitnami/airflow-worker:latest
```
Access your application at `http://your-ip:8080`
Access your application at `http://your-ip:8080`
### Persisting your application
@ -207,78 +207,78 @@ services:
1. Create a network (if it does not exist)
```console
$ docker network create airflow-tier
```
```console
docker network create airflow-tier
```
2. Create the PostgreSQL container with host volumes
```console
$ docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume /path/to/postgresql-persistence:/bitnami \
bitnami/postgresql:latest
```
```console
docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume /path/to/postgresql-persistence:/bitnami \
bitnami/postgresql:latest
```
3. Create the Redis(R) container with host volumes
```console
$ docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume /path/to/redis-persistence:/bitnami \
bitnami/redis:latest
```
```console
docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume /path/to/redis-persistence:/bitnami \
bitnami/redis:latest
```
4. Create the Airflow container
```console
$ docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
```console
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
5. Create the Airflow Scheduler container
```console
$ docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
```console
docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
6. Create the Airflow Worker container
```console
$ docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
--net airflow-tier \
bitnami/airflow-worker:latest
```
```console
docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
--net airflow-tier \
bitnami/airflow-worker:latest
```
## Configuration
@ -290,30 +290,30 @@ This container supports the installation of additional python modules at start-u
The Airflow Worker instance can be customized by specifying environment variables on the first run. The following environment values are provided to customize Airflow Worker:
###### Airflow Worker configuration
#### Airflow Worker configuration
- `AIRFLOW_EXECUTOR`: Airflow Worker executor. Default: **SequentialExecutor**
- `AIRFLOW_FERNET_KEY`: Airflow Worker Fernet key. No defaults.
- `AIRFLOW_SECRET_KEY`: Airflow Worker Secret key. No defaults.
- `AIRFLOW_WEBSERVER_HOST`: Airflow Worker webserver host. Default: **airflow**
- `AIRFLOW_WEBSERVER_PORT_NUMBER`: Airflow Worker webserver port. Default: **8080**
- `AIRFLOW_HOSTNAME_CALLABLE`: Method to obtain the hostname. No defaults.
- `AIRFLOW_QUEUE`: A queue for the worker to pull tasks from. No defaults.
* `AIRFLOW_EXECUTOR`: Airflow Worker executor. Default: **SequentialExecutor**
* `AIRFLOW_FERNET_KEY`: Airflow Worker Fernet key. No defaults.
* `AIRFLOW_SECRET_KEY`: Airflow Worker Secret key. No defaults.
* `AIRFLOW_WEBSERVER_HOST`: Airflow Worker webserver host. Default: **airflow**
* `AIRFLOW_WEBSERVER_PORT_NUMBER`: Airflow Worker webserver port. Default: **8080**
* `AIRFLOW_HOSTNAME_CALLABLE`: Method to obtain the hostname. No defaults.
* `AIRFLOW_QUEUE`: A queue for the worker to pull tasks from. No defaults.
###### Use an existing database
#### Use an existing database
- `AIRFLOW_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
- `AIRFLOW_DATABASE_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
- `AIRFLOW_DATABASE_NAME`: Database name that Airflow Worker will use to connect with the database. Default: **bitnami_airflow**
- `AIRFLOW_DATABASE_USERNAME`: Database user that Airflow Worker will use to connect with the database. Default: **bn_airflow**
- `AIRFLOW_DATABASE_PASSWORD`: Database password that Airflow Worker will use to connect with the database. No defaults.
- `AIRFLOW_DATABASE_USE_SSL`: Set to yes if the database uses SSL. Default: **no**
- `AIRFLOW_REDIS_USE_SSL`: Set to yes if Redis(R) uses SSL. Default: **no**
- `REDIS_HOST`: Hostname for Redis(R) server. Default: **redis**
- `REDIS_PORT_NUMBER`: Port used by Redis(R) server. Default: **6379**
- `REDIS_USER`: User that Airflow Worker will use to connect with Redis(R). No defaults.
- `REDIS_PASSWORD`: Password that Airflow Worker will use to connect with Redis(R). No defaults.
- `REDIS_DATABASE`: Database number for Redis(R) server. Default: **1**
* `AIRFLOW_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
* `AIRFLOW_DATABASE_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
* `AIRFLOW_DATABASE_NAME`: Database name that Airflow Worker will use to connect with the database. Default: **bitnami_airflow**
* `AIRFLOW_DATABASE_USERNAME`: Database user that Airflow Worker will use to connect with the database. Default: **bn_airflow**
* `AIRFLOW_DATABASE_PASSWORD`: Database password that Airflow Worker will use to connect with the database. No defaults.
* `AIRFLOW_DATABASE_USE_SSL`: Set to yes if the database uses SSL. Default: **no**
* `AIRFLOW_REDIS_USE_SSL`: Set to yes if Redis(R) uses SSL. Default: **no**
* `REDIS_HOST`: Hostname for Redis(R) server. Default: **redis**
* `REDIS_PORT_NUMBER`: Port used by Redis(R) server. Default: **6379**
* `REDIS_USER`: User that Airflow Worker will use to connect with Redis(R). No defaults.
* `REDIS_PASSWORD`: Password that Airflow Worker will use to connect with Redis(R). No defaults.
* `REDIS_DATABASE`: Database number for Redis(R) server. Default: **1**
> In addition to the previous environment variables, all the parameters from the configuration file can be overwritten by using environment variables with this format: `AIRFLOW__{SECTION}__{KEY}`. Note the double underscores.
@ -340,7 +340,7 @@ services:
#### Specifying Environment variables on the Docker command line
```console
$ docker run -d --name airflow -p 8080:8080 \
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
@ -357,8 +357,8 @@ $ docker run -d --name airflow -p 8080:8080 \
### 1.10.15-debian-10-r18 and 2.0.1-debian-10-r51
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
## Contributing

370
bitnami/airflow/README.md
View File

@ -13,8 +13,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
### Docker Compose
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow/docker-compose.yml
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow/docker-compose.yml
docker-compose up
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@ -49,8 +49,8 @@ Airflow requires access to a PostgreSQL database to store information. We will u
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/airflow/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/airflow/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -59,84 +59,84 @@ If you want to run the application manually instead of using `docker-compose`, t
1. Create a network
```console
$ docker network create airflow-tier
```
```console
docker network create airflow-tier
```
2. Create a volume for PostgreSQL persistence and create a PostgreSQL container
```console
$ docker volume create --name postgresql_data
$ docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume postgresql_data:/bitnami/postgresql \
bitnami/postgresql:latest
```
```console
docker volume create --name postgresql_data
docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume postgresql_data:/bitnami/postgresql \
bitnami/postgresql:latest
```
3. Create a volume for Redis(R) persistence and create a Redis(R) container
```console
$ docker volume create --name redis_data
$ docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume redis_data:/bitnami \
bitnami/redis:latest
```
```console
docker volume create --name redis_data
docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume redis_data:/bitnami \
bitnami/redis:latest
```
4. Launch the Apache Airflow web container
4. Launch the {{ .Name }} web container
```console
$ docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
```console
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
5. Launch the Apache Airflow scheduler container
5. Launch the {{ .Name }} scheduler container
```console
$ docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
```console
docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
6. Launch the Apache Airflow worker container
6. Launch the {{ .Name }} worker container
```console
$ docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-worker:latest
```
```console
docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-worker:latest
```
Access your application at `http://your-ip:8080`
Access your application at `http://your-ip:8080`
### Persisting your application
@ -207,80 +207,80 @@ services:
1. Create a network (if it does not exist)
```console
$ docker network create airflow-tier
```
```console
docker network create airflow-tier
```
2. Create the PostgreSQL container with host volumes
```console
$ docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume /path/to/postgresql-persistence:/bitnami \
bitnami/postgresql:latest
```
```console
docker run -d --name postgresql \
-e POSTGRESQL_USERNAME=bn_airflow \
-e POSTGRESQL_PASSWORD=bitnami1 \
-e POSTGRESQL_DATABASE=bitnami_airflow \
--net airflow-tier \
--volume /path/to/postgresql-persistence:/bitnami \
bitnami/postgresql:latest
```
3. Create the Redis(R) container with host volumes
```console
$ docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume /path/to/redis-persistence:/bitnami \
bitnami/redis:latest
```
```console
docker run -d --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
--net airflow-tier \
--volume /path/to/redis-persistence:/bitnami \
bitnami/redis:latest
```
4. Create the Airflow container
```console
$ docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
```console
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_PASSWORD=bitnami123 \
-e AIRFLOW_USERNAME=user \
-e AIRFLOW_EMAIL=user@example.com \
--net airflow-tier \
bitnami/airflow:latest
```
5. Create the Airflow Scheduler container
```console
$ docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
```console
docker run -d --name airflow-scheduler \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_LOAD_EXAMPLES=yes \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-scheduler:latest
```
6. Create the Airflow Worker container
```console
$ docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-worker:latest
```
```console
docker run -d --name airflow-worker \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
-e AIRFLOW_DATABASE_NAME=bitnami_airflow \
-e AIRFLOW_DATABASE_USERNAME=bn_airflow \
-e AIRFLOW_DATABASE_PASSWORD=bitnami1 \
-e AIRFLOW_WEBSERVER_HOST=airflow \
--net airflow-tier \
bitnami/airflow-worker:latest
```
## Configuration
@ -296,60 +296,60 @@ This container supports the installation of additional python modules at start-u
The Airflow instance can be customized by specifying environment variables on the first run. The following environment values are provided to customize Airflow:
###### User configuration
#### User configuration
- `AIRFLOW_USERNAME`: Airflow application username. Default: **user**
- `AIRFLOW_PASSWORD`: Airflow application password. Default: **bitnami**
- `AIRFLOW_EMAIL`: Airflow application email. Default: **user@example.com**
* `AIRFLOW_USERNAME`: Airflow application username. Default: **user**
* `AIRFLOW_PASSWORD`: Airflow application password. Default: **bitnami**
* `AIRFLOW_EMAIL`: Airflow application email. Default: **user@example.com**
###### Airflow configuration
#### Airflow configuration
- `AIRFLOW_EXECUTOR`: Airflow executor. Default: **SequentialExecutor**
- `AIRFLOW_FERNET_KEY`: Airflow Fernet key. No defaults.
- `AIRFLOW_SECRET_KEY`: Airflow Secret key. No defaults.
- `AIRFLOW_WEBSERVER_HOST`: Airflow webserver host. Default: **127.0.0.1**
- `AIRFLOW_WEBSERVER_PORT_NUMBER`: Airflow webserver port. Default: **8080**
- `AIRFLOW_LOAD_EXAMPLES`: To load example tasks into the application. Default: **yes**
- `AIRFLOW_BASE_URL`: Airflow webserver base URL. No defaults.
- `AIRFLOW_HOSTNAME_CALLABLE`: Method to obtain the hostname. No defaults.
- `AIRFLOW_POOL_NAME`: Pool name. No defaults.
- `AIRFLOW_POOL_SIZE`: Pool size, required with `AIRFLOW_POOL_NAME`. No defaults.
- `AIRFLOW_POOL_DESC`: Pool description, required with `AIRFLOW_POOL_NAME`. No defaults.
* `AIRFLOW_EXECUTOR`: Airflow executor. Default: **SequentialExecutor**
* `AIRFLOW_FERNET_KEY`: Airflow Fernet key. No defaults.
* `AIRFLOW_SECRET_KEY`: Airflow Secret key. No defaults.
* `AIRFLOW_WEBSERVER_HOST`: Airflow webserver host. Default: **127.0.0.1**
* `AIRFLOW_WEBSERVER_PORT_NUMBER`: Airflow webserver port. Default: **8080**
* `AIRFLOW_LOAD_EXAMPLES`: To load example tasks into the application. Default: **yes**
* `AIRFLOW_BASE_URL`: Airflow webserver base URL. No defaults.
* `AIRFLOW_HOSTNAME_CALLABLE`: Method to obtain the hostname. No defaults.
* `AIRFLOW_POOL_NAME`: Pool name. No defaults.
* `AIRFLOW_POOL_SIZE`: Pool size, required with `AIRFLOW_POOL_NAME`. No defaults.
* `AIRFLOW_POOL_DESC`: Pool description, required with `AIRFLOW_POOL_NAME`. No defaults.
###### Use an existing database
#### Use an existing database
- `AIRFLOW_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
- `AIRFLOW_DATABASE_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
- `AIRFLOW_DATABASE_NAME`: Database name that Airflow will use to connect with the database. Default: **bitnami_airflow**
- `AIRFLOW_DATABASE_USERNAME`: Database user that Airflow will use to connect with the database. Default: **bn_airflow**
- `AIRFLOW_DATABASE_PASSWORD`: Database password that Airflow will use to connect with the database. No defaults.
- `AIRFLOW_DATABASE_USE_SSL`: Set to yes if the database is using SSL. Default: **no**
- `AIRFLOW_REDIS_USE_SSL`: Set to yes if Redis(R) uses SSL. Default: **no**
- `REDIS_HOST`: Hostname for Redis(R) server. Default: **redis**
- `REDIS_PORT_NUMBER`: Port used by Redis(R) server. Default: **6379**
- `REDIS_USER`: User that Airflow will use to connect with Redis(R). No defaults.
- `REDIS_PASSWORD`: Password that Airflow will use to connect with Redis(R). No defaults.
- `REDIS_DATABASE`: Database number for Redis(R) server. Default: **1**
* `AIRFLOW_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
* `AIRFLOW_DATABASE_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
* `AIRFLOW_DATABASE_NAME`: Database name that Airflow will use to connect with the database. Default: **bitnami_airflow**
* `AIRFLOW_DATABASE_USERNAME`: Database user that Airflow will use to connect with the database. Default: **bn_airflow**
* `AIRFLOW_DATABASE_PASSWORD`: Database password that Airflow will use to connect with the database. No defaults.
* `AIRFLOW_DATABASE_USE_SSL`: Set to yes if the database is using SSL. Default: **no**
* `AIRFLOW_REDIS_USE_SSL`: Set to yes if Redis(R) uses SSL. Default: **no**
* `REDIS_HOST`: Hostname for Redis(R) server. Default: **redis**
* `REDIS_PORT_NUMBER`: Port used by Redis(R) server. Default: **6379**
* `REDIS_USER`: User that Airflow will use to connect with Redis(R). No defaults.
* `REDIS_PASSWORD`: Password that Airflow will use to connect with Redis(R). No defaults.
* `REDIS_DATABASE`: Database number for Redis(R) server. Default: **1**
###### Airflow LDAP authentication
#### Airflow LDAP authentication
- `AIRFLOW_LDAP_ENABLE`: Enable LDAP authentication. Default: **no**
- `AIRFLOW_LDAP_URI`: LDAP server URI. No defaults.
- `AIRFLOW_LDAP_SEARCH`: LDAP search base. No defaults.
- `AIRFLOW_LDAP_UID_FIELD`: LDAP field used for uid. No defaults.
- `AIRFLOW_LDAP_BIND_USER`: LDAP user name. No defaults.
- `AIRFLOW_LDAP_BIND_PASSWORD`: LDAP user password. No defaults.
- `AIRFLOW_USER_REGISTRATION`: User self registration. Default: **True**
- `AIRFLOW_USER_REGISTRATION_ROLE`: Role for the created user. No defaults.
- `AIRFLOW_LDAP_ROLES_MAPPING`: Mapping from LDAP DN to a list of Airflow roles. No defaults.
- `AIRFLOW_LDAP_ROLES_SYNC_AT_LOGIN`: Replace ALL the user's roles each login, or only on registration. Default: **True**
- `AIRFLOW_LDAP_USE_TLS`: Use LDAP SSL. Defaults: **False**.
- `AIRFLOW_LDAP_ALLOW_SELF_SIGNED`: Allow self signed certicates in LDAP ssl. Default: **True**
- `AIRFLOW_LDAP_TLS_CA_CERTIFICATE`: File that store the CA for LDAP ssl. No defaults.
* `AIRFLOW_LDAP_ENABLE`: Enable LDAP authentication. Default: **no**
* `AIRFLOW_LDAP_URI`: LDAP server URI. No defaults.
* `AIRFLOW_LDAP_SEARCH`: LDAP search base. No defaults.
* `AIRFLOW_LDAP_UID_FIELD`: LDAP field used for uid. No defaults.
* `AIRFLOW_LDAP_BIND_USER`: LDAP user name. No defaults.
* `AIRFLOW_LDAP_BIND_PASSWORD`: LDAP user password. No defaults.
* `AIRFLOW_USER_REGISTRATION`: User self registration. Default: **True**
* `AIRFLOW_USER_REGISTRATION_ROLE`: Role for the created user. No defaults.
* `AIRFLOW_LDAP_ROLES_MAPPING`: Mapping from LDAP DN to a list of Airflow roles. No defaults.
* `AIRFLOW_LDAP_ROLES_SYNC_AT_LOGIN`: Replace ALL the user's roles each login, or only on registration. Default: **True**
* `AIRFLOW_LDAP_USE_TLS`: Use LDAP SSL. Defaults: **False**.
* `AIRFLOW_LDAP_ALLOW_SELF_SIGNED`: Allow self signed certicates in LDAP ssl. Default: **True**
* `AIRFLOW_LDAP_TLS_CA_CERTIFICATE`: File that store the CA for LDAP ssl. No defaults.
> In addition to the previous environment variables, all the parameters from the configuration file can be overwritten by using environment variables with this format: `AIRFLOW__{SECTION}__{KEY}`. Note the double underscores.
#### Specifying Environment variables using Docker Compose
### Specifying Environment variables using Docker Compose
```yaml
version: '2'
@ -369,10 +369,10 @@ services:
- AIRFLOW_EMAIL=user@example.com
```
#### Specifying Environment variables on the Docker command line
### Specifying Environment variables on the Docker command line
```console
$ docker run -d --name airflow -p 8080:8080 \
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
@ -389,17 +389,17 @@ $ docker run -d --name airflow -p 8080:8080 \
To configure Airflow to send email using SMTP you can set the following environment variables:
- `AIRFLOW__SMTP__SMTP_HOST`: Host for outgoing SMTP email. Default: **localhost**
- `AIRFLOW__SMTP__SMTP_PORT`: Port for outgoing SMTP email. Default: **25**
- `AIRFLOW__SMTP__SMTP_STARTTLS`: To use TLS communication. Default: **True**
- `AIRFLOW__SMTP__SMTP_SSL`: To use SSL communication. Default: **False**
- `AIRFLOW__SMTP__SMTP_USER`: User of SMTP used for authentication (likely email). No defaults.
- `AIRFLOW__SMTP__SMTP_PASSWORD`: Password for SMTP. No defaults.
- `AIRFLOW__SMTP__SMTP_MAIL_FROM`: To modify the "from email address". Default: **airflow@example.com**
* `AIRFLOW__SMTP__SMTP_HOST`: Host for outgoing SMTP email. Default: **localhost**
* `AIRFLOW__SMTP__SMTP_PORT`: Port for outgoing SMTP email. Default: **25**
* `AIRFLOW__SMTP__SMTP_STARTTLS`: To use TLS communication. Default: **True**
* `AIRFLOW__SMTP__SMTP_SSL`: To use SSL communication. Default: **False**
* `AIRFLOW__SMTP__SMTP_USER`: User of SMTP used for authentication (likely email). No defaults.
* `AIRFLOW__SMTP__SMTP_PASSWORD`: Password for SMTP. No defaults.
* `AIRFLOW__SMTP__SMTP_MAIL_FROM`: To modify the "from email address". Default: **airflow@example.com**
This would be an example of SMTP configuration using a GMail account:
* docker-compose (application part):
* docker-compose (application part):
```yaml
airflow:
@ -425,7 +425,7 @@ This would be an example of SMTP configuration using a GMail account:
* For manual execution:
```console
$ docker run -d --name airflow -p 8080:8080 \
docker run -d --name airflow -p 8080:8080 \
-e AIRFLOW_FERNET_KEY=46BKJoQYlPPOexq0OhDZnIlNepKFf87WFwLbfzqDDho= \
-e AIRFLOW_SECRET_KEY=a25mQ1FHTUh3MnFRSk5KMEIyVVU2YmN0VGRyYTVXY08= \
-e AIRFLOW_EXECUTOR=CeleryExecutor \
@ -446,8 +446,8 @@ $ docker run -d --name airflow -p 8080:8080 \
### 1.10.15-debian-10-r17 and 2.0.1-debian-10-r50
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
## Contributing

37
bitnami/alertmanager/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name alertmanager bitnami/alertmanager:latest
docker run --name alertmanager bitnami/alertmanager:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Alertmanager Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/alertmanager).
```console
$ docker pull bitnami/alertmanager:latest
docker pull bitnami/alertmanager:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/alertmanager/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/alertmanager:[TAG]
docker pull bitnami/alertmanager:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -66,7 +66,7 @@ For persistence you should mount a volume at the `/opt/bitnami/data` path. The a
To avoid inadvertent removal of this volume you can [mount host directories as data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/). Alternatively you can make use of volume plugins to host the volume data.
```console
$ docker run -v /path/to/alertmanager-persistence:/opt/bitnami/data bitnami/alertmanager:latest
docker run -v /path/to/alertmanager-persistence:/opt/bitnami/data bitnami/alertmanager:latest
```
> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
@ -82,7 +82,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create alertmanager-network --driver bridge
docker network create alertmanager-network --driver bridge
```
#### Step 2: Launch the Alertmanager container within your network
@ -90,7 +90,7 @@ $ docker network create alertmanager-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `alertmanager-network` network.
```console
$ docker run --name alertmanager-node1 --network alertmanager-network bitnami/alertmanager:latest
docker run --name alertmanager-node1 --network alertmanager-network bitnami/alertmanager:latest
```
#### Step 3: Run another containers
@ -102,7 +102,7 @@ We can launch another containers using the same flag (`--network NETWORK`) in th
The configuration can easily be setup by mounting your own configuration file on the directory `/opt/bitnami/alertmanager/conf/`:
```console
$ docker run --name alertmanager -v /path/to/config.yml:/opt/bitnami/alertmanager/conf/config.yml bitnami/alertmanager:latest
docker run --name alertmanager -v /path/to/config.yml:/opt/bitnami/alertmanager/conf/config.yml bitnami/alertmanager:latest
```
After that, your configuration will be taken into account in the server's behaviour.
@ -130,7 +130,7 @@ Configuration is yaml based. The full documentation of the configuration can be
The Bitnami alertmanager Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs alertmanager
docker logs alertmanager
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -144,7 +144,7 @@ Bitnami provides up-to-date versions of alertmanager, including security patches
#### Step 1: Get the updated image
```console
$ docker pull bitnami/alertmanager:latest
docker pull bitnami/alertmanager:latest
```
#### Step 2: Stop and backup the currently running container
@ -152,13 +152,13 @@ $ docker pull bitnami/alertmanager:latest
Stop the currently running container using the command
```console
$ docker stop alertmanager
docker stop alertmanager
```
Next, take a snapshot of the persistent volume `/path/to/alertmanager-persistence` using:
```console
$ rsync -a /path/to/alertmanager-persistence /path/to/alertmanager-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/alertmanager-persistence /path/to/alertmanager-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the database state should the upgrade fail.
@ -166,15 +166,15 @@ You can use this snapshot to restore the database state should the upgrade fail.
#### Step 3: Remove the currently running container
```console
$ docker rm -v alertmanager
docker rm -v alertmanager
```
#### Step 4: Run the new image
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
Re-create your container from the new image, restoring your backup if necessary.
```console
$ docker run --name alertmanager bitnami/alertmanager:latest
docker run --name alertmanager bitnami/alertmanager:latest
```
## Contributing
@ -186,13 +186,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

28
bitnami/apache-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name apache-exporter bitnami/apache-exporter:latest
docker run --name apache-exporter bitnami/apache-exporter:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Apache Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/apache-exporter).
```console
$ docker pull bitnami/apache-exporter:latest
docker pull bitnami/apache-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/apache-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/apache-exporter:[TAG]
docker pull bitnami/apache-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create apache-exporter-network --driver bridge
docker network create apache-exporter-network --driver bridge
```
#### Step 2: Launch the apache-exporter container within your network
@ -76,7 +76,7 @@ $ docker network create apache-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `apache-exporter-network` network.
```console
$ docker run --name apache-exporter-node1 --network apache-exporter-network bitnami/apache-exporter:latest
docker run --name apache-exporter-node1 --network apache-exporter-network bitnami/apache-exporter:latest
```
#### Step 3: Run another containers
@ -92,7 +92,7 @@ Find all the configuration flags in [the Apache Exporter official documentation]
The Bitnami Apache Exporter Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs apache-exporter
docker logs apache-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -106,7 +106,7 @@ Bitnami provides up-to-date versions of Apache Exporter, including security patc
#### Step 1: Get the updated image
```console
$ docker pull bitnami/apache-exporter:latest
docker pull bitnami/apache-exporter:latest
```
#### Step 2: Stop the running container
@ -114,13 +114,13 @@ $ docker pull bitnami/apache-exporter:latest
Stop the currently running container using the command
```console
$ docker stop apache-exporter
docker stop apache-exporter
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v apache-exporter
docker rm -v apache-exporter
```
#### Step 4: Run the new image
@ -128,7 +128,7 @@ $ docker rm -v apache-exporter
Re-create your container from the new image.
```console
$ docker run --name apache-exporter bitnami/apache-exporter:latest
docker run --name apache-exporter bitnami/apache-exporter:latest
```
## Contributing
@ -147,7 +147,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

128
bitnami/apache/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name apache bitnami/apache:latest
docker run --name apache bitnami/apache:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/apache/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/apache/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
You can find the available configuration options in the [Environment Variables](#environment-variables) section.
@ -55,21 +55,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Apache Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/apache).
```console
$ docker pull bitnami/apache:latest
docker pull bitnami/apache:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/apache/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/apache:[TAG]
docker pull bitnami/apache:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Hosting a static website
@ -77,7 +77,7 @@ $ docker build -t bitnami/APP:latest .
The `/app` path is configured as the Apache [DocumentRoot](https://httpd.apache.org/docs/2.4/urlmapping.html#documentroot). Content mounted here is served by the default catch-all virtual host.
```console
$ docker run --name apache -v /path/to/app:/app bitnami/apache:latest
docker run --name apache -v /path/to/app:/app bitnami/apache:latest
```
or using Docker Compose:
@ -102,13 +102,13 @@ services:
To access your web server from your host machine you can ask Docker to map a random port on your host to ports `8080` and `8443` exposed in the container.
```console
$ docker run --name apache -P bitnami/apache:latest
docker run --name apache -P bitnami/apache:latest
```
Run `docker port` to determine the random ports Docker assigned.
```console
$ docker port apache
docker port apache
8443/tcp -> 0.0.0.0:32768
8080/tcp -> 0.0.0.0:32769
```
@ -116,7 +116,7 @@ $ docker port apache
You can also manually specify the ports you want forwarded from your host to the container.
```console
$ docker run -p 8080:8080 -p 8443:8443 bitnami/apache:latest
docker run -p 8080:8080 -p 8443:8443 bitnami/apache:latest
```
Access your web server in the browser by navigating to `http://localhost:8080/`.
@ -127,7 +127,7 @@ Access your web server in the browser by navigating to `http://localhost:8080/`.
When you start the Apache image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
* For docker-compose add the variable name and value under the application section:
* For docker-compose add the variable name and value under the application section:
```yaml
version: '2'
@ -142,10 +142,10 @@ services:
- APACHE_HTTP_PORT_NUMBER=8081
```
* For manual execution add a `-e` option with each variable and value:
* For manual execution add a `-e` option with each variable and value:
```console
$ docker run -d --name apache -p 80:8081 -p 443:443 \
docker run -d --name apache -p 80:8081 -p 443:443 \
--network apache-tier \
--e APACHE_HTTP_PORT_NUMBER=8081 \
bitnami/apache:latest
@ -153,8 +153,8 @@ $ docker run -d --name apache -p 80:8081 -p 443:443 \
Available variables:
- `APACHE_HTTP_PORT_NUMBER`: Port used by Apache for HTTP. Default: **8080**
- `APACHE_HTTPS_PORT_NUMBER`: Port used by Apache for HTTPS. Default: **8443**
* `APACHE_HTTP_PORT_NUMBER`: Port used by Apache for HTTP. Default: **8080**
* `APACHE_HTTPS_PORT_NUMBER`: Port used by Apache for HTTPS. Default: **8443**
### Adding custom virtual hosts
@ -162,7 +162,7 @@ The default `httpd.conf` includes virtual hosts placed in `/opt/bitnami/apache/c
For example, in order add a vhost for `www.example.com`:
#### Step 1: Write your `my_vhost.conf` file with the following content.
#### Step 1: Write your `my_vhost.conf` file with the following content
```apache
<VirtualHost *:8080>
@ -176,10 +176,10 @@ For example, in order add a vhost for `www.example.com`:
</VirtualHost>
```
#### Step 2: Mount the configuration as a volume.
#### Step 2: Mount the configuration as a volume
```console
$ docker run --name apache \
docker run --name apache \
-v /path/to/my_vhost.conf:/vhosts/my_vhost.conf:ro \
bitnami/apache:latest
```
@ -210,9 +210,9 @@ This container comes with SSL support already pre-configured and with a dummy ce
In your local computer, create a folder called `certs` and put your certificates files. Make sure you rename both files to `server.crt` and `server.key` respectively:
```console
$ mkdir /path/to/apache-certs -p
$ cp /path/to/certfile.crt /path/to/apache-certs/server.crt
$ cp /path/to/keyfile.key /path/to/apache-certs/server.key
mkdir /path/to/apache-certs -p
cp /path/to/certfile.crt /path/to/apache-certs/server.crt
cp /path/to/keyfile.key /path/to/apache-certs/server.key
```
#### Step 2: Run the Apache image
@ -220,7 +220,7 @@ $ cp /path/to/keyfile.key /path/to/apache-certs/server.key
Run the Apache image, mounting the certificates directory from your host.
```console
$ docker run --name apache \
docker run --name apache \
-v /path/to/apache-certs:/certs \
bitnami/apache:latest
```
@ -245,7 +245,7 @@ services:
The image looks for configurations in `/opt/bitnami/apache/conf`. You can overwrite the `httpd.conf` file using your own custom configuration file.
```console
$ docker run --name apache \
docker run --name apache \
-v /path/to/httpd.conf:/opt/bitnami/apache/conf/httpd.conf \
bitnami/apache:latest
```
@ -271,20 +271,20 @@ Apache can be used to reverse proxy to other containers using Docker's linking s
**Further Reading:**
- [mod_proxy documentation](http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#forwardreverse)
* [mod_proxy documentation](http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#forwardreverse)
## Logging
The Bitnami Apache Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs apache
docker logs apache
```
or using Docker Compose:
```console
$ docker-compose logs apache
docker-compose logs apache
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -297,10 +297,10 @@ The Bitnami Apache Docker image is designed to be extended so it can be used as
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
- [Adding custom virtual hosts](#adding-custom-virtual-hosts).
- [Replacing the 'httpd.conf' file](#full-configuration).
- [Using custom SSL certificates](#using-custom-ssl-certificates).
* Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
* [Adding custom virtual hosts](#adding-custom-virtual-hosts).
* [Replacing the 'httpd.conf' file](#full-configuration).
* [Using custom SSL certificates](#using-custom-ssl-certificates).
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
@ -312,10 +312,10 @@ FROM bitnami/apache
Here is an example of extending the image with the following modifications:
- Install the `vim` editor
- Modify the Apache configuration file
- Modify the ports used by Apache
- Change the user that runs the container
* Install the `vim` editor
* Modify the Apache configuration file
* Modify the ports used by Apache
* Change the user that runs the container
```Dockerfile
FROM bitnami/apache
@ -341,9 +341,9 @@ USER 1002
Based on the extended image, you can use a Docker Compose file like the one below to add other features:
- Add a custom virtual host
- Add custom certificates
- Clone your web application and serve it through Apache
* Add a custom virtual host
* Add custom certificates
* Clone your web application and serve it through Apache
```yaml
version: '2'
@ -382,7 +382,7 @@ Bitnami provides up-to-date versions of Apache, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/apache:latest
docker pull bitnami/apache:latest
```
or if you're using Docker Compose, update the value of the image property to
@ -393,19 +393,19 @@ or if you're using Docker Compose, update the value of the image property to
Stop the currently running container using the command
```console
$ docker stop apache
docker stop apache
```
or using Docker Compose:
```console
$ docker-compose stop apache
docker-compose stop apache
```
Next, take a snapshot of the persistent volume `/path/to/apache-persistence` using:
```console
$ rsync -a /path/to/apache-persistence /path/to/apache-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/apache-persistence /path/to/apache-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the database state should the upgrade fail.
@ -413,13 +413,13 @@ You can use this snapshot to restore the database state should the upgrade fail.
#### Step 3: Remove the currently running container
```console
$ docker rm -v apache
docker rm -v apache
```
or using Docker Compose:
```console
$ docker-compose rm -v apache
docker-compose rm -v apache
```
#### Step 4: Run the new image
@ -427,69 +427,69 @@ $ docker-compose rm -v apache
Re-create your container from the new image.
```console
$ docker run --name apache bitnami/apache:latest
docker run --name apache bitnami/apache:latest
```
or using Docker Compose:
```console
$ docker-compose up apache
docker-compose up apache
```
## Useful Links
- [Create An AMP Development Environment With Bitnami Containers
* [Create An AMP Development Environment With Bitnami Containers
](https://docs.bitnami.com/containers/how-to/create-amp-environment-containers/)
## Notable Changes
### 2.4.54-debian-11-r22
- Removed the [Apache PageSpeed Module (`mod_pagespeed`)](https://developers.google.com/speed/pagespeed/module).
* Removed the [Apache PageSpeed Module (`mod_pagespeed`)](https://developers.google.com/speed/pagespeed/module).
### 2.4.43-debian-10-r66
- Included [Apache PageSpeed Module (`mod_pagespeed`)](https://developers.google.com/speed/pagespeed/module). It is disabled by default. To enable it, uncomment the following lines in `httpd.conf`:
* Included [Apache PageSpeed Module (`mod_pagespeed`)](https://developers.google.com/speed/pagespeed/module). It is disabled by default. To enable it, uncomment the following lines in `httpd.conf`:
```
```text
##Include conf/pagespeed.conf
##Include conf/pagespeed_libraries.conf
```
- Included [ModSecurity v2](https://github.com/SpiderLabs/ModSecurity). It is disabled by default. To enable it, mount and enable your custom ModSecurity rules for the virtual hosts, and uncomment the following line in `httpd.conf`:
* Included [ModSecurity v2](https://github.com/SpiderLabs/ModSecurity). It is disabled by default. To enable it, mount and enable your custom ModSecurity rules for the virtual hosts, and uncomment the following line in `httpd.conf`:
```
```text
##LoadModule security2_module modules/mod_security2.so
```
- Included [ModSecurity v3](https://github.com/SpiderLabs/ModSecurity) and [ModSecurity v3 Apache Connector (`mod_security3`)](https://github.com/SpiderLabs/ModSecurity-apache). It is disabled by default. To enable it, mount and enable your custom ModSecurity rules for the virtual hosts, and uncomment the following line in `httpd.conf`:
* Included [ModSecurity v3](https://github.com/SpiderLabs/ModSecurity) and [ModSecurity v3 Apache Connector (`mod_security3`)](https://github.com/SpiderLabs/ModSecurity-apache). It is disabled by default. To enable it, mount and enable your custom ModSecurity rules for the virtual hosts, and uncomment the following line in `httpd.conf`:
```
```text
##LoadModule security3_module modules/mod_security3.so
```
### 2.4.41-debian-9-r40 and 2.4.41-ol-7-r42
- Decrease the size of the container. The configuration logic is now based on Bash scripts in the `rootfs/` folder.
* Decrease the size of the container. The configuration logic is now based on Bash scripts in the `rootfs/` folder.
### 2.4.39-debian-9-r40 and 2.4.39-ol-7-r50
- This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
- The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
- Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`. Find an example at [Using custom SSL certificates](#using-custom-ssl-certificates).
* This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
* The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
* Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`. Find an example at [Using custom SSL certificates](#using-custom-ssl-certificates).
### 2.4.34-r8
- The Apache container has been migrated to a non-root user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `apache` user. From now on, both the container and the Apache daemon run as user `1001`. As a consequence, the HTTP/HTTPS ports exposed by the container are now 8080/8443 instead of 80/443. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
* The Apache container has been migrated to a non-root user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `apache` user. From now on, both the container and the Apache daemon run as user `1001`. As a consequence, the HTTP/HTTPS ports exposed by the container are now 8080/8443 instead of 80/443. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
### 2.4.18-r0
- The configuration volume has been moved to `/bitnami/apache`. Now you only need to mount a single volume at `/bitnami/apache` for persisting configuration. `/app` is still used for serving content by the default virtual host.
- The logs are always sent to the `stdout` and are no longer collected in the volume.
* The configuration volume has been moved to `/bitnami/apache`. Now you only need to mount a single volume at `/bitnami/apache` for persisting configuration. `/app` is still used for serving content by the default virtual host.
* The logs are always sent to the `stdout` and are no longer collected in the volume.
### 2.4.12-4-r01
- The `/app` directory is no longer exported as a volume. This caused problems when building on top of the image, since changes in the volume are not persisted between Dockerfile `RUN` instructions. To keep the previous behavior (so that you can mount the volume in another container), create the container with the `-v /app` option.
* The `/app` directory is no longer exported as a volume. This caused problems when building on top of the image, since changes in the volume are not persisted between Dockerfile `RUN` instructions. To keep the previous behavior (so that you can mount the volume in another container), create the container with the `-v /app` option.
## Contributing
@ -507,7 +507,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

82
bitnami/appsmith/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name appsmith bitnami/appsmith
docker run -it --name appsmith bitnami/appsmith
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/appsmith/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/appsmith/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Appsmith Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/appsmith).
```console
$ docker pull bitnami/appsmith:latest
docker pull bitnami/appsmith:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/appsmith/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/appsmith:[TAG]
docker pull bitnami/appsmith:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -69,7 +69,7 @@ Bitnami provides up-to-date versions of Appsmith, including security patches, so
#### Step 1: Get the updated image
```console
$ docker pull bitnami/appsmith:latest
docker pull bitnami/appsmith:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/appsmith:latest`.
@ -77,13 +77,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v appsmith
docker rm -v appsmith
```
or using Docker Compose:
```console
$ docker-compose rm -v appsmith
docker-compose rm -v appsmith
```
#### Step 3: Run the new image
@ -91,13 +91,13 @@ $ docker-compose rm -v appsmith
Re-create your container from the new image.
```console
$ docker run --name appsmith bitnami/appsmith:latest
docker run --name appsmith bitnami/appsmith:latest
```
or using Docker Compose:
```console
$ docker-compose up appsmith
docker-compose up appsmith
```
## Configuration
@ -106,7 +106,7 @@ $ docker-compose up appsmith
When you start the Appsmith image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. Please note that some variables are only considered when the container is started for the first time. If you want to add a new environment variable:
- For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/appsmith/docker-compose.yml) file present in this repository:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/appsmith/docker-compose.yml) file present in this repository:
```yaml
appsmith-api:
@ -116,10 +116,10 @@ When you start the Appsmith image, you can adjust the configuration of the insta
...
```
- For manual execution add a `--env` option with each variable and value:
* For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name appsmith-api -p 80:8080 -p 443:8443 \
docker run -d --name appsmith-api -p 80:8080 -p 443:8443 \
--env APPSMITH_PASSWORD=my_password \
--env APPSMITH_MODE=backend \
--network appsmith-tier \
@ -133,44 +133,44 @@ Available environment variables:
Appsmith supports three running modes:
- Backend: The Appsmith API. It is the essential functional element of Appsmith.
- RTS: Necessary for performing real-time editing of the applications created by Appsmith.
- Client: Contains the UI of Appsmith. This is the main entrypoint for users.
* Backend: The Appsmith API. It is the essential functional element of Appsmith.
* RTS: Necessary for performing real-time editing of the applications created by Appsmith.
* Client: Contains the UI of Appsmith. This is the main entrypoint for users.
The running mode is defined via the `APPSMITH_MODE` environment variable. The possible values are `backend`, `rts` and `client`.
##### User and Site configuration
- `APPSMITH_UI_HTTP_PORT`: Port used by the Client for HTTP. Default: **8080**
- `APPSMITH_USERNAME`: Appsmith application username. Default: **user**
- `APPSMITH_PASSWORD`: Appsmith application password. Default: **bitnami**
- `APPSMITH_EMAIL`: Appsmith application email. Default: **user@example.com**
- `APPSMITH_DATA_TO_PERSIST`: Space separated list of files and directories to persist. Use a space to persist no data: `" "`. Default: **"docker.env"**
* `APPSMITH_UI_HTTP_PORT`: Port used by the Client for HTTP. Default: **8080**
* `APPSMITH_USERNAME`: Appsmith application username. Default: **user**
* `APPSMITH_PASSWORD`: Appsmith application password. Default: **bitnami**
* `APPSMITH_EMAIL`: Appsmith application email. Default: **user@example.com**
* `APPSMITH_DATA_TO_PERSIST`: Space separated list of files and directories to persist. Use a space to persist no data: `" "`. Default: **"docker.env"**
##### Salt and keys configuration
Authentication unique keys and salts. Specify these values to prevent cookies from being invalidated when creating a new container or when using multiple containers to serve the same Appsmith instance. By default these values are generated randomly:
- `APPSMITH_ENCRYPTION_PASSWORD`: Database encryption password. Default: **bitnami**.
- `APPSMITH_ENCRYPTION_SALT`: Database encryption salt. Default: **bitnami**.
* `APPSMITH_ENCRYPTION_PASSWORD`: Database encryption password. Default: **bitnami**.
* `APPSMITH_ENCRYPTION_SALT`: Database encryption salt. Default: **bitnami**.
##### Database connection configuration
- `APPSMITH_DATABASE_HOST`: Hostname for the MongoDB(TM) servers (comma separated). Default: **mongodb**
- `APPSMITH_DATABASE_PORT_NUMBER`: Port used by the MongoDB(TM) server. Default: **27017**
- `APPSMITH_DATABASE_NAME`: Database name that Appsmith will use to connect with the database. Default: **bitnami_appsmith**
- `APPSMITH_DATABASE_USER`: Database user that Appsmith will use to connect with the database. Default: **bn_appsmith**
- `APPSMITH_DATABASE_PASSWORD`: Database password that Appsmith will use to connect with the database. No defaults.
- `APPSMITH_REDIS_HOST`: Hostname for the Redis(TM) server. Default: **redis**
- `APPSMITH_REDIS_PORT_NUMBER`: Port used by the Redis(TM) server. Default: **6379**
- `APPSMITH_REDIS_PASSWORD`: Database password that Appsmith will use to connect with the database. No defaults.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
* `APPSMITH_DATABASE_HOST`: Hostname for the MongoDB(TM) servers (comma separated). Default: **mongodb**
* `APPSMITH_DATABASE_PORT_NUMBER`: Port used by the MongoDB(TM) server. Default: **27017**
* `APPSMITH_DATABASE_NAME`: Database name that Appsmith will use to connect with the database. Default: **bitnami_appsmith**
* `APPSMITH_DATABASE_USER`: Database user that Appsmith will use to connect with the database. Default: **bn_appsmith**
* `APPSMITH_DATABASE_PASSWORD`: Database password that Appsmith will use to connect with the database. No defaults.
* `APPSMITH_REDIS_HOST`: Hostname for the Redis(TM) server. Default: **redis**
* `APPSMITH_REDIS_PORT_NUMBER`: Port used by the Redis(TM) server. Default: **6379**
* `APPSMITH_REDIS_PASSWORD`: Database password that Appsmith will use to connect with the database. No defaults.
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### Connect Appsmith container to an existing database
The Bitnami Appsmith container supports connecting the Appsmith application to an external database. This would be an example of using an external database for Appsmith.
- Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/appsmith/docker-compose.yml) file present in this repository:
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/appsmith/docker-compose.yml) file present in this repository:
```diff
appsmith:
@ -186,10 +186,10 @@ The Bitnami Appsmith container supports connecting the Appsmith application to a
...
```
- For manual execution:
* For manual execution:
```console
$ docker run -d --name appsmith\
docker run -d --name appsmith\
-p 8080:8080 -p 8443:8443 \
--network appsmith-network \
--env APPSMITH_DATABASE_HOST=mongodb_host \
@ -206,13 +206,13 @@ The Bitnami Appsmith container supports connecting the Appsmith application to a
The Bitnami Appsmith Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs wordpress
docker logs wordpress
```
Or using Docker Compose:
```console
$ docker-compose logs wordpress
docker-compose logs wordpress
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -233,7 +233,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/argo-cd/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name argo-cd bitnami/argo-cd
docker run -it --name argo-cd bitnami/argo-cd
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-cd/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-cd/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Argo CD Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/argo-cd).
```console
$ docker pull bitnami/argo-cd:latest
docker pull bitnami/argo-cd:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/argo-cd/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/argo-cd:[TAG]
docker pull bitnami/argo-cd:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -69,7 +69,7 @@ Bitnami provides up-to-date versions of Argo CD, including security patches, soo
#### Step 1: Get the updated image
```console
$ docker pull bitnami/argo-cd:latest
docker pull bitnami/argo-cd:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/argo-cd:latest`.
@ -77,13 +77,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v argo-cd
docker rm -v argo-cd
```
or using Docker Compose:
```console
$ docker-compose rm -v argo-cd
docker-compose rm -v argo-cd
```
#### Step 3: Run the new image
@ -91,13 +91,13 @@ $ docker-compose rm -v argo-cd
Re-create your container from the new image.
```console
$ docker run --name argo-cd bitnami/argo-cd:latest
docker run --name argo-cd bitnami/argo-cd:latest
```
or using Docker Compose:
```console
$ docker-compose up argo-cd
docker-compose up argo-cd
```
## Configuration
@ -107,7 +107,7 @@ $ docker-compose up argo-cd
To run commands inside this container you can use `docker run`, for example to execute `argocd --help` you can follow the example below:
```console
$ docker run --rm --name argo-cd bitnami/argo-cd:latest --help
docker run --rm --name argo-cd bitnami/argo-cd:latest --help
```
Check the [official Argo CD documentation](https://argo-cd.readthedocs.io/en/stable/operator-manual/server-commands/argocd-server/) for the list of the available parameters.
@ -128,7 +128,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/argo-workflow-cli/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name argo-workflow-cli bitnami/argo-workflow-cli
docker run -it --name argo-workflow-cli bitnami/argo-workflow-cli
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-workflow-cli/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-workflow-cli/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -51,21 +51,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Argo Workflows CLI Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/argo-workflow-cli).
```console
$ docker pull bitnami/argo-workflow-cli:latest
docker pull bitnami/argo-workflow-cli:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/argo-workflow-cli/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/argo-workflow-cli:[TAG]
docker pull bitnami/argo-workflow-cli:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -77,7 +77,7 @@ Bitnami provides up-to-date versions of Argo Workflows CLI, including security p
#### Step 1: Get the updated image
```console
$ docker pull bitnami/argo-workflow-cli:latest
docker pull bitnami/argo-workflow-cli:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/argo-workflow-cli:latest`.
@ -85,13 +85,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v argo-workflow-cli
docker rm -v argo-workflow-cli
```
or using Docker Compose:
```console
$ docker-compose rm -v argo-workflow-cli
docker-compose rm -v argo-workflow-cli
```
#### Step 3: Run the new image
@ -99,13 +99,13 @@ $ docker-compose rm -v argo-workflow-cli
Re-create your container from the new image.
```console
$ docker run --name argo-workflow-cli bitnami/argo-workflow-cli:latest
docker run --name argo-workflow-cli bitnami/argo-workflow-cli:latest
```
or using Docker Compose:
```console
$ docker-compose up argo-workflow-cli
docker-compose up argo-workflow-cli
```
## Configuration
@ -115,7 +115,7 @@ $ docker-compose up argo-workflow-cli
To run commands inside this container you can use `docker run`, for example to execute `argocd --help` you can follow the example below:
```console
$ docker run --rm --name argo-workflow-cli bitnami/argo-workflow-cli:latest --help
docker run --rm --name argo-workflow-cli bitnami/argo-workflow-cli:latest --help
```
Check the [official Argo Workflows CLI documentation](https://argoproj.github.io/argo-workflows/cli/) for the list of the available parameters.
@ -136,7 +136,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/argo-workflow-controller/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name argo-workflow-controller bitnami/argo-workflow-controller
docker run -it --name argo-workflow-controller bitnami/argo-workflow-controller
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-workflow-controller/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-workflow-controller/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -51,21 +51,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Argo Workflows Controller Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/argo-workflow-controller).
```console
$ docker pull bitnami/argo-workflow-controller:latest
docker pull bitnami/argo-workflow-controller:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/argo-workflow-controller/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/argo-workflow-controller:[TAG]
docker pull bitnami/argo-workflow-controller:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -77,7 +77,7 @@ Bitnami provides up-to-date versions of Argo Workflows Controller, including sec
#### Step 1: Get the updated image
```console
$ docker pull bitnami/argo-workflow-controller:latest
docker pull bitnami/argo-workflow-controller:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/argo-workflow-controller:latest`.
@ -85,13 +85,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v argo-workflow-controller
docker rm -v argo-workflow-controller
```
or using Docker Compose:
```console
$ docker-compose rm -v argo-workflow-controller
docker-compose rm -v argo-workflow-controller
```
#### Step 3: Run the new image
@ -99,13 +99,13 @@ $ docker-compose rm -v argo-workflow-controller
Re-create your container from the new image.
```console
$ docker run --name argo-workflow-controller bitnami/argo-workflow-controller:latest
docker run --name argo-workflow-controller bitnami/argo-workflow-controller:latest
```
or using Docker Compose:
```console
$ docker-compose up argo-workflow-controller
docker-compose up argo-workflow-controller
```
## Configuration
@ -115,7 +115,7 @@ $ docker-compose up argo-workflow-controller
To run commands inside this container you can use `docker run`, for example to execute `argocd --help` you can follow the example below:
```console
$ docker run --rm --name argo-workflow-controller bitnami/argo-workflow-controller:latest --help
docker run --rm --name argo-workflow-controller bitnami/argo-workflow-controller:latest --help
```
Check the [official Argo Workflows Controller documentation](https://argoproj.github.io/argo-workflows/environment-variables/#controller) for the list of the available parameters.
@ -136,7 +136,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/argo-workflow-exec/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name argo-workflow-exec bitnami/argo-workflow-exec
docker run -it --name argo-workflow-exec bitnami/argo-workflow-exec
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-workflow-exec/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/argo-workflow-exec/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -47,21 +47,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Argo Workflows Executor Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/argo-workflow-exec).
```console
$ docker pull bitnami/argo-workflow-exec:latest
docker pull bitnami/argo-workflow-exec:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/argo-workflow-exec/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/argo-workflow-exec:[TAG]
docker pull bitnami/argo-workflow-exec:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -73,7 +73,7 @@ Bitnami provides up-to-date versions of Argo Workflows Executor, including secur
#### Step 1: Get the updated image
```console
$ docker pull bitnami/argo-workflow-exec:latest
docker pull bitnami/argo-workflow-exec:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/argo-workflow-exec:latest`.
@ -81,13 +81,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v argo-workflow-exec
docker rm -v argo-workflow-exec
```
or using Docker Compose:
```console
$ docker-compose rm -v argo-workflow-exec
docker-compose rm -v argo-workflow-exec
```
#### Step 3: Run the new image
@ -95,13 +95,13 @@ $ docker-compose rm -v argo-workflow-exec
Re-create your container from the new image.
```console
$ docker run --name argo-workflow-exec bitnami/argo-workflow-exec:latest
docker run --name argo-workflow-exec bitnami/argo-workflow-exec:latest
```
or using Docker Compose:
```console
$ docker-compose up argo-workflow-exec
docker-compose up argo-workflow-exec
```
## Configuration
@ -111,7 +111,7 @@ $ docker-compose up argo-workflow-exec
To run commands inside this container you can use `docker run`, for example to execute `argocd --help` you can follow the example below:
```console
$ docker run --rm --name argo-workflow-exec bitnami/argo-workflow-exec:latest --help
docker run --rm --name argo-workflow-exec bitnami/argo-workflow-exec:latest --help
```
Check the [official Argo Workflows Executor documentation](https://argoproj.github.io/argo-workflows/workflow-executors/) for the list of the available parameters.
@ -132,7 +132,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

34
bitnami/aspnet-core/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name aspnet-core bitnami/aspnet-core:latest
docker run --name aspnet-core bitnami/aspnet-core:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/aspnet-core/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/aspnet-core/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami aspnet-core Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/aspnet-core).
```console
$ docker pull bitnami/aspnet-core:latest
docker pull bitnami/aspnet-core:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/aspnet-core/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/aspnet-core:[TAG]
docker pull bitnami/aspnet-core:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -67,7 +67,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/app` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/aspnet-core-persistence:/app \
bitnami/aspnet-core:latest
```
@ -93,7 +93,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create aspnet-core-network --driver bridge
docker network create aspnet-core-network --driver bridge
```
#### Step 2: Launch the aspnet-core container within your network
@ -101,7 +101,7 @@ $ docker network create aspnet-core-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `aspnet-core-network` network.
```console
$ docker run --name aspnet-core-node1 --network aspnet-core-network bitnami/aspnet-core:latest
docker run --name aspnet-core-node1 --network aspnet-core-network bitnami/aspnet-core:latest
```
#### Step 3: Run another containers
@ -113,7 +113,7 @@ We can launch another containers using the same flag (`--network NETWORK`) in th
The Bitnami aspnet-core Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs aspnet-core
docker logs aspnet-core
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -127,7 +127,7 @@ Bitnami provides up-to-date versions of aspnet-core, including security patches,
#### Step 1: Get the updated image
```console
$ docker pull bitnami/aspnet-core:latest
docker pull bitnami/aspnet-core:latest
```
#### Step 2: Stop the running container
@ -135,13 +135,13 @@ $ docker pull bitnami/aspnet-core:latest
Stop the currently running container using the command
```console
$ docker stop aspnet-core
docker stop aspnet-core
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v aspnet-core
docker rm -v aspnet-core
```
#### Step 4: Run the new image
@ -149,7 +149,7 @@ $ docker rm -v aspnet-core
Re-create your container from the new image.
```console
$ docker run --name aspnet-core bitnami/aspnet-core:latest
docker run --name aspnet-core bitnami/aspnet-core:latest
```
## Contributing
@ -168,7 +168,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/aws-cli/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name aws-cli bitnami/aws-cli:latest
docker run --name aws-cli bitnami/aws-cli:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami aws-cli Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/aws-cli).
```console
$ docker pull bitnami/aws-cli:latest
docker pull bitnami/aws-cli:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/aws-cli/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/aws-cli:[TAG]
docker pull bitnami/aws-cli:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -60,7 +60,7 @@ $ docker build -t bitnami/APP:latest .
To run commands inside this container you can use `docker run`, for example to execute `aws-cli --version` you can follow the example below:
```console
$ docker run --rm --name aws-cli bitnami/aws-cli:latest -- --version
docker run --rm --name aws-cli bitnami/aws-cli:latest -- --version
```
Consult the [aws-cli Reference Documentation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/index.html) to find the completed list of commands available.
@ -70,7 +70,7 @@ Consult the [aws-cli Reference Documentation](https://awscli.amazonaws.com/v2/do
It's possible to load your own configuration, which is useful if you want to connect to a remote cluster:
```console
$ docker run --rm --name aws-cli -v /path/to/your/aws/config:/.aws/config bitnami/aws-cli:latest
docker run --rm --name aws-cli -v /path/to/your/aws/config:/.aws/config bitnami/aws-cli:latest
```
## Contributing
@ -89,7 +89,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/azure-cli/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name azure-cli bitnami/azure-cli:latest
docker run --name azure-cli bitnami/azure-cli:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami azure-cli Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/azure-cli).
```console
$ docker pull bitnami/azure-cli:latest
docker pull bitnami/azure-cli:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/azure-cli/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/azure-cli:[TAG]
docker pull bitnami/azure-cli:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -60,7 +60,7 @@ $ docker build -t bitnami/APP:latest .
To run commands inside this container you can use `docker run`, for example to execute `azure-cli --version` you can follow the example below:
```console
$ docker run --rm --name azure-cli bitnami/azure-cli:latest -- --version
docker run --rm --name azure-cli bitnami/azure-cli:latest -- --version
```
Consult the [azure-cli Reference Documentation](https://docs.microsoft.com/en-us/cli/azure/reference-index?view=azure-cli-latest) to find the completed list of commands available.
@ -70,7 +70,7 @@ Consult the [azure-cli Reference Documentation](https://docs.microsoft.com/en-us
It's possible to load your own configuration, which is useful if you want to connect to a remote cluster:
```console
$ docker run --rm --name azure-cli -v /path/to/your/az/config:/.azure/config bitnami/azure-cli:latest
docker run --rm --name azure-cli -v /path/to/your/az/config:/.azure/config bitnami/azure-cli:latest
```
## Contributing
@ -89,7 +89,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

16
bitnami/bitnami-shell/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name bitnami-shell bitnami/bitnami-shell:latest
docker run --name bitnami-shell bitnami/bitnami-shell:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami bitnami-shell Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/bitnami-shell).
```console
$ docker pull bitnami/bitnami-shell:latest
docker pull bitnami/bitnami-shell:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/bitnami-shell/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/bitnami-shell:[TAG]
docker pull bitnami/bitnami-shell:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -60,7 +60,7 @@ $ docker build -t bitnami/APP:latest .
To run commands inside this container you can use `docker run`, for example to execute `echo Hello world` you can follow the example below:
```console
$ docker run --rm --name bitnami-shell bitnami/bitnami-shell:latest echo hello world
docker run --rm --name bitnami-shell bitnami/bitnami-shell:latest echo hello world
```
## Contributing
@ -79,7 +79,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

33
bitnami/blackbox-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name blackbox-exporter bitnami/blackbox-exporter:latest
docker run --name blackbox-exporter bitnami/blackbox-exporter:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Blackbox Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/blackbox-exporter).
```console
$ docker pull bitnami/blackbox-exporter:latest
docker pull bitnami/blackbox-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/blackbox-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/blackbox-exporter:[TAG]
docker pull bitnami/blackbox-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create blackbox-exporter-network --driver bridge
docker network create blackbox-exporter-network --driver bridge
```
#### Step 2: Launch the Blackbox_exporter container within your network
@ -76,7 +76,7 @@ $ docker network create blackbox-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `blackbox-exporter-network` network.
```console
$ docker run --name blackbox-exporter-node1 --network blackbox-exporter-network bitnami/blackbox-exporter:latest
docker run --name blackbox-exporter-node1 --network blackbox-exporter-network bitnami/blackbox-exporter:latest
```
#### Step 3: Run another containers
@ -131,7 +131,7 @@ scrape_configs:
The Bitnami blackbox-exporter Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs blackbox-exporter
docker logs blackbox-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -145,7 +145,7 @@ Bitnami provides up-to-date versions of blackbox-exporter, including security pa
#### Step 1: Get the updated image
```console
$ docker pull bitnami/blackbox-exporter:latest
docker pull bitnami/blackbox-exporter:latest
```
#### Step 2: Stop and backup the currently running container
@ -153,13 +153,13 @@ $ docker pull bitnami/blackbox-exporter:latest
Stop the currently running container using the command
```console
$ docker stop blackbox-exporter
docker stop blackbox-exporter
```
Next, take a snapshot of the persistent volume `/path/to/blackbox-exporter-persistence` using:
```console
$ rsync -a /path/to/blackbox-exporter-persistence /path/to/blackbox-exporter-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/blackbox-exporter-persistence /path/to/blackbox-exporter-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the database state should the upgrade fail.
@ -167,15 +167,15 @@ You can use this snapshot to restore the database state should the upgrade fail.
#### Step 3: Remove the currently running container
```console
$ docker rm -v blackbox-exporter
docker rm -v blackbox-exporter
```
#### Step 4: Run the new image
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
Re-create your container from the new image, restoring your backup if necessary.
```console
$ docker run --name blackbox-exporter bitnami/blackbox-exporter:latest
docker run --name blackbox-exporter bitnami/blackbox-exporter:latest
```
## Contributing
@ -195,13 +195,14 @@ The Bitnami team will review any PR that is created, feel free to create a PR if
New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/cainjector/README.md
View File

@ -12,14 +12,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cainjector:latest
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cainjector:latest
```
#### Docker Compose
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cainjector/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cainjector/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Configuration](#configuration) section for a more secure deployment.
@ -71,7 +71,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

28
bitnami/cassandra-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name cassandra-exporter bitnami/cassandra-exporter:latest
docker run --name cassandra-exporter bitnami/cassandra-exporter:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Cassandra Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/cassandra-exporter).
```console
$ docker pull bitnami/cassandra-exporter:latest
docker pull bitnami/cassandra-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/cassandra-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/cassandra-exporter:[TAG]
docker pull bitnami/cassandra-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create cassandra-exporter-network --driver bridge
docker network create cassandra-exporter-network --driver bridge
```
#### Step 2: Launch the cassandra-exporter container within your network
@ -76,7 +76,7 @@ $ docker network create cassandra-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `cassandra-exporter-network` network.
```console
$ docker run --name cassandra-exporter-node1 --network cassandra-exporter-network bitnami/cassandra-exporter:latest
docker run --name cassandra-exporter-node1 --network cassandra-exporter-network bitnami/cassandra-exporter:latest
```
#### Step 3: Run another containers
@ -92,7 +92,7 @@ Find all the configuration options in the [Cassandra Prometheus Exporter documen
The Bitnami Cassandra Exporter Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs cassandra-exporter
docker logs cassandra-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -106,7 +106,7 @@ Bitnami provides up-to-date versions of Cassandra Exporter, including security p
#### Step 1: Get the updated image
```console
$ docker pull bitnami/cassandra-exporter:latest
docker pull bitnami/cassandra-exporter:latest
```
#### Step 2: Stop the running container
@ -114,13 +114,13 @@ $ docker pull bitnami/cassandra-exporter:latest
Stop the currently running container using the command
```console
$ docker stop cassandra-exporter
docker stop cassandra-exporter
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v cassandra-exporter
docker rm -v cassandra-exporter
```
#### Step 4: Run the new image
@ -128,7 +128,7 @@ $ docker rm -v cassandra-exporter
Re-create your container from the new image.
```console
$ docker run --name cassandra-exporter bitnami/cassandra-exporter:latest
docker run --name cassandra-exporter bitnami/cassandra-exporter:latest
```
## Contributing
@ -147,7 +147,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

216
bitnami/cassandra/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name cassandra bitnami/cassandra:latest
docker run --name cassandra bitnami/cassandra:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cassandra/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cassandra/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
@ -55,21 +55,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Apache Cassandra Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/cassandra).
```console
$ docker pull bitnami/cassandra:latest
docker pull bitnami/cassandra:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/cassandra/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/cassandra:[TAG]
docker pull bitnami/cassandra:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -79,7 +79,7 @@ If you remove the container all your data and configurations will be lost, and t
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/cassandra-persistence:/bitnami \
bitnami/cassandra:latest
```
@ -108,7 +108,7 @@ In this example, we will create an Apache Cassandra client instance that will co
#### Step 1: Create a network
```console
$ docker network create app-tier --driver bridge
docker network create app-tier --driver bridge
```
#### Step 2: Launch the Apache Cassandra server instance
@ -116,7 +116,7 @@ $ docker network create app-tier --driver bridge
Use the `--network app-tier` argument to the `docker run` command to attach the Apache Cassandra container to the `app-tier` network.
```console
$ docker run -d --name cassandra-server \
docker run -d --name cassandra-server \
--network app-tier \
bitnami/cassandra:latest
```
@ -126,7 +126,7 @@ $ docker run -d --name cassandra-server \
Finally we create a new container instance to launch the Apache Cassandra client and connect to the server created in the previous step:
```console
$ docker run -it --rm \
docker run -it --rm \
--network app-tier \
bitnami/cassandra:latest cqlsh --username cassandra --password cassandra cassandra-server
```
@ -161,7 +161,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -170,7 +170,8 @@ $ docker-compose up -d
When you start the cassandra image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
* For docker-compose add the variable name and value under the application section:
* For docker-compose add the variable name and value under the application section:
```yaml
cassandra:
image: bitnami/cassandra:latest
@ -178,10 +179,10 @@ cassandra:
- CASSANDRA_TRANSPORT_PORT_NUMBER=7000
```
* For manual execution add a `-e` option with each variable and value:
* For manual execution add a `-e` option with each variable and value:
```console
$ docker run --name cassandra -d -p 7000:7000 --network=cassandra_network \
docker run --name cassandra -d -p 7000:7000 --network=cassandra_network \
-e CASSANDRA_TRANSPORT_PORT_NUMBER=7000 \
-v /your/local/path/bitnami/cassandra:/bitnami \
bitnami/cassandra
@ -189,41 +190,41 @@ cassandra:
**In case you do not mount custom configuration files**, the following variables are available for configuring cassandra:
- `CASSANDRA_TRANSPORT_PORT_NUMBER`: Inter-node cluster communication port. Default: **7000**
- `CASSANDRA_JMX_PORT_NUMBER`: JMX connections port. Default: **7199**
- `CASSANDRA_CQL_PORT_NUMBER`: Client port. Default: **9042**.
- `CASSANDRA_USER`: Apache Cassandra user name. Defaults: **cassandra**
- `CASSANDRA_PASSWORD_SEEDER`: Password seeder will change the Apache Cassandra default credentials at initialization. In clusters, only one node should be marked as password seeder. Default: **no**
- `CASSANDRA_PASSWORD`: Apache Cassandra user password. Default: **cassandra**
- `CASSANDRA_NUM_TOKENS`: Number of tokens for the node. Default: **256**.
- `CASSANDRA_HOST`: Hostname used to configure Apache Cassandra. It can be either an IP or a domain. If left empty, it will be resolved to the machine IP.
- `CASSANDRA_CLUSTER_NAME`: Cluster name to configure Apache Cassandra.. Defaults: **My Cluster**
- `CASSANDRA_SEEDS`: Hosts that will act as Apache Cassandra seeds. No defaults.
- `CASSANDRA_ENDPOINT_SNITCH`: Snitch name (which determines which data centers and racks nodes belong to). Default **SimpleSnitch**
- `CASSANDRA_ENABLE_RPC`: Enable the thrift RPC endpoint (ignored for Apache Cassandra 4.X and newer). Default :**true**
- `CASSANDRA_DATACENTER`: Datacenter name for the cluster. Ignored in **SimpleSnitch** endpoint snitch. Default: **dc1**.
- `CASSANDRA_RACK`: Rack name for the cluster. Ignored in **SimpleSnitch** endpoint snitch. Default: **rack1**.
- `CASSANDRA_ENABLE_USER_DEFINED_FUNCTIONS`: User defined functions. Default: **false**.
- `CASSANDRA_ENABLE_SCRIPTED_USER_DEFINED_FUNCTIONS`: User defined scripted functions. Default: **false**
- `CASSANDRA_BROADCAST_ADDRESS`: The public IP address this node uses to broadcast to other nodes outside the network or across regions in multiple-region EC2 deployments. This option is commented out by default (if not provided, Apache Cassandra will use "listen_address"). No defaults.
- `CASSANDRA_COMMITLOG_DIR`: Directory where the commit logs will be stored. Default: **/bitnami/cassandra/data/commitlog**
- `CASSANDRA_AUTOMATIC_SSTABLE_UPGRADE`: Automatically upgrade sstables after upgrade - if there is no ordinary compaction to do, the oldest non-upgraded sstable will get upgraded to the latest version. Default: **false**.
* `CASSANDRA_TRANSPORT_PORT_NUMBER`: Inter-node cluster communication port. Default: **7000**
* `CASSANDRA_JMX_PORT_NUMBER`: JMX connections port. Default: **7199**
* `CASSANDRA_CQL_PORT_NUMBER`: Client port. Default: **9042**.
* `CASSANDRA_USER`: Apache Cassandra user name. Defaults: **cassandra**
* `CASSANDRA_PASSWORD_SEEDER`: Password seeder will change the Apache Cassandra default credentials at initialization. In clusters, only one node should be marked as password seeder. Default: **no**
* `CASSANDRA_PASSWORD`: Apache Cassandra user password. Default: **cassandra**
* `CASSANDRA_NUM_TOKENS`: Number of tokens for the node. Default: **256**.
* `CASSANDRA_HOST`: Hostname used to configure Apache Cassandra. It can be either an IP or a domain. If left empty, it will be resolved to the machine IP.
* `CASSANDRA_CLUSTER_NAME`: Cluster name to configure Apache Cassandra.. Defaults: **My Cluster**
* `CASSANDRA_SEEDS`: Hosts that will act as Apache Cassandra seeds. No defaults.
* `CASSANDRA_ENDPOINT_SNITCH`: Snitch name (which determines which data centers and racks nodes belong to). Default **SimpleSnitch**
* `CASSANDRA_ENABLE_RPC`: Enable the thrift RPC endpoint (ignored for Apache Cassandra 4.X and newer). Default :**true**
* `CASSANDRA_DATACENTER`: Datacenter name for the cluster. Ignored in **SimpleSnitch** endpoint snitch. Default: **dc1**.
* `CASSANDRA_RACK`: Rack name for the cluster. Ignored in **SimpleSnitch** endpoint snitch. Default: **rack1**.
* `CASSANDRA_ENABLE_USER_DEFINED_FUNCTIONS`: User defined functions. Default: **false**.
* `CASSANDRA_ENABLE_SCRIPTED_USER_DEFINED_FUNCTIONS`: User defined scripted functions. Default: **false**
* `CASSANDRA_BROADCAST_ADDRESS`: The public IP address this node uses to broadcast to other nodes outside the network or across regions in multiple-region EC2 deployments. This option is commented out by default (if not provided, Apache Cassandra will use "listen_address"). No defaults.
* `CASSANDRA_COMMITLOG_DIR`: Directory where the commit logs will be stored. Default: **/bitnami/cassandra/data/commitlog**
* `CASSANDRA_AUTOMATIC_SSTABLE_UPGRADE`: Automatically upgrade sstables after upgrade - if there is no ordinary compaction to do, the oldest non-upgraded sstable will get upgraded to the latest version. Default: **false**.
Additionally, any environment variable beginning with the following prefix will be mapped to its corresponding Apache Cassandra key in the proper file:
- `CASSANDRA_CFG_ENV_`: Will add the corresponding key and the provided value to `cassandra-env.sh`.
- `CASSANDRA_CFG_RACKDC_`: Will add the corresponding key and the provided value to `cassandra-rackdc.properties`.
- `CASSANDRA_CFG_COMMITLOG_`: Will add the corresponding key and the provided value to `commitlog_archiving.properties`.
* `CASSANDRA_CFG_ENV_`: Will add the corresponding key and the provided value to `cassandra-env.sh`.
* `CASSANDRA_CFG_RACKDC_`: Will add the corresponding key and the provided value to `cassandra-rackdc.properties`.
* `CASSANDRA_CFG_COMMITLOG_`: Will add the corresponding key and the provided value to `commitlog_archiving.properties`.
For example, use `CASSANDRA_CFG_RACKDC_PREFER_LOCAL` in order to configure `prefer_local` in `cassandra-rackdc.properties`:
```console
$ docker run --name cassandra -e CASSANDRA_CFG_RACKDC_PREFER_LOCAL=true bitnami/cassandra:latest
docker run --name cassandra -e CASSANDRA_CFG_RACKDC_PREFER_LOCAL=true bitnami/cassandra:latest
```
or modifying the `docker-compose.yaml` with:
```
```yaml
cassandra:
...
environment:
@ -238,6 +239,7 @@ The image looks for configurations in `/opt/bitnami/cassandra/conf/`. You can mo
For example, in order to override the `cassandra.yaml` configuration file:
#### Step 1: Write your custom `cassandra.yaml` file
You can download the basic cassandra.yaml file like follows
```console
@ -246,10 +248,10 @@ wget https://raw.githubusercontent.com/apache/cassandra/trunk/conf/cassandra.yam
Perform any desired modifications in that file
#### Step 2: Run the Apache Cassandra image with the designed volume attached.
#### Step 2: Run the Apache Cassandra image with the designed volume attached
```console
$ docker run --name cassandra \
docker run --name cassandra \
-p 7000:7000 \
-e CASSANDRA_TRANSPORT_PORT_NUMBER=7000 \
-v /path/to/cassandra.yaml:/bitnami/cassandra/conf/cassandra.yaml:ro \
@ -279,7 +281,7 @@ After that, your changes will be taken into account in the server's behaviour. N
Passing the `CASSANDRA_PASSWORD` environment variable along with `CASSANDRA_PASSWORD_SEEDER=yes` when running the image for the first time will set the Apache Cassandra server password to the value of `CASSANDRA_PASSWORD`.
```console
$ docker run --name cassandra \
docker run --name cassandra \
-e CASSANDRA_PASSWORD_SEEDER=yes \
-e CASSANDRA_PASSWORD=password123 \
bitnami/cassandra:latest
@ -299,32 +301,32 @@ cassandra:
A cluster can easily be setup with the Bitnami Apache Cassandra Docker Image. **In case you do not mount custom configuration files**, you can use the following environment variables:
- `CASSANDRA_HOST`: Hostname used to configure Apache Cassandra. It can be either an IP or a domain. If left empty, it will be resolved to the machine IP.
- `CASSANDRA_CLUSTER_NAME`: Cluster name to configure Apache Cassandra. Defaults: **My Cluster**
- `CASSANDRA_SEEDS`: Hosts that will act as Apache Cassandra seeds. No defaults.
- `CASSANDRA_ENDPOINT_SNITCH`: Snitch name (which determines which data centers and racks nodes belong to). Default **SimpleSnitch**
- `CASSANDRA_PASSWORD_SEEDER`: Password seeder will change the Apache Cassandra default credentials at initialization. Only one node should be marked as password seeder. Default: **no**
- `CASSANDRA_PASSWORD`: Apache Cassandra user password. Default: **cassandra**
* `CASSANDRA_HOST`: Hostname used to configure Apache Cassandra. It can be either an IP or a domain. If left empty, it will be resolved to the machine IP.
* `CASSANDRA_CLUSTER_NAME`: Cluster name to configure Apache Cassandra. Defaults: **My Cluster**
* `CASSANDRA_SEEDS`: Hosts that will act as Apache Cassandra seeds. No defaults.
* `CASSANDRA_ENDPOINT_SNITCH`: Snitch name (which determines which data centers and racks nodes belong to). Default **SimpleSnitch**
* `CASSANDRA_PASSWORD_SEEDER`: Password seeder will change the Apache Cassandra default credentials at initialization. Only one node should be marked as password seeder. Default: **no**
* `CASSANDRA_PASSWORD`: Apache Cassandra user password. Default: **cassandra**
Apache Cassandra is a resource-intensive application. Depending on the target system, the initialization can take long. The container has internal timeouts when checking the initialization process. You can use the following environment variables to address that:
- `CASSANDRA_INIT_MAX_RETRIES`: Maximum retries for checking that Apache Cassandra is initialized. Default: **100**.
- `CASSANDRA_INIT_SLEEP_TIME`: Sleep time (in seconds) between retries for checking that Apache Cassandra is initialized. Default: **5**.
- `CASSANDRA_CQL_MAX_RETRIES`: Maximum retries for checking that the Apache Cassandra client can access the database in localhost. Default: **20**.
- `CASSANDRA_CQL_SLEEP_TIME`: Sleep time (in seconds) between retries for checking that the Apache Cassandra client can access the database in localhost. Default: **5**.
- `CASSANDRA_PEER_CQL_MAX_RETRIES`: Maximum retries for checking that the Apache Cassandra client can access the database located in a peer host. This is used for ensuring that all of the peers are initialized before changing the database credentials. Default: **100**.
- `CASSANDRA_PEER_CQL_SLEEP_TIME`: Sleep time (in seconds) between retries for checking that the Apache Cassandra client can access the database in a peer host. Default: **5**.
* `CASSANDRA_INIT_MAX_RETRIES`: Maximum retries for checking that Apache Cassandra is initialized. Default: **100**.
* `CASSANDRA_INIT_SLEEP_TIME`: Sleep time (in seconds) between retries for checking that Apache Cassandra is initialized. Default: **5**.
* `CASSANDRA_CQL_MAX_RETRIES`: Maximum retries for checking that the Apache Cassandra client can access the database in localhost. Default: **20**.
* `CASSANDRA_CQL_SLEEP_TIME`: Sleep time (in seconds) between retries for checking that the Apache Cassandra client can access the database in localhost. Default: **5**.
* `CASSANDRA_PEER_CQL_MAX_RETRIES`: Maximum retries for checking that the Apache Cassandra client can access the database located in a peer host. This is used for ensuring that all of the peers are initialized before changing the database credentials. Default: **100**.
* `CASSANDRA_PEER_CQL_SLEEP_TIME`: Sleep time (in seconds) between retries for checking that the Apache Cassandra client can access the database in a peer host. Default: **5**.
#### Step 1: Create a new network.
#### Step 1: Create a new network
```console
$ docker network create cassandra_network
docker network create cassandra_network
```
#### Step 2: Create a first node.
#### Step 2: Create a first node
```console
$ docker run --name cassandra-node1 \
docker run --name cassandra-node1 \
--net=cassandra_network \
-p 9042:9042 \
-e CASSANDRA_CLUSTER_NAME=cassandra-cluster \
@ -333,12 +335,13 @@ $ docker run --name cassandra-node1 \
-e CASSANDRA_PASSWORD=mypassword \
bitnami/cassandra:latest
```
In the above command the container is added to a cluster named `cassandra-cluster` using the `CASSANDRA_CLUSTER_NAME`. The `CASSANDRA_CLUSTER_HOSTS` parameter set the name of the nodes that set the cluster so we will need to launch other container for the second node. Finally the `CASSANDRA_NODE_NAME` parameter allows to indicate a known name for the node, otherwise cassandra will generate a random one.
#### Step 3: Create a second node
```console
$ docker run --name cassandra-node2 \
docker run --name cassandra-node2 \
--net=cassandra_network \
-e CASSANDRA_CLUSTER_NAME=cassandra-cluster \
-e CASSANDRA_SEEDS=cassandra-node1,cassandra-node2 \
@ -370,6 +373,7 @@ services:
- CASSANDRA_SEEDS=cassandra-node1,cassandra-node2
- CASSANDRA_PASSWORD=password123
```
### Initializing with custom scripts
When the container is executed for the first time, it will execute the files with extensions `.sh`, `.cql` or `.cql.gz` located at `/docker-entrypoint-initdb.d` in sort'ed order by filename. This behavior can be skipped by setting the environment variable `CASSANDRA_IGNORE_INITDB_SCRIPTS` to a value other than `yes` or `true`.
@ -377,11 +381,12 @@ When the container is executed for the first time, it will execute the files wit
In order to have your custom files inside the docker image you can mount them as a volume.
```console
$ docker run --name cassandra \
docker run --name cassandra \
-v /path/to/init-scripts:/docker-entrypoint-initdb.d \
-v /path/to/cassandra-persistence:/bitnami
bitnami/cassandra:latest
```
Or with docker-compose
```yaml
@ -392,78 +397,32 @@ cassandra:
- /path/to/cassandra-persistence:/bitnami
```
### Configuration file
The image looks for configurations in `/bitnami/cassandra/conf/`. As mentioned in [Persisting your application](#persisting-your-application) you can mount a volume at `/bitnami` and copy/edit the configurations in the `/path/to/cassandra-persistence/cassandra/conf/`. The default configurations will be populated to the `conf/` directory if it's empty.
#### Step 1: Run the Apache Cassandra image
Run the Apache Cassandra image, mounting a directory from your host.
```console
$ docker run --name cassandra \
-v /path/to/cassandra-persistence:/bitnami \
bitnami/cassandra:latest
```
or using Docker Compose:
```yaml
cassandra:
image: bitnami/cassandra:latest
volumes:
- /path/to/cassandra-persistence:/bitnami
```
#### Step 2: Edit the configuration
Edit the configuration on your host using your favorite editor.
```console
vi /path/to/cassandra-persistence/cassandra/conf/cassandra.yaml
```
#### Step 3: Restart Apache Cassandra
After changing the configuration, restart your Apache Cassandra container for changes to take effect.
```console
$ docker restart cassandra
```
or using Docker Compose:
```console
$ docker-compose restart cassandra
```
Refer to the [configuration](http://docs.datastax.com/en/cassandra/3.x/cassandra/configuration/configTOC.html) manual for the complete list of configuration options.
## TLS Encryption
The Bitnami Apache Cassandra Docker image allows configuring TLS encryption between nodes and between server-client. This is done by mounting in `/bitnami/cassandra/secrets` two files:
- `keystore`: File with the server keystore
- `truststore`: File with the server truststore
* `keystore`: File with the server keystore
* `truststore`: File with the server truststore
Apart from that, the following environment variables must be set:
- `CASSANDRA_KEYSTORE_PASSWORD`: Password for accessing the keystore.
- `CASSANDRA_TRUSTSTORE_PASSWORD`: Password for accessing the truststore.
- `CASSANDRA_INTERNODE_ENCRYPTION`: Sets the type of encryption between nodes. The default value is `none`. Can be set to `all`, `none`, `dc` or `rack`.
- `CASSANDRA_CLIENT_ENCRYPTION`: Enables client-server encryption. The default value is `false`.
* `CASSANDRA_KEYSTORE_PASSWORD`: Password for accessing the keystore.
* `CASSANDRA_TRUSTSTORE_PASSWORD`: Password for accessing the truststore.
* `CASSANDRA_INTERNODE_ENCRYPTION`: Sets the type of encryption between nodes. The default value is `none`. Can be set to `all`, `none`, `dc` or `rack`.
* `CASSANDRA_CLIENT_ENCRYPTION`: Enables client-server encryption. The default value is `false`.
## Logging
The Bitnami Apache Cassandra Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs cassandra
docker logs cassandra
```
or using Docker Compose:
```console
$ docker-compose logs cassandra
docker-compose logs cassandra
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -477,7 +436,7 @@ Bitnami provides up-to-date versions of Apache Cassandra, including security pat
#### Step 1: Get the updated image
```console
$ docker pull bitnami/cassandra:latest
docker pull bitnami/cassandra:latest
```
or if you're using Docker Compose, update the value of the image property to
@ -488,31 +447,31 @@ or if you're using Docker Compose, update the value of the image property to
Stop the currently running container using the command
```console
$ docker stop cassandra
docker stop cassandra
```
or using Docker Compose:
```console
$ docker-compose stop cassandra
docker-compose stop cassandra
```
Next, take a snapshot of the persistent volume `/path/to/cassandra-persistence` using:
```console
$ rsync -a /path/to/cassandra-persistence /path/to/cassandra-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/cassandra-persistence /path/to/cassandra-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v cassandra
docker rm -v cassandra
```
or using Docker Compose:
```console
$ docker-compose rm -v cassandra
docker-compose rm -v cassandra
```
#### Step 4: Run the new image
@ -520,24 +479,24 @@ $ docker-compose rm -v cassandra
Re-create your container from the new image.
```console
$ docker run --name cassandra bitnami/cassandra:latest
docker run --name cassandra bitnami/cassandra:latest
```
or using Docker Compose:
```console
$ docker-compose up cassandra
docker-compose up cassandra
```
## Notable Changes
## 3.11.10-debian-10-r81 Split branch 3
- Branch 3 has been split into branch 3.0 and 3.11 mirroring the upstream Apache Cassandra repo.
* Branch 3 has been split into branch 3.0 and 3.11 mirroring the upstream Apache Cassandra repo.
### 3.11.4-debian-9-r188 and 3.11.4-ol-7-r201
- Decrease the size of the container. The configuration logic is now based on Bash scripts in the `rootfs/` folder.
* Decrease the size of the container. The configuration logic is now based on Bash scripts in the `rootfs/` folder.
### 3.11.3-r129
@ -545,7 +504,7 @@ $ docker-compose up cassandra
### 3.11.2-r22
- The Apache Cassandra container has been migrated to a non-root user approach. Previously the container ran as the `root` user and the Apache Cassandra daemon was started as the `cassandra` user. From now on, both the container and the Apache Cassandra daemon run as user `1001`. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
* The Apache Cassandra container has been migrated to a non-root user approach. Previously the container ran as the `root` user and the Apache Cassandra daemon was started as the `cassandra` user. From now on, both the container and the Apache Cassandra daemon run as user `1001`. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
## Contributing
@ -556,13 +515,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/cert-manager-webhook/README.md
View File

@ -12,14 +12,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cert-manager-webhook:latest
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cert-manager-webhook:latest
```
#### Docker Compose
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cert-manager-webhook/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cert-manager-webhook/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Configuration](#configuration) section for a more secure deployment.
@ -71,7 +71,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/cert-manager/README.md
View File

@ -12,14 +12,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cert-manager:latest
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cert-manager:latest
```
#### Docker Compose
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cert-manager/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cert-manager/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Configuration](#configuration) section for a more secure deployment.
@ -71,7 +71,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/chartmuseum/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name chartmuseum bitnami/chartmuseum:latest
docker run --name chartmuseum bitnami/chartmuseum:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami chartmuseum Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/chartmuseum).
```console
$ docker pull bitnami/chartmuseum:latest
docker pull bitnami/chartmuseum:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/chartmuseum/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/chartmuseum:[TAG]
docker pull bitnami/chartmuseum:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuring this image
@ -68,7 +68,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami/data` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/chartmuseum-persistence:/bitnami/data \
bitnami/chartmuseum:latest
```
@ -105,7 +105,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create chartmuseum-network --driver bridge
docker network create chartmuseum-network --driver bridge
```
#### Step 2: Launch the chartmuseum container within your network
@ -113,7 +113,7 @@ $ docker network create chartmuseum-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `chartmuseum-network` network.
```console
$ docker run --name chartmuseum-node1 --network chartmuseum-network bitnami/chartmuseum:latest
docker run --name chartmuseum-node1 --network chartmuseum-network bitnami/chartmuseum:latest
```
#### Step 3: Run another containers
@ -132,7 +132,7 @@ For example, the env var `STORAGE_AMAZON_BUCKET` can be used to set the command-
The Bitnami chartmuseum Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs chartmuseum
docker logs chartmuseum
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -146,7 +146,7 @@ Bitnami provides up-to-date versions of chartmuseum, including security patches,
#### Step 1: Get the updated image
```console
$ docker pull bitnami/chartmuseum:latest
docker pull bitnami/chartmuseum:latest
```
#### Step 2: Stop the running container
@ -154,13 +154,13 @@ $ docker pull bitnami/chartmuseum:latest
Stop the currently running container using the command
```console
$ docker stop chartmuseum
docker stop chartmuseum
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v chartmuseum
docker rm -v chartmuseum
```
#### Step 4: Run the new image
@ -168,7 +168,7 @@ $ docker rm -v chartmuseum
Re-create your container from the new image.
```console
$ docker run --name chartmuseum bitnami/chartmuseum:latest
docker run --name chartmuseum bitnami/chartmuseum:latest
```
## Contributing
@ -187,7 +187,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

66
bitnami/clickhouse/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name clickhouse bitnami/clickhouse:latest
docker run --name clickhouse bitnami/clickhouse:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/clickhouse/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/clickhouse/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami ClickHouse Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/clickhouse).
```console
$ docker pull bitnami/clickhouse:latest
docker pull bitnami/clickhouse:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/clickhouse/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/clickhouse:[TAG]
docker pull bitnami/clickhouse:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -73,7 +73,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami/clickhouse` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
--volume /path/to/clickhouse-persistence:/bitnami/clickhouse \
--env ALLOM_EMPTY_PASSWORD=false \
bitnami/clickhouse:latest
@ -102,7 +102,7 @@ In this example, we will create a ClickHouse client instance that will connect t
#### Step 1: Create a network
```console
$ docker network create my-network --driver bridge
docker network create my-network --driver bridge
```
#### Step 2: Launch the ClickHouse container within your network
@ -110,7 +110,7 @@ $ docker network create my-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `my-network` network.
```console
$ docker run -d --name clickhouse-server \
docker run -d --name clickhouse-server \
--network my-network \
--env ALLOW_EMPTY_PASSWORD=yes \
bitnami/clickhouse:latest
@ -121,7 +121,7 @@ $ docker run -d --name clickhouse-server \
Finally we create a new container instance to launch the ClickHouse client and connect to the server created in the previous step:
```console
$ docker run -it --rm \
docker run -it --rm \
--network my-network \
bitnami/clickhouse:latest clickhouse-client --host clickhouse-server
```
@ -158,7 +158,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -170,7 +170,7 @@ ClickHouse can be configured via environment variables or using a configuration
The configuration can easily be setup by mounting your own configuration overrides on the directory `/bitnami/clickhouse/conf/conf.d` or `/bitnami/clickhouse/conf/users.d`:
```console
$ docker run --name clickhouse \
docker run --name clickhouse \
--volume /path/to/override.xml:/bitnami/clickhouse/conf/conf.d/override.xml:ro \
bitnami/clickhouse:latest
```
@ -199,13 +199,13 @@ In order to have your custom files inside the docker image you can mount them as
The admin user and password can easily be setup with the Bitnami ClickHouse Docker image using the following environment variables:
- `CLICKHOUSE_ADMIN_USER`: The database admin user. Defaults to `default`.
- `CLICKHOUSE_ADMIN_PASSWORD`: The database admin user password. No defaults.
* `CLICKHOUSE_ADMIN_USER`: The database admin user. Defaults to `default`.
* `CLICKHOUSE_ADMIN_PASSWORD`: The database admin user password. No defaults.
Passing the `CLICKHOUSE_ADMIN_PASSWORD` environment variable when running the image for the first time will set the password of the `CLICKHOUSE_ADMIN_USER` user to the value of `CLICKHOUSE_ADMIN_PASSWORD`.
```console
$ docker run --name clickhouse -e CLICKHOUSE_ADMIN_PASSWORD=password123 bitnami/clickhouse:latest
docker run --name clickhouse -e CLICKHOUSE_ADMIN_PASSWORD=password123 bitnami/clickhouse:latest
```
or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/clickhouse/docker-compose.yml) file present in this repository:
@ -223,18 +223,18 @@ services:
ClickHouse default ports can be changed using the following environment variables:
- `CLICKHOUSE_HTTP_PORT`: HTTP port. Defaults to `8123`.
- `CLICKHOUSE_TCP_PORT`: TCP port. Defaults to `9000`.
- `CLICKHOUSE_MYSQL_PORT`: MySQL port. Defaults to `9004`.
- `CLICKHOUSE_POSTGRESQL_PORT`: PostgreSQL port. Defaults to `9005`.
- `CLICKHOUSE_INTERSERVER_HTTP_PORT`: Inter-server HTTP port. Defaults to `9009`.
* `CLICKHOUSE_HTTP_PORT`: HTTP port. Defaults to `8123`.
* `CLICKHOUSE_TCP_PORT`: TCP port. Defaults to `9000`.
* `CLICKHOUSE_MYSQL_PORT`: MySQL port. Defaults to `9004`.
* `CLICKHOUSE_POSTGRESQL_PORT`: PostgreSQL port. Defaults to `9005`.
* `CLICKHOUSE_INTERSERVER_HTTP_PORT`: Inter-server HTTP port. Defaults to `9009`.
### Allowing empty passwords
By default the ClickHouse image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the `ALLOW_EMPTY_PASSWORD=yes` env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the `CLICKHOUSE_ADMIN_PASSWORD` for any other scenario.
```console
$ docker run --name clickhouse --env ALLOW_EMPTY_PASSWORD=yes bitnami/clickhouse:latest
docker run --name clickhouse --env ALLOW_EMPTY_PASSWORD=yes bitnami/clickhouse:latest
```
or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/clickhouse/docker-compose.yml) file present in this repository:
@ -253,7 +253,7 @@ services:
The Bitnami ClickHouse Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs clickhouse
docker logs clickhouse
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -267,7 +267,7 @@ Bitnami provides up-to-date versions of ClickHouse, including security patches,
#### Step 1: Get the updated image
```console
$ docker pull bitnami/clickhouse:latest
docker pull bitnami/clickhouse:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/clickhouse:latest`.
@ -277,31 +277,31 @@ or if you're using Docker Compose, update the value of the image property to `bi
Stop the currently running container using the command
```console
$ docker stop clickhouse
docker stop clickhouse
```
or using Docker Compose:
```console
$ docker-compose stop clickhouse
docker-compose stop clickhouse
```
Next, take a snapshot of the persistent volume `/path/to/clickhouse-persistence` using:
```console
$ rsync -a /path/to/clickhouse-persistence /path/to/clickhouse-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/clickhouse-persistence /path/to/clickhouse-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v clickhouse
docker rm -v clickhouse
```
or using Docker Compose:
```console
$ docker-compose rm -v clickhouse
docker-compose rm -v clickhouse
```
#### Step 4: Run the new image
@ -309,13 +309,13 @@ $ docker-compose rm -v clickhouse
Re-create your container from the new image.
```console
$ docker run --name clickhouse bitnami/clickhouse:latest
docker run --name clickhouse bitnami/clickhouse:latest
```
or using Docker Compose:
```console
$ docker-compose up clickhouse
docker-compose up clickhouse
```
## Contributing
@ -334,7 +334,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

2
bitnami/cluster-autoscaler/1/debian-11/rootfs/run.sh
View File

@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
# <http://www.apache.org/licenses/LICENSE-2.0>
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,

26
bitnami/cluster-autoscaler/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cluster-autoscaler:latest
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/cluster-autoscaler:latest
```
#### Docker Compose
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cluster-autoscaler/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cluster-autoscaler/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Configuration](#configuration) section for a more secure deployment.
@ -70,26 +70,26 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Cluster-autoscaler Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/cluster-autoscaler).
```console
$ docker pull bitnami/cluster-autoscaler:latest
docker pull bitnami/cluster-autoscaler:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/cluster-autoscaler/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/cluster-autoscaler:[TAG]
docker pull bitnami/cluster-autoscaler:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
### How to run a cluster with nodes in multiples zones for HA.
### How to run a cluster with nodes in multiples zones for HA
`--balance-similar-node-groups` flag is intended to support this use case. If you set the flag to true, Cluster Autoscaler will automatically identify node groups with the same instance type and the same set of labels (except for automatically added zone label) and try to keep the sizes of those node groups balanced.
@ -98,14 +98,17 @@ This does not guarantee similar node groups will have exactly the same sizes:
Currently the balancing is only done at scale-up. Cluster Autoscaler will still scale down underutilized nodes regardless of the relative sizes of underlying node groups.
### How monitor Cluster Autoscaler?
Cluster Autoscaler provides metrics and livenessProbe endpoints. By default they're available on port 8085 (configurable with --address flag), respectively under /metrics and /health-check.
Metrics are provided in Prometheus format.
### How scale my cluster to just 1 node?
Prior to version 0.6, Cluster Autoscaler was not touching nodes that were running important kube-system pods like DNS, Heapster, Dashboard etc. If these pods landed on different nodes, CA could not scale the cluster down and the user could end up with a completely empty 3 node cluster. In 0.6, we added an option to tell CA that some system pods can be moved around. If the user configures a PodDisruptionBudget for the kube-system pod, then the default strategy of not touching the node running this pod is overridden with PDB settings. So, to enable kube-system pods migration, one should set minAvailable to 0 (or <= N if there are N+1 pod replicas.) See also I have a couple of nodes with low utilization, but they are not scaled down. Why?
### How scale a node group to 0?
For GCE/GKE and for AWS, it is possible to scale a node group to 0 (and obviously from 0), assuming that all scale-down conditions are met.
For AWS, if you are using nodeSelector, you need to tag the ASG with a node-template key "k8s.io/cluster-autoscaler/node-template/label/".
@ -139,13 +142,14 @@ The Bitnami team will review any PR that is created, feel free to create a PR if
New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

32
bitnami/codeigniter/README.md
View File

@ -13,9 +13,9 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
### Local workspace
```console
$ mkdir ~/myapp && cd ~/myapp
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/codeigniter/docker-compose.yml
$ docker-compose up
mkdir ~/myapp && cd ~/myapp
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/codeigniter/docker-compose.yml
docker-compose up
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options for the [MariaDB container](https://github.com/bitnami/containers/blob/main/bitnami/mariadb#readme) for a more secure deployment.
@ -37,7 +37,7 @@ The Bitnami CodeIgniter Development Container has been carefully engineered to p
[Learn more about Bitnami Development Containers.](https://docs.bitnami.com/containers/how-to/use-bitnami-development-containers/)
# Supported tags and respective `Dockerfile` links
## Supported tags and respective `Dockerfile` links
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
@ -52,20 +52,20 @@ The quickest way to get started with the Bitnami CodeIgniter Development Contain
Begin by creating a directory for your CodeIgniter application:
```console
$ mkdir ~/myapp
$ cd ~/myapp
mkdir ~/myapp
cd ~/myapp
```
Download the [docker-compose.yml](https://raw.githubusercontent.com/bitnami/containers/main/bitnami/codeigniter/docker-compose.yml) file in the application directory:
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/codeigniter/docker-compose.yml
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/codeigniter/docker-compose.yml
```
Finally launch the CodeIgniter application development environment using:
```console
$ docker-compose up
docker-compose up
```
The above command creates a container service for CodeIgniter development and bootstraps a new CodeIgniter application, named `myapp` in working directory. You can use your favorite IDE for developing the application.
@ -83,17 +83,17 @@ Commands can be launched inside the `myapp` CodeIgniter Development Container wi
The general structure of the `exec` command is:
```console
$ docker-compose exec <service> <command>
docker-compose exec <service> <command>
```
where `<service>` is the name of the container service as described in the `docker-compose.yml` file and `<command>` is the command you want to launch inside the service.
Following are a few examples:
- Create a new project named `foo`:
* Create a new project named `foo`:
```console
$ docker-compose run myapp nami execute codeigniter createProject foo
docker-compose run myapp nami execute codeigniter createProject foo
```
Additionally, in the `docker-compose.yml` file you need to update the `CODEIGNITER_PROJECT_NAME` environment variable to `foo` so that the built-in PHP application server serves the application from the `foo` directory.
@ -102,11 +102,11 @@ Following are a few examples:
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/blob/main/bitnami/codeigniter/issues/new). Be sure to include the following information in your issue:
- Host OS and version
- Docker version (`docker version`)
- Output of `docker info`
- Version of this container
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
* Host OS and version
* Docker version (`docker version`)
* Output of `docker info`
* Version of this container
* The command you used to run the container, and any relevant output you saw (masking any sensitive information)
### Community supported solution

36
bitnami/concourse/README.md
View File

@ -6,19 +6,17 @@
[Overview of Concourse](https://concourse-ci.org/)
## TL;DR
```console
$ docker run --name concourse bitnami/concourse:latest
docker run --name concourse bitnami/concourse:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/concourse/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/concourse/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options for the [PostgreSQL container](https://github.com/bitnami/containers/tree/main/bitnami/postgresql#readme) for a more secure deployment.
@ -49,21 +47,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami concourse Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/concourse).
```console
$ docker pull bitnami/concourse:latest
docker pull bitnami/concourse:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/concourse/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/concourse:[TAG]
docker pull bitnami/concourse:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -73,7 +71,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/concourse-persistence:/bitnami/concourse \
bitnami/concourse:latest
```
@ -99,7 +97,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create concourse-network --driver bridge
docker network create concourse-network --driver bridge
```
#### Step 2: Launch the concourse container within your network
@ -107,7 +105,7 @@ $ docker network create concourse-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `concourse-network` network.
```console
$ docker run --name concourse-node1 --network concourse-network bitnami/concourse:latest
docker run --name concourse-node1 --network concourse-network bitnami/concourse:latest
```
#### Step 3: Run another container
@ -123,7 +121,7 @@ Find how to configure Concourse in its [official documentation](https://concours
The Bitnami concourse Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs concourse
docker logs concourse
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -137,7 +135,7 @@ Bitnami provides up-to-date versions of concourse, including security patches, s
#### Step 1: Get the updated image
```console
$ docker pull bitnami/concourse:latest
docker pull bitnami/concourse:latest
```
#### Step 2: Stop the running container
@ -145,13 +143,13 @@ $ docker pull bitnami/concourse:latest
Stop the currently running container using the command
```console
$ docker stop concourse
docker stop concourse
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v concourse
docker rm -v concourse
```
#### Step 4: Run the new image
@ -159,7 +157,7 @@ $ docker rm -v concourse
Re-create your container from the new image.
```console
$ docker run --name concourse bitnami/concourse:latest
docker run --name concourse bitnami/concourse:latest
```
## Contributing
@ -178,7 +176,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

13
bitnami/configmap-reload/README.md
View File

@ -38,21 +38,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami ConfigMap Reload Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/configmap-reload).
```console
$ docker pull bitnami/configmap-reload:latest
docker pull bitnami/configmap-reload:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/configmap-reload/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/configmap-reload:[TAG]
docker pull bitnami/configmap-reload:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -68,13 +68,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

16
bitnami/configurable-http-proxy/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name configurable-http-proxy bitnami/configurable-http-proxy:latest
docker run --name configurable-http-proxy bitnami/configurable-http-proxy:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami configurable-http-proxy Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/configurable-http-proxy).
```console
$ docker pull bitnami/configurable-http-proxy:latest
docker pull bitnami/configurable-http-proxy:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/configurable-http-proxy/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/configurable-http-proxy:[TAG]
docker pull bitnami/configurable-http-proxy:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,7 +64,7 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `configurable-http-proxy --version` you can follow the example below:
```console
$ docker run --rm --name configurable-http-proxy bitnami/configurable-http-proxy:latest -- configurable-http-proxy --version
docker run --rm --name configurable-http-proxy bitnami/configurable-http-proxy:latest -- configurable-http-proxy --version
```
Check the [official Configurable HTTP Proxy documentation](https://github.com/jupyterhub/configurable-http-proxy#command-line-options) for a list of the available parameters.
@ -85,7 +85,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

28
bitnami/consul-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name consul-exporter bitnami/consul-exporter:latest
docker run --name consul-exporter bitnami/consul-exporter:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Consul Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/consul-exporter).
```console
$ docker pull bitnami/consul-exporter:latest
docker pull bitnami/consul-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/consul-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/consul-exporter:[TAG]
docker pull bitnami/consul-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create consul-exporter-network --driver bridge
docker network create consul-exporter-network --driver bridge
```
#### Step 2: Launch the consul-exporter container within your network
@ -76,7 +76,7 @@ $ docker network create consul-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `consul-exporter-network` network.
```console
$ docker run --name consul-exporter-node1 --network consul-exporter-network bitnami/consul-exporter:latest
docker run --name consul-exporter-node1 --network consul-exporter-network bitnami/consul-exporter:latest
```
#### Step 3: Run another containers
@ -92,7 +92,7 @@ Find all the configuration options in the [Consul Prometheus Exporter documentat
The Bitnami Consul Exporter Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs consul-exporter
docker logs consul-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -106,7 +106,7 @@ Bitnami provides up-to-date versions of Consul Exporter, including security patc
#### Step 1: Get the updated image
```console
$ docker pull bitnami/consul-exporter:latest
docker pull bitnami/consul-exporter:latest
```
#### Step 2: Stop the running container
@ -114,13 +114,13 @@ $ docker pull bitnami/consul-exporter:latest
Stop the currently running container using the command
```console
$ docker stop consul-exporter
docker stop consul-exporter
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v consul-exporter
docker rm -v consul-exporter
```
#### Step 4: Run the new image
@ -128,7 +128,7 @@ $ docker rm -v consul-exporter
Re-create your container from the new image.
```console
$ docker run --name consul-exporter bitnami/consul-exporter:latest
docker run --name consul-exporter bitnami/consul-exporter:latest
```
## Contributing
@ -147,7 +147,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

113
bitnami/consul/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name consul bitnami/consul:latest
docker run --name consul bitnami/consul:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/consul/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/consul/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
You can find the available configuration options in the [Environment Variables](#environment-variables) section.
@ -55,21 +55,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami HashiCorp Consul Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/consul).
```console
$ docker pull bitnami/consul:latest
docker pull bitnami/consul:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/consul/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/consul:[TAG]
docker pull bitnami/consul:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -81,7 +81,7 @@ For persistence you should mount a volume at the `/bitnami` path. The above exam
To avoid inadvertent removal of this volume you can [mount host directories as data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/). Alternatively you can make use of volume plugins to host the volume data.
```console
$ docker run -v /path/to/consul-persistence:/bitnami bitnami/consul:latest
docker run -v /path/to/consul-persistence:/bitnami bitnami/consul:latest
```
or using Docker Compose:
@ -106,7 +106,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create consul-network --driver bridge
docker network create consul-network --driver bridge
```
#### Step 2: Launch the HashiCorp Consul container within your network
@ -114,7 +114,7 @@ $ docker network create consul-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `consul-network` network.
```console
$ docker run --name consul-node1 --network consul-network bitnami/consul:latest
docker run --name consul-node1 --network consul-network bitnami/consul:latest
```
#### Step 3: Run another containers
@ -149,16 +149,16 @@ services:
Then, launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Setting up a cluster
### Docker Compose
### Docker Compose deployment
This is the simplest way to run HashiCorp Consul with clustering configuration:
##### Step 1: Add a server node in your `docker-compose.yml`
#### Step 1: Add a server node in your `docker-compose.yml`
Copy the snippet below into your docker-compose.yml to add a HashiCorp Consul server node to your cluster configuration.
@ -286,27 +286,27 @@ volumes:
When you start the HashiCorp Consul image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. The following environment values are provided to custom HashiCorp Consul:
- `CONSUL_AGENT_MODE`: Indicates if HashiCorp Consul is running in server or client mode. Valid values: server, client. Default: **server**.
- `CONSUL_SERF_LAN_ADDRESS`: Address used for Serf LAN communications. Default: **0.0.0.0**.
- `CONSUL_CLIENT_LAN_ADDRESS`: Address in which HashiCorp Consul will bind client interfaces. Default: **0.0.0.0**.
- `CONSUL_SERF_LAN_PORT_NUMBER`: Serf LAN port. Defualt: **8301**.
- `CONSUL_HTTP_PORT_NUMBER`: HTTP API port, used also for the UI. Default: **8500**.
- `CONSUL_DNS_PORT_NUMBER`: DNS service port. Default: **8600**.
- `CONSUL_RPC_PORT_NUMBER`: Server RPC port. Default: **8300**.
- `CONSUL_RAFT_MULTIPLIER`: An integer multiplier used by HashiCorp Consul servers to scale key Raft timing parameters. Default: **1**.
- `CONSUL_LOCAL_CONFIG`: Custom user configuration that will be added as a file in the config dir.
- `CONSUL_GOSSIP_ENCRYPTION`: Enable Gossip encryption. Default: **no**.
- `CONSUL_GOSSIP_ENCRYPTION_KEY`: Gossip private simmetric key.
- `CONSUL_GOSSIP_ENCRYPTION_KEY_FILE`: File containing the gossip private simmetric key. If both `CONSUL_GOSSIP_ENCRYPTION_KEY` and `CONSUL_GOSSIP_ENCRYPTION_KEY_FILE` are provided, consul will use the `CONSUL_GOSSIP_ENCRYPTION_KEY_FILE`.
- `CONSUL_DISABLE_KEYRING_FILE`: If set, the keyring will not be persisted to a file. Valid vaules: true, false. Default: **false**.
- `CONSUL_ENABLE_UI`: Enable web user interface. Valid values: true, false. Default: **true**.
- `CONSUL_BOOTSTRAP_EXPECT`: Number of expected nodes in the cluster, including itself. Default: **1**.
- `CONSUL_DOMAIN`: HashiCorp Consul domain name. Default: **consul**.
- `CONSUL_DATACENTER"`: The datacenter in which the agent is running. Default: **dc1**.
- `CONSUL_RETRY_JOIN_ADDRESS`: "Address of another agent to join upon starting up. Default: **127.0.0.1**
- `CONSUL_RETRY_JOIN_WAN_ADDRESS`: "Address of another WAN agent to join upon starting up. Default: **127.0.0.1**
- `CONSUL_BIND_INTERFACE`: The interface that will be bound to for internal cluster communications.
- `CONSUL_DISABLE_HOST_NODE_ID`: Flag to prevent Consul from using information from the host to generate a deterministic node ID. Default: **true**.
* `CONSUL_AGENT_MODE`: Indicates if HashiCorp Consul is running in server or client mode. Valid values: server, client. Default: **server**.
* `CONSUL_SERF_LAN_ADDRESS`: Address used for Serf LAN communications. Default: **0.0.0.0**.
* `CONSUL_CLIENT_LAN_ADDRESS`: Address in which HashiCorp Consul will bind client interfaces. Default: **0.0.0.0**.
* `CONSUL_SERF_LAN_PORT_NUMBER`: Serf LAN port. Defualt: **8301**.
* `CONSUL_HTTP_PORT_NUMBER`: HTTP API port, used also for the UI. Default: **8500**.
* `CONSUL_DNS_PORT_NUMBER`: DNS service port. Default: **8600**.
* `CONSUL_RPC_PORT_NUMBER`: Server RPC port. Default: **8300**.
* `CONSUL_RAFT_MULTIPLIER`: An integer multiplier used by HashiCorp Consul servers to scale key Raft timing parameters. Default: **1**.
* `CONSUL_LOCAL_CONFIG`: Custom user configuration that will be added as a file in the config dir.
* `CONSUL_GOSSIP_ENCRYPTION`: Enable Gossip encryption. Default: **no**.
* `CONSUL_GOSSIP_ENCRYPTION_KEY`: Gossip private simmetric key.
* `CONSUL_GOSSIP_ENCRYPTION_KEY_FILE`: File containing the gossip private simmetric key. If both `CONSUL_GOSSIP_ENCRYPTION_KEY` and `CONSUL_GOSSIP_ENCRYPTION_KEY_FILE` are provided, consul will use the `CONSUL_GOSSIP_ENCRYPTION_KEY_FILE`.
* `CONSUL_DISABLE_KEYRING_FILE`: If set, the keyring will not be persisted to a file. Valid vaules: true, false. Default: **false**.
* `CONSUL_ENABLE_UI`: Enable web user interface. Valid values: true, false. Default: **true**.
* `CONSUL_BOOTSTRAP_EXPECT`: Number of expected nodes in the cluster, including itself. Default: **1**.
* `CONSUL_DOMAIN`: HashiCorp Consul domain name. Default: **consul**.
* `CONSUL_DATACENTER"`: The datacenter in which the agent is running. Default: **dc1**.
* `CONSUL_RETRY_JOIN_ADDRESS`: "Address of another agent to join upon starting up. Default: **127.0.0.1**
* `CONSUL_RETRY_JOIN_WAN_ADDRESS`: "Address of another WAN agent to join upon starting up. Default: **127.0.0.1**
* `CONSUL_BIND_INTERFACE`: The interface that will be bound to for internal cluster communications.
* `CONSUL_DISABLE_HOST_NODE_ID`: Flag to prevent Consul from using information from the host to generate a deterministic node ID. Default: **true**.
#### Specifying Environment Variables using Docker Compose
@ -320,15 +320,15 @@ consul:
#### Specifying Environment Variables on the Docker command line
```console
$ docker run -d -e CONSUL_HTTP_PORT_NUMBER=8888 --name consul bitnami/consul:latest
docker run -d -e CONSUL_HTTP_PORT_NUMBER=8888 --name consul bitnami/consul:latest
```
### Using custom HashiCorp Consul configuration files
In order to load your own configuration files, you will have to make them available to the container. You can do it doing the following:
- Mounting a volume with your custom configuration
- Adding custom configuration via environment variable.
* Mounting a volume with your custom configuration
* Adding custom configuration via environment variable.
By default, the configuration of HashiCorp Consul is written to `/opt/bitnami/consul/consul.json` file and persisted with the following content:
@ -360,7 +360,7 @@ By default, the configuration of HashiCorp Consul is written to `/opt/bitnami/co
Configuration can be added by passing the configuration in JSON format via the environment variable `CONSUL_LOCAL_CONFIG`. Then consul will write a `local.json` file in the HashiCorp Consul configuration directory. HashiCorp Consul will load all files within the configuration directory in alphabetical order, so ones with starting with higher letters will prevail.
```console
$ docker run -d -e CONSUL_LOCAL_CONFIG='{
docker run -d -e CONSUL_LOCAL_CONFIG='{
"datacenter":"us_west",
"server":true,
"enable_debug":true
@ -373,19 +373,20 @@ $ docker run -d -e CONSUL_LOCAL_CONFIG='{
Check the [Persisting your data](# Persisting your application) section to add custom volumes to the HashiCorp Consul container
### Configuring the Gossip encryption key
Specifies the secret key to use for encryption of HashiCorp Consul network traffic. This key must be 16-bytes that are Base64-encoded. The easiest way to create an encryption key is to use `consul keygen`
```console
$ docker run --name consul bitnami/consul:latest consul keygen
docker run --name consul bitnami/consul:latest consul keygen
```
This command will generate a keygen, that you can add to your Dockerfile, docker-compose or pass it via command line:
```console
$ docker run -e CONSUL_GOSSIP_ENCRYPTION_KEY=YOUR_GENERATED_KEY --name consul bitnami/consul:latest
docker run -e CONSUL_GOSSIP_ENCRYPTION_KEY=YOUR_GENERATED_KEY --name consul bitnami/consul:latest
```
#### Using Docker Compose
#### Using Docker Compose deployment
```yaml
consul:
@ -394,7 +395,6 @@ consul:
- '/local/path/to/your/confDir:/opt/bitnami/consul/conf'
```
The container has a HashiCorp Consul configuration directory set up at /consul/config and the agent will load any configuration files placed here by binding a volume or by composing a new image and adding files. Alternatively, configuration can be added by passing the configuration JSON via environment variable CONSUL_LOCAL_CONFIG. If this is bind mounted then ownership will be changed to the consul user when the container starts.
## Logging
@ -402,13 +402,13 @@ The container has a HashiCorp Consul configuration directory set up at /consul/c
The Bitnami consul Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs consul
docker logs consul
```
or using Docker Compose:
```console
$ docker-compose logs consul
docker-compose logs consul
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -422,7 +422,7 @@ Bitnami provides up-to-date versions of consul, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/consul:latest
docker pull bitnami/consul:latest
```
or if you're using Docker Compose, update the value of the image property to
@ -433,19 +433,19 @@ or if you're using Docker Compose, update the value of the image property to
Stop the currently running container using the command
```console
$ docker stop consul
docker stop consul
```
or using Docker Compose:
```console
$ docker-compose stop consul
docker-compose stop consul
```
Next, take a snapshot of the persistent volume `/path/to/consul-persistence` using:
```console
$ rsync -a /path/to/consul-persistence /path/to/consul-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/consul-persistence /path/to/consul-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the database state should the upgrade fail.
@ -453,27 +453,27 @@ You can use this snapshot to restore the database state should the upgrade fail.
#### Step 3: Remove the currently running container
```console
$ docker rm -v consul
docker rm -v consul
```
or using Docker Compose:
```console
$ docker-compose rm -v consul
docker-compose rm -v consul
```
#### Step 4: Run the new image
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
Re-create your container from the new image, restoring your backup if necessary.
```console
$ docker run --name consul bitnami/consul:latest
docker run --name consul bitnami/consul:latest
```
or using Docker Compose:
```console
$ docker-compose up consul
docker-compose up consul
```
## Notable Changes
@ -491,7 +491,7 @@ Also, some env var changes have been performed maintaining backward compatibilit
### 1.4.0-r16
- The Consul container has been migrated to a non-root user approach. Previously the container ran as the `root` user and the Consul daemon was started as the `consul` user. From now on, both the container and the Consul daemon run as user `1001`. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
* The Consul container has been migrated to a non-root user approach. Previously the container ran as the `root` user and the Consul daemon was started as the `consul` user. From now on, both the container and the Consul daemon run as user `1001`. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
## Contributing
@ -502,13 +502,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/contour-operator/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name contour-operator bitnami/contour-operator:latest
docker run --name contour-operator bitnami/contour-operator:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Contour Operator Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/contour-operator).
```console
$ docker pull bitnami/contour-operator:latest
docker pull bitnami/contour-operator:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/contour-operator/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/contour-operator:[TAG]
docker pull bitnami/contour-operator:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,14 +64,14 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `contour-operator -contour-image bitnami/contour-operator` you can follow the example below:
```console
$ docker run --rm --name contour-operator bitnami/contour-operator:latest -- -contour-image bitnami/contour-operator
docker run --rm --name contour-operator bitnami/contour-operator:latest -- -contour-image bitnami/contour-operator
```
Check the [official Contour Operator documentation](https://github.com/projectcontour/contour-operator) for more information.
## Notable changes
# 1.19.1-scratch-r6 Rename branch 1.20
### 1.19.1-scratch-r6 Rename branch 1.20
- Branch 1 has been renamed into branch 1.20 in order to follow the upstream [Contour major versions](https://github.com/projectcontour/contour/releases).
@ -91,7 +91,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

38
bitnami/contour/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name contour bitnami/contour:latest
docker run --name contour bitnami/contour:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/contour/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/contour/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -47,21 +47,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami contour Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/contour).
```console
$ docker pull bitnami/contour:latest
docker pull bitnami/contour:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/contour/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/contour:[TAG]
docker pull bitnami/contour:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -71,7 +71,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/contour-persistence:/bitnami/contour \
bitnami/contour:latest
```
@ -97,7 +97,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create contour-network --driver bridge
docker network create contour-network --driver bridge
```
#### Step 2: Launch the contour container within your network
@ -105,7 +105,7 @@ $ docker network create contour-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `contour-network` network.
```console
$ docker run --name contour-node1 --network contour-network bitnami/contour:latest
docker run --name contour-node1 --network contour-network bitnami/contour:latest
```
#### Step 3: Run another containers
@ -121,7 +121,7 @@ Find how to configure Contour in its [official documentation](https://projectcon
The Bitnami contour Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs contour
docker logs contour
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -135,7 +135,7 @@ Bitnami provides up-to-date versions of contour, including security patches, soo
#### Step 1: Get the updated image
```console
$ docker pull bitnami/contour:latest
docker pull bitnami/contour:latest
```
#### Step 2: Stop the running container
@ -143,13 +143,13 @@ $ docker pull bitnami/contour:latest
Stop the currently running container using the command
```console
$ docker stop contour
docker stop contour
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v contour
docker rm -v contour
```
#### Step 4: Run the new image
@ -157,14 +157,14 @@ $ docker rm -v contour
Re-create your container from the new image.
```console
$ docker run --name contour bitnami/contour:latest
docker run --name contour bitnami/contour:latest
```
## Notable Changes
# 1.20.0-debian-10-r8 Rename branch 1.20
### 1.20.0-debian-10-r8 Rename branch 1.20
- Branch 1 has been renamed into branch 1.20 in order to follow the upstream [Contour major versions](https://github.com/projectcontour/contour/releases).
* Branch 1 has been renamed into branch 1.20 in order to follow the upstream [Contour major versions](https://github.com/projectcontour/contour/releases).
## Contributing
@ -182,7 +182,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/cosign/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name cosign bitnami/cosign
docker run -it --name cosign bitnami/cosign
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cosign/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/cosign/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Cosign Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/cosign).
```console
$ docker pull bitnami/cosign:latest
docker pull bitnami/cosign:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/cosign/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/cosign:[TAG]
docker pull bitnami/cosign:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -69,7 +69,7 @@ Bitnami provides up-to-date versions of Cosign, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/cosign:latest
docker pull bitnami/cosign:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/cosign:latest`.
@ -77,13 +77,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v cosign
docker rm -v cosign
```
or using Docker Compose:
```console
$ docker-compose rm -v cosign
docker-compose rm -v cosign
```
#### Step 3: Run the new image
@ -91,13 +91,13 @@ $ docker-compose rm -v cosign
Re-create your container from the new image.
```console
$ docker run --name cosign bitnami/cosign:latest
docker run --name cosign bitnami/cosign:latest
```
or using Docker Compose:
```console
$ docker-compose up cosign
docker-compose up cosign
```
## Configuration
@ -107,7 +107,7 @@ $ docker-compose up cosign
To run commands inside this container you can use `docker run`, for example to execute `cosign --help` you can follow the example below:
```console
$ docker run --rm --name cosign bitnami/cosign:latest --help
docker run --rm --name cosign bitnami/cosign:latest --help
```
Check the [official Cosign documentation](https://github.com/sigstore/cosigndocs/) for more information about how to use Cosign.
@ -128,7 +128,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

82
bitnami/couchdb/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name couchdb bitnami/couchdb:latest
docker run --name couchdb bitnami/couchdb:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/couchdb/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/couchdb/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -47,21 +47,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami CouchDB Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/couchdb).
```console
$ docker pull bitnami/couchdb:latest
docker pull bitnami/couchdb:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/couchdb/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/couchdb:[TAG]
docker pull bitnami/couchdb:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -71,7 +71,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/couchdb-persistence:/bitnami/couchdb \
bitnami/couchdb:latest
```
@ -99,7 +99,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create couchdb-network --driver bridge
docker network create couchdb-network --driver bridge
```
#### Step 2: Launch the CouchDB container within your network
@ -107,7 +107,7 @@ $ docker network create couchdb-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `couchdb-network` network.
```console
$ docker run --name couchdb-node1 --network couchdb-network bitnami/couchdb:latest
docker run --name couchdb-node1 --network couchdb-network bitnami/couchdb:latest
```
#### Step 3: Run another containers
@ -118,21 +118,21 @@ We can launch another containers using the same flag (`--network NETWORK`) in th
The configuration can easily be setup in the Bitnami CouchDB Docker image by using the following environment variables:
- `COUCHDB_NODENAME`: A server alias for clustering support. Default: **couchdb@127.0.0.1**
- `COUCHDB_PORT_NUMBER`: Standard port for all HTTP API requests. Default: **5984**
- `COUCHDB_CLUSTER_PORT_NUMBER`: Port for cluster communication. Default: **9100**
- `COUCHDB_BIND_ADDRESS`: Address binding for the standard port. Default: **0.0.0.0**
- `COUCHDB_CREATE_DATABASES`: If set to yes, during the first initialization of the container the system databases will be created. Default: **yes**
- `COUCHDB_USER`: The username of the administrator user when authentication is enabled. Default: **admin**
- `COUCHDB_PASSWORD`: The password to use for login with the admin user set in the `COUCHDB_USER` environment variable. Default: **couchdb**
- `COUCHDB_PASSWORD_FILE`: Path to a file that contains the password for the custom user set in the `COUCHDB_USER` environment variable. This will override the value specified in `COUCHDB_PASSWORD`. No defaults.
- `COUCHDB_SECRET`: The secret token for Proxy and Cookie Authentication. If it is not specified, it will be randomly generated. No defaults.
- `COUCHDB_SECRET_FILE`: Path to a file that contains the contents of the secret parameter for CouchDB. This will override the value specified in `COUCHDB_SECRET`. No defaults.
* `COUCHDB_NODENAME`: A server alias for clustering support. Default: **couchdb@127.0.0.1**
* `COUCHDB_PORT_NUMBER`: Standard port for all HTTP API requests. Default: **5984**
* `COUCHDB_CLUSTER_PORT_NUMBER`: Port for cluster communication. Default: **9100**
* `COUCHDB_BIND_ADDRESS`: Address binding for the standard port. Default: **0.0.0.0**
* `COUCHDB_CREATE_DATABASES`: If set to yes, during the first initialization of the container the system databases will be created. Default: **yes**
* `COUCHDB_USER`: The username of the administrator user when authentication is enabled. Default: **admin**
* `COUCHDB_PASSWORD`: The password to use for login with the admin user set in the `COUCHDB_USER` environment variable. Default: **couchdb**
* `COUCHDB_PASSWORD_FILE`: Path to a file that contains the password for the custom user set in the `COUCHDB_USER` environment variable. This will override the value specified in `COUCHDB_PASSWORD`. No defaults.
* `COUCHDB_SECRET`: The secret token for Proxy and Cookie Authentication. If it is not specified, it will be randomly generated. No defaults.
* `COUCHDB_SECRET_FILE`: Path to a file that contains the contents of the secret parameter for CouchDB. This will override the value specified in `COUCHDB_SECRET`. No defaults.
You can specify these environment variables in the `docker run` command:
```console
$ docker run --name couchdb -e COUCHDB_PORT_NUMBER=7777 bitnami/couchdb:latest
docker run --name couchdb -e COUCHDB_PORT_NUMBER=7777 bitnami/couchdb:latest
```
or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/couchdb/docker-compose.yml) file present in this repository:
@ -157,7 +157,7 @@ To understand the precedence of the different configuration files, please check
Run the CouchDB image, mounting a directory from your host.
```console
$ docker run --name couchdb -v /path/to/config/dir:/opt/bitnami/couchdb/etc bitnami/couchdb:latest
docker run --name couchdb -v /path/to/config/dir:/opt/bitnami/couchdb/etc bitnami/couchdb:latest
```
or using Docker Compose:
@ -184,29 +184,29 @@ vi /path/to/config/file/10-custom.ini
After changing the configuration, restart your CouchDB container for changes to take effect.
```console
$ docker restart couchdb
docker restart couchdb
```
or using Docker Compose:
```console
$ docker-compose restart couchdb
docker-compose restart couchdb
```
### Clustering configuration
In order to configure CouchDB as a cluster of nodes, please make sure you set proper values for the following environment variables:
- `COUCHDB_NODENAME`. A server alias. It should be different on each container.
- `COUCHDB_CLUSTER_PORT_NUMBER`: Port for cluster communication. Default: **9100**
- `COUCHDB_CREATE_DATABASES`: Whether to create the system databases or not. You should only set it to yes in one of the nodes. Default: **yes**
* `COUCHDB_NODENAME`. A server alias. It should be different on each container.
* `COUCHDB_CLUSTER_PORT_NUMBER`: Port for cluster communication. Default: **9100**
* `COUCHDB_CREATE_DATABASES`: Whether to create the system databases or not. You should only set it to yes in one of the nodes. Default: **yes**
## Logging
The Bitnami CouchDB Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs couchdb
docker logs couchdb
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -219,8 +219,8 @@ The Bitnami CouchDB Docker image is designed to be extended so it can be used as
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can change the port used by CouchDB by setting the environment variable `COUCHDB_PORT_NUMBER`.
- [Replacing or adding your own configuration files](#mounting-your-own-configuration-files).
* Settings that can be adapted using environment variables. For instance, you can change the port used by CouchDB by setting the environment variable `COUCHDB_PORT_NUMBER`.
* [Replacing or adding your own configuration files](#mounting-your-own-configuration-files).
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
@ -232,9 +232,9 @@ FROM bitnami/couchdb
Here is an example of extending the image with the following modifications:
- Install the `vim` editor
- Modify the port used by CouchDB
- Change the user that runs the container
* Install the `vim` editor
* Modify the port used by CouchDB
* Change the user that runs the container
```Dockerfile
FROM bitnami/couchdb
@ -256,7 +256,7 @@ USER 1002
Based on the extended image, you can use a Docker Compose file like the one below to add other features:
- Add a custom configuration file
* Add a custom configuration file
```yaml
version: '2'
@ -285,7 +285,7 @@ Bitnami provides up-to-date versions of CouchDB, including security patches, soo
#### Step 1: Get the updated image
```console
$ docker pull bitnami/couchdb:latest
docker pull bitnami/couchdb:latest
```
#### Step 2: Stop the running container
@ -293,13 +293,13 @@ $ docker pull bitnami/couchdb:latest
Stop the currently running container using the command
```console
$ docker stop couchdb
docker stop couchdb
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v couchdb
docker rm -v couchdb
```
#### Step 4: Run the new image
@ -307,14 +307,14 @@ $ docker rm -v couchdb
Re-create your container from the new image.
```console
$ docker run --name couchdb bitnami/couchdb:latest
docker run --name couchdb bitnami/couchdb:latest
```
## Notable Changes
### 3.0.0-0-debian-10-r0
- The usage of 'ALLOW_ANONYMOUS_LOGIN' is now deprecated. Please, specify a password for the admin user (defaults to "admin") by setting the 'COUCHDB_PASSWORD' environment variable.
* The usage of 'ALLOW_ANONYMOUS_LOGIN' is now deprecated. Please, specify a password for the admin user (defaults to "admin") by setting the 'COUCHDB_PASSWORD' environment variable.
## Contributing
@ -340,7 +340,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/dex/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name dex bitnami/dex
docker run -it --name dex bitnami/dex
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dex/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dex/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Dex Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/dex).
```console
$ docker pull bitnami/dex:latest
docker pull bitnami/dex:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/dex/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/dex:[TAG]
docker pull bitnami/dex:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -69,7 +69,7 @@ Bitnami provides up-to-date versions of Dex, including security patches, soon af
#### Step 1: Get the updated image
```console
$ docker pull bitnami/dex:latest
docker pull bitnami/dex:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/dex:latest`.
@ -77,13 +77,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v dex
docker rm -v dex
```
or using Docker Compose:
```console
$ docker-compose rm -v dex
docker-compose rm -v dex
```
#### Step 3: Run the new image
@ -91,13 +91,13 @@ $ docker-compose rm -v dex
Re-create your container from the new image.
```console
$ docker run --name dex bitnami/dex:latest
docker run --name dex bitnami/dex:latest
```
or using Docker Compose:
```console
$ docker-compose up dex
docker-compose up dex
```
## Configuration
@ -107,7 +107,7 @@ $ docker-compose up dex
To run commands inside this container you can use `docker run`, for example to execute `dex --help` you can follow the example below:
```console
$ docker run --rm --name dex bitnami/dex:latest --help
docker run --rm --name dex bitnami/dex:latest --help
```
Check the [official Dex documentation](https://dexidp.io/docs/) for more information about how to use Dex.
@ -128,7 +128,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

148
bitnami/discourse/README.md
View File

@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/discourse/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/discourse/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@ -39,21 +39,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Discourse Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/discourse).
```console
$ docker pull bitnami/discourse:latest
docker pull bitnami/discourse:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/discourse/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/discourse:[TAG]
docker pull bitnami/discourse:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## How to use this image
@ -65,8 +65,8 @@ Discourse requires access to a PostgreSQL database to store information. We'll u
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/discourse/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/discourse/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/discourse/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -76,14 +76,14 @@ If you want to run the application manually instead of using `docker-compose`, t
#### Step 1: Create a network
```console
$ docker network create discourse-network
docker network create discourse-network
```
#### Step 2: Create a volume for PostgreSQL persistence and create a PostgreSQL container
```console
$ docker volume create --name postgresql_data
$ docker run -d --name postgresql \
docker volume create --name postgresql_data
docker run -d --name postgresql \
--env ALLOW_EMPTY_PASSWORD=yes \
--env POSTGRESQL_USERNAME=bn_discourse \
--env POSTGRESQL_PASSWORD=bitnami123 \
@ -96,8 +96,8 @@ $ docker run -d --name postgresql \
#### Step 3: Create a volume for Redis persistence and create a Redis container
```console
$ docker volume create --name redis_data
$ docker run -d --name redis \
docker volume create --name redis_data
docker run -d --name redis \
--env ALLOW_EMPTY_PASSWORD=yes \
--network discourse-network \
--volume redis_data:/bitnami/redis \
@ -107,8 +107,8 @@ $ docker run -d --name redis \
#### Step 4: Create volumes for Discourse persistence and launch the container
```console
$ docker volume create --name discourse_data
$ docker run -d --name discourse \
docker volume create --name discourse_data
docker run -d --name discourse \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env DISCOURSE_DATABASE_USER=bn_discourse \
@ -123,7 +123,7 @@ $ docker run -d --name discourse \
#### Step 5: Launch the Sidekiq container
```console
$ docker run -d --name sidekiq \
docker run -d --name sidekiq \
--network discourse-network \
--volume discourse_data:/bitnami/discourse \
bitnami/discourse:latest /opt/bitnami/scripts/discourse-sidekiq/run.sh
@ -135,7 +135,7 @@ Access your application at `http://your-ip/`
If you need to run discourse administrative commands like [Create admin account from console](https://meta.discourse.org/t/create-admin-account-from-console/17274), you can do so by executing a shell inside the container and running with the proper environment variables.
```
```console
cd /opt/bitnami/discourse
RAILS_ENV=production bundle exec rake admin:create
```
@ -193,13 +193,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
#### Step 1: Create a network (if it does not exist)
```console
$ docker network create discourse-network
docker network create discourse-network
```
#### Step 2. Create a PostgreSQL container with host volume
```console
$ docker run -d --name postgresql \
docker run -d --name postgresql \
--env ALLOW_EMPTY_PASSWORD=yes \
--env POSTGRESQL_USERNAME=bn_discourse \
--env POSTGRESQL_PASSWORD=bitnami123 \
@ -212,7 +212,7 @@ $ docker run -d --name postgresql \
#### Step 3. Create a Redis container with host volume
```console
$ docker run -d --name redis \
docker run -d --name redis \
--env ALLOW_EMPTY_PASSWORD=yes \
--network discourse-network \
--volume /path/to/redis-persistence:/bitnami/redis \
@ -222,7 +222,7 @@ $ docker run -d --name redis \
#### Step 4. Create the Discourse container with host volumes
```console
$ docker run -d --name discourse \
docker run -d --name discourse \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env DISCOURSE_DATABASE_USER=bn_discourse \
@ -237,7 +237,7 @@ $ docker run -d --name discourse \
#### Step 5. Create the Sidekiq container with host volumes
```console
$ docker run -d --name sidekiq \
docker run -d --name sidekiq \
--network discourse-network \
--volume /path/to/discourse-persistence:/bitnami/discourse \
bitnami/discourse:latest
@ -272,7 +272,7 @@ When you start the Discourse image, you can adjust the configuration of the inst
- For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name discourse -p 80:8080 -p 443:8443 \
docker run -d --name discourse -p 80:8080 -p 443:8443 \
--env DISCOURSE_PASSWORD=my_password \
--network discourse-tier \
--volume /path/to/discourse-persistence:/bitnami \
@ -281,7 +281,7 @@ When you start the Discourse image, you can adjust the configuration of the inst
Available environment variables:
##### User and Site configuration
#### User and Site configuration
- `DISCOURSE_ENABLE_HTTPS`: Whether to use HTTPS by default. Default: **no**
- `DISCOURSE_EXTERNAL_HTTP_PORT_NUMBER`: Port to used by Discourse to generate URLs and links when accessing using HTTP. Will be ignored if multisite mode is not enabled. Default **80**
@ -302,7 +302,7 @@ Available environment variables:
- `DISCOURSE_ENABLE_CONF_PERSISTENCE`: Whether to enable persistence of the Discourse `discourse.conf` configuration file. Default: **no**
- `DISCOURSE_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. This is necessary in case you use a database that already has Discourse data. Default: **no**
##### Database connection configuration
#### Database connection configuration
- `DISCOURSE_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
- `DISCOURSE_DATABASE_PORT_NUMBER`: Port used by the PostgreSQL server. Default: **5432**
@ -311,14 +311,14 @@ Available environment variables:
- `DISCOURSE_DATABASE_PASSWORD`: Database password that Discourse will use to connect with the database. No defaults.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### Redis connection configuration
#### Redis connection configuration
- `DISCOURSE_REDIS_HOST`: Hostname for Redis(R). Default: **redis**
- `DISCOURSE_REDIS_PORT_NUMBER`: Port used by Redis(R). Default: **6379**
- `DISCOURSE_REDIS_PASSWORD`: Password for Redis(R).
- `DISCOURSE_REDIS_USE_SSL`: Whether to enable SSL for Redis(R). Default: **no**
##### Create a database for Discourse using postgresql-client
#### Create a database for Discourse using postgresql-client
- `POSTGRESQL_CLIENT_DATABASE_HOST`: Hostname for the PostgreSQL server. Default: **postgresql**
- `POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by the PostgreSQL server. Default: **5432**
@ -331,7 +331,7 @@ Available environment variables:
- `POSTGRESQL_CLIENT_EXECUTE_SQL`: SQL code to execute in the PostgreSQL server. No defaults.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### SMTP Configuration
#### SMTP Configuration
To configure Discourse to send email using SMTP you can set the following environment variables:
@ -375,44 +375,44 @@ This would be an example of SMTP configuration using a Gmail account:
- For manual execution:
- First, create the Discourse container:
- First, create the Discourse container:
```console
$ docker run -d --name discourse -p 80:8080 -p 443:8443 \
--env DISCOURSE_DATABASE_USER=bn_discourse \
--env DISCOURSE_DATABASE_NAME=bitnami_discourse \
--env DISCOURSE_SMTP_HOST=smtp.gmail.com \
--env DISCOURSE_SMTP_PORT=587 \
--env DISCOURSE_SMTP_USER=your_email@gmail.com \
--env DISCOURSE_SMTP_PASSWORD=your_password \
--env DISCOURSE_SMTP_PROTOCOL=tls \
--network discourse-tier \
--volume /path/to/discourse-persistence:/bitnami \
bitnami/discourse:latest
```
```console
docker run -d --name discourse -p 80:8080 -p 443:8443 \
--env DISCOURSE_DATABASE_USER=bn_discourse \
--env DISCOURSE_DATABASE_NAME=bitnami_discourse \
--env DISCOURSE_SMTP_HOST=smtp.gmail.com \
--env DISCOURSE_SMTP_PORT=587 \
--env DISCOURSE_SMTP_USER=your_email@gmail.com \
--env DISCOURSE_SMTP_PASSWORD=your_password \
--env DISCOURSE_SMTP_PROTOCOL=tls \
--network discourse-tier \
--volume /path/to/discourse-persistence:/bitnami \
bitnami/discourse:latest
```
- Then, create the Sidekiq container:
- Then, create the Sidekiq container:
```console
$ docker run -d --name sidekiq \
--env DISCOURSE_DATABASE_USER=bn_discourse \
--env DISCOURSE_DATABASE_NAME=bitnami_discourse \
--env DISCOURSE_SMTP_HOST=smtp.gmail.com \
--env DISCOURSE_SMTP_PORT=587 \
--env DISCOURSE_SMTP_USER=your_email@gmail.com \
--env DISCOURSE_SMTP_PASSWORD=your_password \
--env DISCOURSE_SMTP_PROTOCOL=tls \
--network discourse-tier \
--volume /path/to/discourse-persistence:/bitnami \
bitnami/discourse:latest
```
```console
docker run -d --name sidekiq \
--env DISCOURSE_DATABASE_USER=bn_discourse \
--env DISCOURSE_DATABASE_NAME=bitnami_discourse \
--env DISCOURSE_SMTP_HOST=smtp.gmail.com \
--env DISCOURSE_SMTP_PORT=587 \
--env DISCOURSE_SMTP_USER=your_email@gmail.com \
--env DISCOURSE_SMTP_PASSWORD=your_password \
--env DISCOURSE_SMTP_PROTOCOL=tls \
--network discourse-tier \
--volume /path/to/discourse-persistence:/bitnami \
bitnami/discourse:latest
```
In order to verify your configuration works properly, you can test your configuration parameters from the container itself.
```console
$ docker run -u root -it bitnami/discourse:latest bash
$ install_packages swaks
$ swaks --to your_email@domain.com --from your_email@domain.com --server your.smtp.server.com --auth LOGIN --auth-user your_email@domain.com -tls
docker run -u root -it bitnami/discourse:latest bash
install_packages swaks
swaks --to your_email@domain.com --from your_email@domain.com --server your.smtp.server.com --auth LOGIN --auth-user your_email@domain.com -tls
```
See the [documentation on troubleshooting SMTP issues](https://docs.bitnami.com/general/how-to/troubleshoot-smtp-issues/) if there are problems.
@ -440,7 +440,7 @@ The Bitnami Discourse container supports connecting the Discourse application to
- For manual execution:
```console
$ docker run -d --name discourse\
docker run -d --name discourse\
-p 8080:8080 -p 8443:8443 \
--network discourse-network \
--env DISCOURSE_DATABASE_HOST=mariadb_host \
@ -459,13 +459,13 @@ In case the database already contains data from a previous Discourse installatio
The Bitnami Discourse Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs discourse
docker logs discourse
```
Or using Docker Compose:
```console
$ docker-compose logs discourse
docker-compose logs discourse
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -479,13 +479,13 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
```console
$ docker stop discourse
docker stop discourse
```
Or using Docker Compose:
```console
$ docker-compose stop discourse
docker-compose stop discourse
```
#### Step 2: Run the backup command
@ -493,7 +493,7 @@ $ docker-compose stop discourse
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/discourse-backups:/backups --volumes-from discourse busybox \
docker run --rm -v /path/to/discourse-backups:/backups --volumes-from discourse busybox \
cp -a /bitnami/discourse /backups/latest
```
@ -504,7 +504,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the PostgreSQL database container:
```diff
$ docker run -d --name postgresql \
docker run -d --name postgresql \
...
- --volume /path/to/postgresql-persistence:/bitnami/postgresql \
+ --volume /path/to/postgresql-backups/latest:/bitnami/postgresql \
@ -514,7 +514,7 @@ For the PostgreSQL database container:
For the Discourse container:
```diff
$ docker run -d --name discourse \
docker run -d --name discourse \
...
- --volume /path/to/discourse-persistence:/bitnami/discourse \
+ --volume /path/to/discourse-backups/latest:/bitnami/discourse \
@ -523,14 +523,14 @@ For the Discourse container:
### Upgrade this image
Bitnami provides up-to-date versions of PostgreSQL and Discourse, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Discourse container. For the PostgreSQL upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/postgresql/blob/master/README.md#upgrade-this-image
Bitnami provides up-to-date versions of PostgreSQL and Discourse, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Discourse container. For the PostgreSQL upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/postgresql/blob/master/README.md#upgrade-this-image>
The `bitnami/discourse:latest` tag always points to the most recent release. To get the most recent release you can simple repull the `latest` tag from the Docker Hub with `docker pull bitnami/discourse:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/discourse/tags/).
#### Step 1: Get the updated image
```console
$ docker pull bitnami/discourse:latest
docker pull bitnami/discourse:latest
```
#### Step 2: Stop the running container
@ -538,7 +538,7 @@ $ docker pull bitnami/discourse:latest
Stop the currently running container using the command
```console
$ docker-compose stop discourse
docker-compose stop discourse
```
#### Step 3: Take a snapshot of the application state
@ -558,10 +558,10 @@ docker-compose rm -v discourse
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
# Notable Changes
## Notable Changes
### 2.7.0-debian-10-r4
@ -604,7 +604,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

122
bitnami/dokuwiki/README.md
View File

@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dokuwiki/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dokuwiki/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami DokuWiki Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/dokuwiki).
```console
$ docker pull bitnami/dokuwiki:latest
docker pull bitnami/dokuwiki:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/dokuwiki/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/dokuwiki:[TAG]
docker pull bitnami/dokuwiki:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -93,13 +93,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
#### Step 1: Create a network (if it does not exist)
```console
$ docker network create dokuwiki-network
docker network create dokuwiki-network
```
#### Step 2. Create the DokuWiki container with host volumes
```console
$ docker run -d --name dokuwiki \
docker run -d --name dokuwiki \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--network dokuwiki-network \
@ -113,7 +113,7 @@ $ docker run -d --name dokuwiki \
When you start the DokuWiki image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/dokuwiki/docker-compose.yml) file present in this repository:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/dokuwiki/docker-compose.yml) file present in this repository:
```yaml
dokuwiki:
@ -123,10 +123,10 @@ dokuwiki:
...
```
* For manual execution add a `--env` option with each variable and value:
* For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name dokuwiki -p 80:8080 -p 443:8443 \
docker run -d --name dokuwiki -p 80:8080 -p 443:8443 \
--env DOKUWIKI_PASSWORD=my_password \
--network dokuwiki-tier \
--volume /path/to/dokuwiki-persistence:/bitnami/dokuwiki \
@ -135,37 +135,37 @@ dokuwiki:
Available environment variables:
##### User and Site configuration
### User and Site configuration
- `DOKUWIKI_USERNAME`: Dokuwiki application username. Default: **user**
- `DOKUWIKI_FULL_NAME`: Dokuwiki application user full name. Default: **Full Name**
- `DOKUWIKI_PASSWORD`: Dokuwiki application password. Default: **bitnami1**
- `DOKUWIKI_EMAIL`: Dokuwiki application email. Default: **user@example.com**
- `DOKUWIKI_WIKI_NAME`: Dokuwiki wiki name. Default: **Bitnami DokuWiki**
* `DOKUWIKI_USERNAME`: Dokuwiki application username. Default: **user**
* `DOKUWIKI_FULL_NAME`: Dokuwiki application user full name. Default: **Full Name**
* `DOKUWIKI_PASSWORD`: Dokuwiki application password. Default: **bitnami1**
* `DOKUWIKI_EMAIL`: Dokuwiki application email. Default: **user@example.com**
* `DOKUWIKI_WIKI_NAME`: Dokuwiki wiki name. Default: **Bitnami DokuWiki**
##### PHP configuration
### PHP configuration
- `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
- `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
- `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
- `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
- `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
- `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
- `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
- `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
* `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
* `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
* `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
* `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
* `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
* `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
* `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
* `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
## Logging
The Bitnami DokuWiki Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs dokuwiki
docker logs dokuwiki
```
Or using Docker Compose:
```console
$ docker-compose logs dokuwiki
docker-compose logs dokuwiki
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -179,13 +179,13 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
```console
$ docker stop dokuwiki
docker stop dokuwiki
```
Or using Docker Compose:
```console
$ docker-compose stop dokuwiki
docker-compose stop dokuwiki
```
#### Step 2: Run the backup command
@ -193,7 +193,7 @@ $ docker-compose stop dokuwiki
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/dokuwiki-backups:/backups --volumes-from dokuwiki busybox \
docker run --rm -v /path/to/dokuwiki-backups:/backups --volumes-from dokuwiki busybox \
cp -a /bitnami/dokuwiki /backups/latest
```
@ -204,7 +204,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the DokuWiki container:
```diff
$ docker run -d --name \
docker run -d --name \
...
- --volume /path/to/-persistence:/bitnami/dokuwiki \
+ --volume /path/to/-backups/latest:/bitnami/dokuwiki \
@ -218,7 +218,7 @@ Bitnami provides up-to-date versions of DokuWiki, including security patches, so
#### Step 1: Get the updated image
```console
$ docker pull bitnami/dokuwiki:latest
docker pull bitnami/dokuwiki:latest
```
#### Step 2: Stop the running container
@ -226,7 +226,7 @@ $ docker pull bitnami/dokuwiki:latest
Stop the currently running container using the command
```console
$ docker-compose stop dokuwiki
docker-compose stop dokuwiki
```
#### Step 3: Take a snapshot of the application state
@ -246,7 +246,7 @@ docker-compose rm -v dokuwiki
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
## Customize this image
@ -257,10 +257,10 @@ The Bitnami DokuWiki Docker image is designed to be extended so it can be used a
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
- [Adding custom virtual hosts](https://github.com/bitnami/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
- [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
- [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/apache#using-custom-ssl-certificates).
* Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
* [Adding custom virtual hosts](https://github.com/bitnami/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
* [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
* [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/apache#using-custom-ssl-certificates).
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
@ -272,9 +272,9 @@ FROM bitnami/dokuwiki
Here is an example of extending the image with the following modifications:
- Install the `vim` editor
- Modify the Apache configuration file
- Modify the ports used by Apache
* Install the `vim` editor
* Modify the Apache configuration file
* Modify the ports used by Apache
```Dockerfile
FROM bitnami/dokuwiki
@ -316,38 +316,38 @@ Based on the extended image, you can update the [`docker-compose.yml`](https://g
### 20200729.0.0-debian-10-r6
- Enabled nice/friendly URLs (#52)
* Enabled nice/friendly URLs (#52)
### 20180422.4.0-debian-10-r0
- Changed versionioning to be shorter and more similar to the official version name.
* Changed versionioning to be shorter and more similar to the official version name.
### 0.20180422.202005011246-debian-10-r68
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
- The DokuWiki container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
- The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the DokuWiki site by exporting its content, and importing it on a new DokuWiki container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* The DokuWiki container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
* The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
* Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the DokuWiki site by exporting its content, and importing it on a new DokuWiki container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
### 0.20180422.201901061035-debian-9-r114 and 0.20180422.201901061035-ol-7-r128
- This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
- The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
- The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
- Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
* This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
* The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
* The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
* Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
### 0.20170219.201708232029-r3
- Custom smileys, available in `lib/images/smileys/local`, are now persisted.
- Address issue [#40](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40).
- In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42).
* Custom smileys, available in `lib/images/smileys/local`, are now persisted.
* Address issue [#40](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40).
* In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42).
### 0.20180422.201805030840-r5
- Custom InterWiki shortcut icons, available in `lib/images/interwiki/`, are now persisted.
- Address issue [#40](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40).
- In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42).
* Custom InterWiki shortcut icons, available in `lib/images/interwiki/`, are now persisted.
* Address issue [#40](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40).
* In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42).
## Contributing
@ -373,7 +373,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

34
bitnami/dotnet-sdk/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name dotnet-sdk bitnami/dotnet-sdk:latest
docker run --name dotnet-sdk bitnami/dotnet-sdk:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dotnet-sdk/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dotnet-sdk/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami .NET SDK Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/dotnet-sdk).
```console
$ docker pull bitnami/dotnet-sdk:latest
docker pull bitnami/dotnet-sdk:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/dotnet-sdk/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/dotnet-sdk:[TAG]
docker pull bitnami/dotnet-sdk:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -67,7 +67,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/dotnet-persistence:/bitnami \
bitnami/dotnet-sdk:latest
```
@ -93,7 +93,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create dotnet-network --driver bridge
docker network create dotnet-network --driver bridge
```
#### Step 2: Launch the .NET SDK container within your network
@ -101,7 +101,7 @@ $ docker network create dotnet-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `dotnet-network` network.
```console
$ docker run --name dotnet-node1 --network dotnet-network bitnami/dotnet-sdk:latest
docker run --name dotnet-node1 --network dotnet-network bitnami/dotnet-sdk:latest
```
#### Step 3: Run another containers
@ -113,7 +113,7 @@ We can launch another containers using the same flag (`--network NETWORK`) in th
The Bitnami .NET SDK Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs dotnet-sdk
docker logs dotnet-sdk
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -127,7 +127,7 @@ Bitnami provides up-to-date versions of .NET SDK, including security patches, so
#### Step 1: Get the updated image
```console
$ docker pull bitnami/dotnet-sdk:latest
docker pull bitnami/dotnet-sdk:latest
```
#### Step 2: Stop the running container
@ -135,13 +135,13 @@ $ docker pull bitnami/dotnet-sdk:latest
Stop the currently running container using the command
```console
$ docker stop dotnet-sdk
docker stop dotnet-sdk
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v dotnet-sdk
docker rm -v dotnet-sdk
```
#### Step 4: Run the new image
@ -149,7 +149,7 @@ $ docker rm -v dotnet-sdk
Re-create your container from the new image.
```console
$ docker run --name dotnet-sdk bitnami/dotnet-sdk:latest
docker run --name dotnet-sdk bitnami/dotnet-sdk:latest
```
## Contributing
@ -168,7 +168,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

34
bitnami/dotnet/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name dotnet bitnami/dotnet:latest
docker run --name dotnet bitnami/dotnet:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dotnet/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/dotnet/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Dotnet Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/dotnet).
```console
$ docker pull bitnami/dotnet:latest
docker pull bitnami/dotnet:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/dotnet/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/dotnet:[TAG]
docker pull bitnami/dotnet:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -67,7 +67,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/dotnet-persistence:/bitnami \
bitnami/dotnet:latest
```
@ -93,7 +93,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create dotnet-network --driver bridge
docker network create dotnet-network --driver bridge
```
#### Step 2: Launch the Dotnet container within your network
@ -101,7 +101,7 @@ $ docker network create dotnet-network --driver bridge
Use the `--network .NETWORK>` argument to the `docker run` command to attach the container to the `dotnet-network` network.
```console
$ docker run --name dotnet-node1 --network dotnet-network bitnami/dotnet:latest
docker run --name dotnet-node1 --network dotnet-network bitnami/dotnet:latest
```
#### Step 3: Run another containers
@ -113,7 +113,7 @@ We can launch another containers using the same flag (`--network.NETWORK`) in th
The Bitnami Dotnet Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs dotnet
docker logs dotnet
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -127,7 +127,7 @@ Bitnami provides up-to-date versions of Dotnet, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/dotnet:latest
docker pull bitnami/dotnet:latest
```
#### Step 2: Stop the running container
@ -135,13 +135,13 @@ $ docker pull bitnami/dotnet:latest
Stop the currently running container using the command
```console
$ docker stop dotnet
docker stop dotnet
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v dotnet
docker rm -v dotnet
```
#### Step 4: Run the new image
@ -149,7 +149,7 @@ $ docker rm -v dotnet
Re-create your container from the new image.
```console
$ docker run --name dotnet bitnami/dotnet:latest
docker run --name dotnet bitnami/dotnet:latest
```
## Contributing
@ -168,7 +168,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

209
bitnami/drupal-nginx/README.md
View File

@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal-nginx/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal-nginx/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Drupal Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/drupal-nginx).
```console
$ docker pull bitnami/drupal-nginx:latest
docker pull bitnami/drupal-nginx:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/drupal-nginx/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/drupal-nginx:[TAG]
docker pull bitnami/drupal-nginx:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## How to use this image
@ -71,25 +71,25 @@ Running Drupal with a database server is the recommended way. You can either use
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal-nginx/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal-nginx/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal-nginx/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
#### Run the application manually
If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:
##### 1. Create a new network for the application and the database:
##### 1. Create a new network for the application and the database
```console
$ docker network create drupal-network
docker network create drupal-network
```
##### 2. Create a volume for MariaDB persistence and create a MariaDB container
```console
$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
docker volume create --name mariadb_data
docker run -d --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
-e MARIADB_USER=bn_drupal \
-e MARIADB_DATABASE=bitnami_drupal \
@ -101,8 +101,8 @@ If you want to run the application manually instead of using docker-compose, the
##### 3. Create volumes for Drupal persistence and launch the container
```console
$ docker volume create --name drupal_data
$ docker run -d --name drupal -p 8080:8080 -p 8443:8443 \
docker volume create --name drupal_data
docker run -d --name drupal -p 8080:8080 -p 8443:8443 \
-e ALLOW_EMPTY_PASSWORD=yes \
-e DRUPAL_DATABASE_USER=bn_drupal \
-e DRUPAL_DATABASE_NAME=bitnami_drupal \
@ -154,13 +154,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
##### Step 1: Create a network (if it does not exist)
```console
$ docker network create drupal-network
docker network create drupal-network
```
##### 2. Create a MariaDB container with host volume:
##### 2. Create a MariaDB container with host volume
```console
$ docker run -d --name mariadb \
docker run -d --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
-e MARIADB_USER=bn_drupal \
-e MARIADB_PASSWORD=bitnami \
@ -173,7 +173,7 @@ $ docker run -d --name mariadb \
##### Step 3. Create the Drupal container with host volumes
```console
$ docker run -d --name drupal \
docker run -d --name drupal \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env DRUPAL_DATABASE_USER=bn_drupal \
@ -190,7 +190,7 @@ $ docker run -d --name drupal \
When you start the Drupal image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal-nginx/docker-compose.yml) file present in this repository:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal-nginx/docker-compose.yml) file present in this repository:
```yaml
drupal:
@ -200,10 +200,10 @@ drupal:
...
```
* For manual execution add a `--env` option with each variable and value:
* For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name drupal -p 80:8080 -p 443:8443 \
docker run -d --name drupal -p 80:8080 -p 443:8443 \
--env DRUPAL_PASSWORD=my_password \
--network drupal-tier \
--volume /path/to/drupal-persistence:/bitnami \
@ -212,74 +212,74 @@ drupal:
Available environment variables:
###### User and Site configuration
##### User and Site configuration
- `DRUPAL_PROFILE`: Drupal installation profile. Default: **standard**
- `DRUPAL_SITE_NAME`: Drupal blog name. Default: **My blog**
- `DRUPAL_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. Default: **no**
- `DRUPAL_ENABLE_MODULES`: Comma or space separated list of installed modules to enable during the first initialization. No defaults.
- `DRUPAL_USERNAME`: Drupal application username. Default: **user**
- `DRUPAL_PASSWORD`: Drupal application password. Default: **bitnami**
- `DRUPAL_EMAIL`: Drupal application email. Default: **user@example.com**
- `DRUPAL_CONFIG_SYNC_DIR`: Drupal sync configuration directory location. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
- `DRUPAL_HASH_SALT`: Drupal string used to generate random values. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
* `DRUPAL_PROFILE`: Drupal installation profile. Default: **standard**
* `DRUPAL_SITE_NAME`: Drupal blog name. Default: **My blog**
* `DRUPAL_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. Default: **no**
* `DRUPAL_ENABLE_MODULES`: Comma or space separated list of installed modules to enable during the first initialization. No defaults.
* `DRUPAL_USERNAME`: Drupal application username. Default: **user**
* `DRUPAL_PASSWORD`: Drupal application password. Default: **bitnami**
* `DRUPAL_EMAIL`: Drupal application email. Default: **user@example.com**
* `DRUPAL_CONFIG_SYNC_DIR`: Drupal sync configuration directory location. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
* `DRUPAL_HASH_SALT`: Drupal string used to generate random values. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
###### Use an existing database
##### Use an existing database
- `DRUPAL_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
- `DRUPAL_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
- `DRUPAL_DATABASE_NAME`: Database name that Drupal will use to connect with the database. Default: **bitnami_drupal**
- `DRUPAL_DATABASE_USER`: Database user that Drupal will use to connect with the database. Default: **bn_drupal**
- `DRUPAL_DATABASE_PASSWORD`: Database password that Drupal will use to connect with the database. No defaults.
- `DRUPAL_DATABASE_TLS_CA_FILE`: TLS CA certificate for connections. No defaults.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
* `DRUPAL_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
* `DRUPAL_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
* `DRUPAL_DATABASE_NAME`: Database name that Drupal will use to connect with the database. Default: **bitnami_drupal**
* `DRUPAL_DATABASE_USER`: Database user that Drupal will use to connect with the database. Default: **bn_drupal**
* `DRUPAL_DATABASE_PASSWORD`: Database password that Drupal will use to connect with the database. No defaults.
* `DRUPAL_DATABASE_TLS_CA_FILE`: TLS CA certificate for connections. No defaults.
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
###### Create a database for Drupal using mysql-client
##### Create a database for Drupal using mysql-client
- `MYSQL_CLIENT_FLAVOR`: SQL database flavor. Valid values: `mariadb` or `mysql`. Default: **mariadb**.
- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
- `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
- `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
- `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES`: Database privileges to grant for the user specified in `MYSQL_CLIENT_CREATE_DATABASE_USER` to the database specified in `MYSQL_CLIENT_CREATE_DATABASE_NAME`. No defaults.
- `MYSQL_CLIENT_ENABLE_SSL_WRAPPER`: Whether to force SSL connections to the database via the `mysql` CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: **no**
- `MYSQL_CLIENT_ENABLE_SSL`: Whether to force SSL connections for the database. Default: **no**
- `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
- `MYSQL_CLIENT_SSL_CERT_FILE`: Path to the SSL CA file for the new database. No defaults
- `MYSQL_CLIENT_SSL_KEY_FILE`: Path to the SSL CA file for the new database. No defaults
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
* `MYSQL_CLIENT_FLAVOR`: SQL database flavor. Valid values: `mariadb` or `mysql`. Default: **mariadb**.
* `MYSQL_CLIENT_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
* `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
* `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
* `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES`: Database privileges to grant for the user specified in `MYSQL_CLIENT_CREATE_DATABASE_USER` to the database specified in `MYSQL_CLIENT_CREATE_DATABASE_NAME`. No defaults.
* `MYSQL_CLIENT_ENABLE_SSL_WRAPPER`: Whether to force SSL connections to the database via the `mysql` CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: **no**
* `MYSQL_CLIENT_ENABLE_SSL`: Whether to force SSL connections for the database. Default: **no**
* `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
* `MYSQL_CLIENT_SSL_CERT_FILE`: Path to the SSL CA file for the new database. No defaults
* `MYSQL_CLIENT_SSL_KEY_FILE`: Path to the SSL CA file for the new database. No defaults
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
###### SMTP Configuration
##### SMTP Configuration
To configure Drupal to send email using SMTP you can set the following environment variables:
- `DRUPAL_SMTP_HOST`: SMTP host.
- `DRUPAL_SMTP_PORT`: SMTP port.
- `DRUPAL_SMTP_USER`: SMTP account user.
- `DRUPAL_SMTP_PASSWORD`: SMTP account password.
- `DRUPAL_SMTP_PROTOCOL`: SMTP protocol. (standard, tls, ssl).
* `DRUPAL_SMTP_HOST`: SMTP host.
* `DRUPAL_SMTP_PORT`: SMTP port.
* `DRUPAL_SMTP_USER`: SMTP account user.
* `DRUPAL_SMTP_PASSWORD`: SMTP account password.
* `DRUPAL_SMTP_PROTOCOL`: SMTP protocol. (standard, tls, ssl).
###### PHP configuration
##### PHP configuration
- `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
- `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
- `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
- `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
- `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
- `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
- `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
- `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
* `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
* `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
* `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
* `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
* `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
* `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
* `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
* `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
###### Example
This would be an example of SMTP configuration using a Gmail account:
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal-nginx/docker-compose.yml) file present in this repository:
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal-nginx/docker-compose.yml) file present in this repository:
```yaml
drupal:
@ -295,10 +295,11 @@ This would be an example of SMTP configuration using a Gmail account:
- DRUPAL_SMTP_PROTOCOL=tls
...
```
* For manual execution:
* For manual execution:
```console
$ docker run -d --name drupal -p 80:8080 -p 443:8443 \
docker run -d --name drupal -p 80:8080 -p 443:8443 \
--env DRUPAL_DATABASE_USER=bn_drupal \
--env DRUPAL_DATABASE_NAME=bitnami_drupal \
--env DRUPAL_SMTP_HOST=smtp.gmail.com \
@ -316,13 +317,13 @@ This would be an example of SMTP configuration using a Gmail account:
The Bitnami Drupal Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs drupal
docker logs drupal
```
Or using Docker Compose:
```console
$ docker-compose logs drupal
docker-compose logs drupal
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -336,13 +337,13 @@ To backup your data, configuration and logs, follow these simple steps:
##### Step 1: Stop the currently running container
```console
$ docker stop drupal
docker stop drupal
```
Or using Docker Compose:
```console
$ docker-compose stop drupal
docker-compose stop drupal
```
##### Step 2: Run the backup command
@ -350,7 +351,7 @@ $ docker-compose stop drupal
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/drupal-backups:/backups --volumes-from drupal busybox \
docker run --rm -v /path/to/drupal-backups:/backups --volumes-from drupal busybox \
cp -a /bitnami/drupal /backups/latest
```
@ -361,7 +362,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the MariaDB database container:
```diff
$ docker run -d --name mariadb \
docker run -d --name mariadb \
...
- --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
@ -371,7 +372,7 @@ For the MariaDB database container:
For the Drupal container:
```diff
$ docker run -d --name drupal \
docker run -d --name drupal \
...
- --volume /path/to/drupal-persistence:/bitnami/drupal \
+ --volume /path/to/drupal-backups/latest:/bitnami/drupal \
@ -380,12 +381,12 @@ For the Drupal container:
#### Upgrade this image
Bitnami provides up-to-date versions of MariaDB and Drupal, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Drupal container. For the MariaDB upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image
Bitnami provides up-to-date versions of MariaDB and Drupal, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Drupal container. For the MariaDB upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image>
##### Step 1: Get the updated image
```console
$ docker pull bitnami/drupal-nginx:latest
docker pull bitnami/drupal-nginx:latest
```
##### Step 2: Stop the running container
@ -393,7 +394,7 @@ $ docker pull bitnami/drupal-nginx:latest
Stop the currently running container using the command
```console
$ docker-compose stop drupal
docker-compose stop drupal
```
##### Step 3: Take a snapshot of the application state
@ -413,7 +414,7 @@ docker-compose rm -v drupal
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
## Customize this image
@ -424,11 +425,11 @@ The Bitnami Drupal with NGINX Docker image is designed to be extended so it can
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can change the ports used by NGINX for HTTP and HTTPS, by setting the environment variables `NGINX_HTTP_PORT_NUMBER` and `NGINX_HTTPS_PORT_NUMBER` respectively.
- [Adding custom server blocks](https://github.com/bitnami/containers/blob/main/bitnami/nginx#adding-custom-server-blocks).
- [Replacing the 'nginx.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/nginx#full-configuration).
- [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/nginx#using-custom-ssl-certificates).
- [Solving redirection issues](https://github.com/bitnami/containers/blob/main/bitnami/nginx#solving-redirection-issues).
* Settings that can be adapted using environment variables. For instance, you can change the ports used by NGINX for HTTP and HTTPS, by setting the environment variables `NGINX_HTTP_PORT_NUMBER` and `NGINX_HTTPS_PORT_NUMBER` respectively.
* [Adding custom server blocks](https://github.com/bitnami/containers/blob/main/bitnami/nginx#adding-custom-server-blocks).
* [Replacing the 'nginx.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/nginx#full-configuration).
* [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/nginx#using-custom-ssl-certificates).
* [Solving redirection issues](https://github.com/bitnami/containers/blob/main/bitnami/nginx#solving-redirection-issues).
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
@ -440,9 +441,9 @@ FROM bitnami/drupal-nginx
Here is an example of extending the image with the following modifications:
- Install the `vim` editor
- Modify the NGINX configuration file
- Modify the ports used by NGINX
* Install the `vim` editor
* Modify the NGINX configuration file
* Modify the ports used by NGINX
```Dockerfile
FROM bitnami/drupal-nginx
@ -480,17 +481,17 @@ Based on the extended image, you can update the [`docker-compose.yml`](https://g
### 8.9.2-debian-10-r3 and 9.0.2-debian-10-r3
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
- The Drupal container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the NGINX daemon was started as the `daemon` user. From now on, both the container and the NGINX daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
- The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Drupal site by exporting its content, and importing it on a new Drupal container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* The Drupal container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the NGINX daemon was started as the `daemon` user. From now on, both the container and the NGINX daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
* The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
* Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Drupal site by exporting its content, and importing it on a new Drupal container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
### 8.7.2-debian-9-r9 and 8.7.2-ol-7-r8
- This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
- The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
- Enabling custom NGINX certificates by placing them at `/opt/bitnami/nginx/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
* This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
* The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
* Enabling custom NGINX certificates by placing them at `/opt/bitnami/nginx/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
## Contributing
@ -516,7 +517,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

225
bitnami/drupal/README.md
View File

@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Drupal Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/drupal).
```console
$ docker pull bitnami/drupal:latest
docker pull bitnami/drupal:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/drupal/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/drupal:[TAG]
docker pull bitnami/drupal:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## How to use this image
@ -75,8 +75,8 @@ Drupal requires access to a MySQL or MariaDB database to store information. We'l
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/drupal/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -86,14 +86,14 @@ If you want to run the application manually instead of using `docker-compose`, t
#### Step 1: Create a network
```console
$ docker network create drupal-network
docker network create drupal-network
```
#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
```console
$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
docker volume create --name mariadb_data
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_drupal \
--env MARIADB_PASSWORD=bitnami \
@ -106,8 +106,8 @@ $ docker run -d --name mariadb \
#### Step 3: Create volumes for Drupal persistence and launch the container
```console
$ docker volume create --name drupal_data
$ docker run -d --name drupal \
docker volume create --name drupal_data
docker run -d --name drupal \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env DRUPAL_DATABASE_USER=bn_drupal \
@ -161,13 +161,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
#### Step 1: Create a network (if it does not exist)
```console
$ docker network create drupal-network
docker network create drupal-network
```
#### Step 2. Create a MariaDB container with host volume
```console
$ docker run -d --name mariadb \
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_drupal \
--env MARIADB_PASSWORD=bitnami \
@ -180,7 +180,7 @@ $ docker run -d --name mariadb \
#### Step 3. Create the Drupal container with host volumes
```console
$ docker run -d --name drupal \
docker run -d --name drupal \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env DRUPAL_DATABASE_USER=bn_drupal \
@ -197,7 +197,7 @@ $ docker run -d --name drupal \
When you start the Drupal image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal/docker-compose.yml) file present in this repository:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal/docker-compose.yml) file present in this repository:
```yaml
drupal:
@ -207,10 +207,10 @@ drupal:
...
```
* For manual execution add a `--env` option with each variable and value:
* For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name drupal -p 80:8080 -p 443:8443 \
docker run -d --name drupal -p 80:8080 -p 443:8443 \
--env DRUPAL_PASSWORD=my_password \
--network drupal-tier \
--volume /path/to/drupal-persistence:/bitnami \
@ -219,74 +219,74 @@ drupal:
Available environment variables:
##### User and Site configuration
#### User and Site configuration
- `DRUPAL_PROFILE`: Drupal installation profile. Default: **standard**
- `DRUPAL_SITE_NAME`: Drupal blog name. Default: **My blog**
- `DRUPAL_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. Default: **no**
- `DRUPAL_ENABLE_MODULES`: Comma or space separated list of installed modules to enable during the first initialization. No defaults.
- `DRUPAL_USERNAME`: Drupal application username. Default: **user**
- `DRUPAL_PASSWORD`: Drupal application password. Default: **bitnami**
- `DRUPAL_EMAIL`: Drupal application email. Default: **user@example.com**
- `DRUPAL_CONFIG_SYNC_DIR`: Drupal sync configuration directory location. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
- `DRUPAL_HASH_SALT`: Drupal string used to generate random values. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
* `DRUPAL_PROFILE`: Drupal installation profile. Default: **standard**
* `DRUPAL_SITE_NAME`: Drupal blog name. Default: **My blog**
* `DRUPAL_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. Default: **no**
* `DRUPAL_ENABLE_MODULES`: Comma or space separated list of installed modules to enable during the first initialization. No defaults.
* `DRUPAL_USERNAME`: Drupal application username. Default: **user**
* `DRUPAL_PASSWORD`: Drupal application password. Default: **bitnami**
* `DRUPAL_EMAIL`: Drupal application email. Default: **user@example.com**
* `DRUPAL_CONFIG_SYNC_DIR`: Drupal sync configuration directory location. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
* `DRUPAL_HASH_SALT`: Drupal string used to generate random values. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults.
##### Use an existing database
#### Use an existing database
- `DRUPAL_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
- `DRUPAL_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
- `DRUPAL_DATABASE_NAME`: Database name that Drupal will use to connect with the database. Default: **bitnami_drupal**
- `DRUPAL_DATABASE_USER`: Database user that Drupal will use to connect with the database. Default: **bn_drupal**
- `DRUPAL_DATABASE_PASSWORD`: Database password that Drupal will use to connect with the database. No defaults.
- `DRUPAL_DATABASE_TLS_CA_FILE`: TLS CA certificate for connections. No defaults.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
* `DRUPAL_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
* `DRUPAL_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
* `DRUPAL_DATABASE_NAME`: Database name that Drupal will use to connect with the database. Default: **bitnami_drupal**
* `DRUPAL_DATABASE_USER`: Database user that Drupal will use to connect with the database. Default: **bn_drupal**
* `DRUPAL_DATABASE_PASSWORD`: Database password that Drupal will use to connect with the database. No defaults.
* `DRUPAL_DATABASE_TLS_CA_FILE`: TLS CA certificate for connections. No defaults.
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### Create a database for Drupal using mysql-client
#### Create a database for Drupal using mysql-client
- `MYSQL_CLIENT_FLAVOR`: SQL database flavor. Valid values: `mariadb` or `mysql`. Default: **mariadb**.
- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
- `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
- `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
- `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES`: Database privileges to grant for the user specified in `MYSQL_CLIENT_CREATE_DATABASE_USER` to the database specified in `MYSQL_CLIENT_CREATE_DATABASE_NAME`. No defaults.
- `MYSQL_CLIENT_ENABLE_SSL_WRAPPER`: Whether to force SSL connections to the database via the `mysql` CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: **no**
- `MYSQL_CLIENT_ENABLE_SSL`: Whether to force SSL connections for the database. Default: **no**
- `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
- `MYSQL_CLIENT_SSL_CERT_FILE`: Path to the SSL CA file for the new database. No defaults
- `MYSQL_CLIENT_SSL_KEY_FILE`: Path to the SSL CA file for the new database. No defaults
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
* `MYSQL_CLIENT_FLAVOR`: SQL database flavor. Valid values: `mariadb` or `mysql`. Default: **mariadb**.
* `MYSQL_CLIENT_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
* `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
* `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
* `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES`: Database privileges to grant for the user specified in `MYSQL_CLIENT_CREATE_DATABASE_USER` to the database specified in `MYSQL_CLIENT_CREATE_DATABASE_NAME`. No defaults.
* `MYSQL_CLIENT_ENABLE_SSL_WRAPPER`: Whether to force SSL connections to the database via the `mysql` CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: **no**
* `MYSQL_CLIENT_ENABLE_SSL`: Whether to force SSL connections for the database. Default: **no**
* `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
* `MYSQL_CLIENT_SSL_CERT_FILE`: Path to the SSL CA file for the new database. No defaults
* `MYSQL_CLIENT_SSL_KEY_FILE`: Path to the SSL CA file for the new database. No defaults
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### SMTP Configuration
#### SMTP Configuration
To configure Drupal to send email using SMTP you can set the following environment variables:
- `DRUPAL_SMTP_HOST`: SMTP host.
- `DRUPAL_SMTP_PORT`: SMTP port.
- `DRUPAL_SMTP_USER`: SMTP account user.
- `DRUPAL_SMTP_PASSWORD`: SMTP account password.
- `DRUPAL_SMTP_PROTOCOL`: SMTP protocol. (standard, tls, ssl).
* `DRUPAL_SMTP_HOST`: SMTP host.
* `DRUPAL_SMTP_PORT`: SMTP port.
* `DRUPAL_SMTP_USER`: SMTP account user.
* `DRUPAL_SMTP_PASSWORD`: SMTP account password.
* `DRUPAL_SMTP_PROTOCOL`: SMTP protocol. (standard, tls, ssl).
##### PHP configuration
#### PHP configuration
- `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
- `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
- `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
- `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
- `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
- `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
- `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
- `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
* `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
* `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
* `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
* `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
* `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
* `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
* `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
* `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
##### Example
#### Example
This would be an example of SMTP configuration using a Gmail account:
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal/docker-compose.yml) file present in this repository:
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal/docker-compose.yml) file present in this repository:
```yaml
drupal:
@ -302,10 +302,11 @@ This would be an example of SMTP configuration using a Gmail account:
- DRUPAL_SMTP_PROTOCOL=tls
...
```
* For manual execution:
* For manual execution:
```console
$ docker run -d --name drupal -p 80:8080 -p 443:8443 \
docker run -d --name drupal -p 80:8080 -p 443:8443 \
--env DRUPAL_DATABASE_USER=bn_drupal \
--env DRUPAL_DATABASE_NAME=bitnami_drupal \
--env DRUPAL_SMTP_HOST=smtp.gmail.com \
@ -323,13 +324,13 @@ This would be an example of SMTP configuration using a Gmail account:
The Bitnami Drupal Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs drupal
docker logs drupal
```
Or using Docker Compose:
```console
$ docker-compose logs drupal
docker-compose logs drupal
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -343,13 +344,13 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
```console
$ docker stop drupal
docker stop drupal
```
Or using Docker Compose:
```console
$ docker-compose stop drupal
docker-compose stop drupal
```
#### Step 2: Run the backup command
@ -357,7 +358,7 @@ $ docker-compose stop drupal
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/drupal-backups:/backups --volumes-from drupal busybox \
docker run --rm -v /path/to/drupal-backups:/backups --volumes-from drupal busybox \
cp -a /bitnami/drupal /backups/latest
```
@ -368,7 +369,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the MariaDB database container:
```diff
$ docker run -d --name mariadb \
docker run -d --name mariadb \
...
- --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
@ -378,7 +379,7 @@ For the MariaDB database container:
For the Drupal container:
```diff
$ docker run -d --name drupal \
docker run -d --name drupal \
...
- --volume /path/to/drupal-persistence:/bitnami/drupal \
+ --volume /path/to/drupal-backups/latest:/bitnami/drupal \
@ -387,12 +388,12 @@ For the Drupal container:
### Upgrade this image
Bitnami provides up-to-date versions of MariaDB and Drupal, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Drupal container. For the MariaDB upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image
Bitnami provides up-to-date versions of MariaDB and Drupal, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Drupal container. For the MariaDB upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image>
#### Step 1: Get the updated image
```console
$ docker pull bitnami/drupal:latest
docker pull bitnami/drupal:latest
```
#### Step 2: Stop the running container
@ -400,7 +401,7 @@ $ docker pull bitnami/drupal:latest
Stop the currently running container using the command
```console
$ docker-compose stop drupal
docker-compose stop drupal
```
#### Step 3: Take a snapshot of the application state
@ -420,7 +421,7 @@ docker-compose rm -v drupal
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
## Customize this image
@ -431,10 +432,10 @@ The Bitnami Drupal Docker image is designed to be extended so it can be used as
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
- [Adding custom virtual hosts](https://github.com/bitnami/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
- [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
- [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/apache#using-custom-ssl-certificates).
* Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
* [Adding custom virtual hosts](https://github.com/bitnami/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
* [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
* [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/apache#using-custom-ssl-certificates).
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
@ -446,9 +447,9 @@ FROM bitnami/drupal
Here is an example of extending the image with the following modifications:
- Install the `vim` editor
- Modify the Apache configuration file
- Modify the ports used by Apache
* Install the `vim` editor
* Modify the Apache configuration file
* Modify the ports used by Apache
```Dockerfile
FROM bitnami/drupal
@ -486,28 +487,28 @@ Based on the extended image, you can update the [`docker-compose.yml`](https://g
...
```
# Notable Changes
## Notable Changes
## 8.9.2-debian-10-r3 and 9.0.2-debian-10-r3
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
- The Drupal container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
- The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Drupal site by exporting its content, and importing it on a new Drupal container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* The Drupal container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
* The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
* Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Drupal site by exporting its content, and importing it on a new Drupal container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
## 8.7.2-debian-9-r8 and 8.7.2-ol-7-r8
- This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
- The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
- The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
- Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
* This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
* The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
* The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
* Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
## 8.5.3-r1
- The drupal container now uses drush to install and update the Drupal application.
* The drupal container now uses drush to install and update the Drupal application.
# Contributing
## Contributing
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/containers/blob/main/bitnami/drupal/issues) or submitting a [pull request](https://github.com/bitnami/containers/blob/main/bitnami/drupal/pulls) with your contribution.
@ -515,11 +516,11 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/blob/main/bitnami/drupal/issues/new). Be sure to include the following information in your issue:
- Host OS and version
- Docker version (`docker version`)
- Output of `docker info`
- Version of this container
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
* Host OS and version
* Docker version (`docker version`)
* Output of `docker info`
* Version of this container
* The command you used to run the container, and any relevant output you saw (masking any sensitive information)
### Community supported solution
@ -529,7 +530,7 @@ The Bitnami team will review any PR that is created, feel free to create a PR if
New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.
# License
## License
Copyright &copy; 2023 Bitnami
@ -537,7 +538,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

86
bitnami/ejbca/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name ejbca bitnami/ejbca:latest
docker run --name ejbca bitnami/ejbca:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ejbca/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ejbca/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Configuration](#configuration) section for a more secure deployment.
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami EJBCA Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/ejbca).
```console
$ docker pull bitnami/ejbca:latest
docker pull bitnami/ejbca:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/ejbca/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/ejbca:[TAG]
docker pull bitnami/ejbca:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## How to use this image
@ -75,8 +75,8 @@ EJBCA requires access to a MySQL or MariaDB database to store information. We'll
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/ejbca/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ejbca/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ejbca/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -86,14 +86,14 @@ If you want to run the application manually instead of using `docker-compose`, t
#### Step 1: Create a network
```console
$ docker network create ejbca-network
docker network create ejbca-network
```
#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
```console
$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
docker volume create --name mariadb_data
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_ejbca \
--env MARIADB_PASSWORD=Bitnami1234 \
@ -106,8 +106,8 @@ $ docker run -d --name mariadb \
#### Step 3: Create volumes for EJBCA persistence and launch the container
```console
$ docker volume create --name ejbca_data
$ docker run -d --name ejbca \
docker volume create --name ejbca_data
docker run -d --name ejbca \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env EJBCA_DATABASE_USERNAME=bn_ejbca \
@ -128,7 +128,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami/wildfly` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/ejbca-persistence:/bitnami/wildfly \
bitnami/ejbca:latest
```
@ -151,34 +151,34 @@ You can also do this with a minor change to the [`docker-compose.yml`](https://g
The EJBCA instance can be customized by specifying environment variables on the first run. The following environment variables are available:
- `EJBCA_HTTP_PORT_NUMBER`: HTTP port number. Defaults to `8080`.
- `EJBCA_HTTPS_PORT_NUMBER`: HTTPS port number. Default to `8443`.
- `EJBCA_HTTPS_ADVERTISED_PORT_NUMBER`: Port number used in the rendered URLs for the admistrator login. Default to `8443`.
- `EJBCA_ADMIN_USERNAME`: EJBCA administrator username. Defaults to `superadmin`.
- `EJBCA_ADMIN_PASSWORD`: EJBCA administrator password. Defaults to `Bitnami1234`.
- `EJBCA_DATABASE_HOST`: Database hostname. No defaults.
- `EJBCA_DATABASE_PORT`: Database port name. Defaults to `3306`.
- `EJBCA_DATABASE_NAME`: Database name. No defaults.
- `EJBCA_DATABASE_USERNAME`: Database username. No defaults.
- `EJBCA_DATABASE_PASSWORD`: Database password. No defaults.
- `EJBCA_BASE_DN`: Base DN for the CA. Defaults to `O=Example CA,C=SE,UID=c-XXXXXXX`, where `XXXXXXX` is a random generated ID.
- `EJBCA_CA_NAME`: CA Name. Defaults to `ManagementCA`
- `JAVA_OPTS`: Java options. Defaults to `-Xms2048m -Xmx2048m -XX:MetaspaceSize=192M -XX:MaxMetaspaceSize=256m -Djava.net.preferIPv4Stack=true -Dhibernate.dialect=org.hibernate.dialect.MySQL5Dialect -Dhibernate.dialect.storage_engine=innodb`.
- `EJBCA_SERVER_CERT_FILE`: User provided keystore file. No defaults.
- `EJBCA_SERVER_CERT_PASSWORD`: User provided keystore file password. No defaults.
- `EJBCA_SMTP_HOST`: SMTP Email server address. Defaults to `localhost`.
- `EJBCA_SMTP_PORT`: SMTP Email server port. Defaults to `25`.
- `EJBCA_SMTP_FROM_ADDRESS`: SMTP from email address. Defaults to `user@example.com`.
- `EJBCA_SMTP_TLS`: SMTP TLS authentication: Defaults to `false`.
- `EJBCA_SMTP_USERNAME`: SMTP authentication username. No defaults.
- `EJBCA_SMTP_PASSWORD`: SMTP authentication password. No defaults.
* `EJBCA_HTTP_PORT_NUMBER`: HTTP port number. Defaults to `8080`.
* `EJBCA_HTTPS_PORT_NUMBER`: HTTPS port number. Default to `8443`.
* `EJBCA_HTTPS_ADVERTISED_PORT_NUMBER`: Port number used in the rendered URLs for the admistrator login. Default to `8443`.
* `EJBCA_ADMIN_USERNAME`: EJBCA administrator username. Defaults to `superadmin`.
* `EJBCA_ADMIN_PASSWORD`: EJBCA administrator password. Defaults to `Bitnami1234`.
* `EJBCA_DATABASE_HOST`: Database hostname. No defaults.
* `EJBCA_DATABASE_PORT`: Database port name. Defaults to `3306`.
* `EJBCA_DATABASE_NAME`: Database name. No defaults.
* `EJBCA_DATABASE_USERNAME`: Database username. No defaults.
* `EJBCA_DATABASE_PASSWORD`: Database password. No defaults.
* `EJBCA_BASE_DN`: Base DN for the CA. Defaults to `O=Example CA,C=SE,UID=c-XXXXXXX`, where `XXXXXXX` is a random generated ID.
* `EJBCA_CA_NAME`: CA Name. Defaults to `ManagementCA`
* `JAVA_OPTS`: Java options. Defaults to `-Xms2048m -Xmx2048m -XX:MetaspaceSize=192M -XX:MaxMetaspaceSize=256m -Djava.net.preferIPv4Stack=true -Dhibernate.dialect=org.hibernate.dialect.MySQL5Dialect -Dhibernate.dialect.storage_engine=innodb`.
* `EJBCA_SERVER_CERT_FILE`: User provided keystore file. No defaults.
* `EJBCA_SERVER_CERT_PASSWORD`: User provided keystore file password. No defaults.
* `EJBCA_SMTP_HOST`: SMTP Email server address. Defaults to `localhost`.
* `EJBCA_SMTP_PORT`: SMTP Email server port. Defaults to `25`.
* `EJBCA_SMTP_FROM_ADDRESS`: SMTP from email address. Defaults to `user@example.com`.
* `EJBCA_SMTP_TLS`: SMTP TLS authentication: Defaults to `false`.
* `EJBCA_SMTP_USERNAME`: SMTP authentication username. No defaults.
* `EJBCA_SMTP_PASSWORD`: SMTP authentication password. No defaults.
## Logging
The Bitnami EJBCA Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs ejbca
docker logs ejbca
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -198,7 +198,7 @@ Bitnami provides up-to-date versions of EJBCA, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/ejbca:latest
docker pull bitnami/ejbca:latest
```
#### Step 2: Stop the running container
@ -206,13 +206,13 @@ $ docker pull bitnami/ejbca:latest
Stop the currently running container using the command
```console
$ docker stop ejbca
docker stop ejbca
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v ejbca
docker rm -v ejbca
```
#### Step 4: Run the new image
@ -220,7 +220,7 @@ $ docker rm -v ejbca
Re-create your container from the new image.
```console
$ docker run --name ejbca bitnami/ejbca:latest
docker run --name ejbca bitnami/ejbca:latest
```
## Notable Changes
@ -249,7 +249,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

34
bitnami/elasticsearch-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name elasticsearch-exporter bitnami/elasticsearch-exporter:latest
docker run --name elasticsearch-exporter bitnami/elasticsearch-exporter:latest
```
## Why use Bitnami Images?
@ -34,26 +34,27 @@ Learn more about the Bitnami tagging policy and the difference between rolling t
You can see the equivalence between the different tags by taking a look at the `tags-info.yaml` file present in the branch folder, i.e `bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml`.
Subscribe to project updates by watching the [bitnami/containers GitHub repo](https://github.com/bitnami/containers).
## Get this image
The recommended way to get the Bitnami Elasticsearch Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/elasticsearch-exporter).
```console
$ docker pull bitnami/elasticsearch-exporter:latest
docker pull bitnami/elasticsearch-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/elasticsearch-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/elasticsearch-exporter:[TAG]
docker pull bitnami/elasticsearch-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -67,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create elasticsearch-exporter-network --driver bridge
docker network create elasticsearch-exporter-network --driver bridge
```
#### Step 2: Launch the Elasticsearch Exporter container within your network
@ -75,7 +76,7 @@ $ docker network create elasticsearch-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `elasticsearch-exporter-network` network.
```console
$ docker run --name elasticsearch-exporter-node1 --network elasticsearch-exporter-network bitnami/elasticsearch-exporter:latest
docker run --name elasticsearch-exporter-node1 --network elasticsearch-exporter-network bitnami/elasticsearch-exporter:latest
```
#### Step 3: Run another containers
@ -97,7 +98,7 @@ In `/metrics` you can find the exported metrics.
The Bitnami elasticsearch-exporter Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs elasticsearch-exporter
docker logs elasticsearch-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -111,7 +112,7 @@ Bitnami provides up-to-date versions of elasticsearch-exporter, including securi
#### Step 1: Get the updated image
```console
$ docker pull bitnami/elasticsearch-exporter:latest
docker pull bitnami/elasticsearch-exporter:latest
```
#### Step 2: Stop and backup the currently running container
@ -119,13 +120,13 @@ $ docker pull bitnami/elasticsearch-exporter:latest
Stop the currently running container using the command
```console
$ docker stop elasticsearch-exporter
docker stop elasticsearch-exporter
```
Next, take a snapshot of the persistent volume `/path/to/elasticsearch-exporter-persistence` using:
```console
$ rsync -a /path/to/elasticsearch-exporter-persistence /path/to/elasticsearch-exporter-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/elasticsearch-exporter-persistence /path/to/elasticsearch-exporter-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the database state should the upgrade fail.
@ -133,15 +134,15 @@ You can use this snapshot to restore the database state should the upgrade fail.
#### Step 3: Remove the currently running container
```console
$ docker rm -v elasticsearch-exporter
docker rm -v elasticsearch-exporter
```
#### Step 4: Run the new image
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
Re-create your container from the new image, restoring your backup if necessary.
```console
$ docker run --name elasticsearch-exporter bitnami/elasticsearch-exporter:latest
docker run --name elasticsearch-exporter bitnami/elasticsearch-exporter:latest
```
## Contributing
@ -153,13 +154,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

81
bitnami/elasticsearch/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name elasticsearch bitnami/elasticsearch:latest
docker run --name elasticsearch bitnami/elasticsearch:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/elasticsearch/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/elasticsearch/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
You can find the available configuration options in the [Environment Variables](#environment-variables) section.
@ -49,26 +49,27 @@ Learn more about the Bitnami tagging policy and the difference between rolling t
You can see the equivalence between the different tags by taking a look at the `tags-info.yaml` file present in the branch folder, i.e `bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml`.
Subscribe to project updates by watching the [bitnami/containers GitHub repo](https://github.com/bitnami/containers).
## Get this image
The recommended way to get the Bitnami Elasticsearch Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/elasticsearch).
```console
$ docker pull bitnami/elasticsearch:latest
docker pull bitnami/elasticsearch:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/elasticsearch/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/elasticsearch:[TAG]
docker pull bitnami/elasticsearch:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -78,7 +79,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/elasticsearch-data-persistence:/bitnami/elasticsearch/data \
bitnami/elasticsearch:latest
```
@ -119,7 +120,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create app-tier --driver bridge
docker network create app-tier --driver bridge
```
#### Step 2: Launch the Elasticsearch server instance
@ -127,7 +128,7 @@ $ docker network create app-tier --driver bridge
Use the `--network app-tier` argument to the `docker run` command to attach the Elasticsearch container to the `app-tier` network.
```console
$ docker run -d --name elasticsearch-server \
docker run -d --name elasticsearch-server \
--network app-tier \
bitnami/elasticsearch:latest
```
@ -135,7 +136,7 @@ $ docker run -d --name elasticsearch-server \
#### Step 3: Launch your application container
```console
$ docker run -d --name myapp \
docker run -d --name myapp \
--network app-tier \
YOUR_APPLICATION_IMAGE
```
@ -175,7 +176,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -197,7 +198,7 @@ elasticsearch:
* For manual execution add a `-e` option with each variable and value:
```console
$ docker run -d --name elasticsearch \
docker run -d --name elasticsearch \
-p 9201:9201 --network=elasticsearch_network \
-e ELASTICSEARCH_PORT_NUMBER=9201 \
-v /path/to/elasticsearch-data-persistence:/bitnami/elasticsearch/data \
@ -241,16 +242,16 @@ For larger cluster, you can setup 'dedicated nodes' using the following environm
Find more information about 'dedicated nodes' in the [official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html).
#### Step 1: Create a new network.
#### Step 1: Create a new network
```console
$ docker network create elasticsearch_network
docker network create elasticsearch_network
```
#### Step 2: Create the first node.
#### Step 2: Create the first node
```console
$ docker run --name elasticsearch-node1 \
docker run --name elasticsearch-node1 \
--net=elasticsearch_network \
-p 9200:9200 \
-e ELASTICSEARCH_CLUSTER_NAME=elasticsearch-cluster \
@ -264,7 +265,7 @@ In the above command the container is added to a cluster named `elasticsearch-cl
#### Step 3: Create a second node
```console
$ docker run --name elasticsearch-node2 \
docker run --name elasticsearch-node2 \
--link elasticsearch-node1:elasticsearch-node1 \
--net=elasticsearch_network \
-e ELASTICSEARCH_CLUSTER_NAME=elasticsearch-cluster \
@ -302,7 +303,7 @@ services:
In order to use a custom configuration file instead of the default one provided out of the box, you can create a file named `elasticsearch.yml` and mount it at `/opt/bitnami/elasticsearch/config/elasticsearch.yml` to overwrite the default configuration:
```console
$ docker run -d --name elasticsearch \
docker run -d --name elasticsearch \
-p 9201:9201 \
-v /path/to/elasticsearch.yml:/opt/bitnami/elasticsearch/config/elasticsearch.yml \
-v /path/to/elasticsearch-data-persistence:/bitnami/elasticsearch/data \
@ -331,7 +332,7 @@ The Bitnami Elasticsearch Docker image comes with the [S3 Repository plugin](htt
You can add extra plugins by setting the `ELASTICSEARCH_PLUGINS` environment variable. To specify multiple plugins, separate them by spaces, commas or semicolons. When the container is initialized it will install all of the specified plugins before starting Elasticsearch.
```console
$ docker run -d --name elasticsearch \
docker run -d --name elasticsearch \
-e ELASTICSEARCH_PLUGINS=analysis-icu \
bitnami/elasticsearch:latest
```
@ -345,9 +346,9 @@ The Bitnami Elasticsearch image provides a way to create your custom image insta
To create your own image providing plugins execute the following command. Remember to replace the `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/elasticsearch/VERSION/OPERATING-SYSTEM
$ docker build --build-arg ELASTICSEARCH_PLUGINS=<plugin1,plugin2,...> -t bitnami/elasticsearch:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/elasticsearch/VERSION/OPERATING-SYSTEM
docker build --build-arg ELASTICSEARCH_PLUGINS=<plugin1,plugin2,...> -t bitnami/elasticsearch:latest .
```
The command above will build the image providing this GitHub repository as build context, and will pass the list of plugins to install to the build logic.
@ -363,13 +364,13 @@ In order to have your custom files inside the Docker image, you can mount them a
The Bitnami Elasticsearch Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs elasticsearch
docker logs elasticsearch
```
or using Docker Compose:
```console
$ docker-compose logs elasticsearch
docker-compose logs elasticsearch
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -386,7 +387,7 @@ Bitnami provides up-to-date versions of Elasticsearch, including security patche
#### Step 1: Get the updated image
```console
$ docker pull bitnami/elasticsearch:latest
docker pull bitnami/elasticsearch:latest
```
or if you're using Docker Compose, update the value of the image property to
@ -397,19 +398,19 @@ or if you're using Docker Compose, update the value of the image property to
Stop the currently running container using the command
```console
$ docker stop elasticsearch
docker stop elasticsearch
```
or using Docker Compose:
```console
$ docker-compose stop elasticsearch
docker-compose stop elasticsearch
```
Next, take a snapshot of the persistent volume `/path/to/elasticsearch-data-persistence` using:
```console
$ rsync -a /path/to/elasticsearch-data-persistence /path/to/elasticsearch-data-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/elasticsearch-data-persistence /path/to/elasticsearch-data-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the application state should the upgrade fail.
@ -417,27 +418,27 @@ You can use this snapshot to restore the application state should the upgrade fa
#### Step 3: Remove the currently running container
```console
$ docker rm -v elasticsearch
docker rm -v elasticsearch
```
or using Docker Compose:
```console
$ docker-compose rm -v elasticsearch
docker-compose rm -v elasticsearch
```
#### Step 4: Run the new image
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
Re-create your container from the new image, restoring your backup if necessary.
```console
$ docker run --name elasticsearch bitnami/elasticsearch:latest
docker run --name elasticsearch bitnami/elasticsearch:latest
```
or using Docker Compose:
```console
$ docker-compose up elasticsearch
docker-compose up elasticsearch
```
## Notable Changes
@ -450,7 +451,7 @@ $ docker-compose up elasticsearch
### 6.8.5-debian-9-r0, 6.8.5-ol-7-r1, 7.4.2-debian-9-r10, 7.4.2-ol-7-r27
* Arbitrary user ID(s) when running the container with a non-privileged user is not supported (only `1001` UID is allowed).
* This is temporary solution while Elasticsearch maintainers address an issue with ownership/permissions when installing plugins. Issue reported at: https://github.com/bitnami/bitnami-docker-elasticsearch/issues/50
* This is temporary solution while Elasticsearch maintainers address an issue with ownership/permissions when installing plugins. Issue reported at: <https://github.com/bitnami/bitnami-docker-elasticsearch/issues/50>
### 6.8.2-debian-9-r36, 6.8.2-ol-7-r36, 7.3.1-debian-9-r8, 7.3.1-ol-7-r13
@ -469,12 +470,12 @@ $ docker-compose up elasticsearch
* Backwards compatibility is not guaranteed when data is persisted using docker-compose. You can use the workaround below to overcome it:
```console
$ docker-compose down
docker-compose down
# Change the mount point
sed -i -e 's#elasticsearch_data:/bitnami#elasticsearch_data:/bitnami/elasticsearch/data#g' docker-compose.yml
# Pull the latest bitnami/elasticsearch image
$ docker pull bitnami/elasticsearch:latest
$ docker-compose up -d
docker pull bitnami/elasticsearch:latest
docker-compose up -d
```
### 6.2.3-r7 & 5.6.4-r18
@ -508,7 +509,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/envoy/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name envoy bitnami/envoy:latest
docker run --name envoy bitnami/envoy:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami envoy Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/envoy).
```console
$ docker pull bitnami/envoy:latest
docker pull bitnami/envoy:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/envoy/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/envoy:[TAG]
docker pull bitnami/envoy:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -60,7 +60,7 @@ $ docker build -t bitnami/APP:latest .
To run commands inside this container you can use `docker run`, for example to execute `envoy --version` you can follow the example below:
```console
$ docker run --rm --name envoy bitnami/envoy:latest -- --version
docker run --rm --name envoy bitnami/envoy:latest -- --version
```
Check the [official envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/operations/cli) for a list of the available parameters.
@ -70,7 +70,7 @@ Check the [official envoy documentation](https://www.envoyproxy.io/docs/envoy/la
By default, envoy will look for a configuration file in `/opt/bitnami/envoy/conf/envoy.yaml`. You can launch the envoy container with your custom configuration with the command below:
```console
$ docker run --rm -v /path/to/your/envoy.yaml:/opt/bitnami/envoy/conf/envoy.yaml bitnami/envoy:latest
docker run --rm -v /path/to/your/envoy.yaml:/opt/bitnami/envoy/conf/envoy.yaml bitnami/envoy:latest
```
Visit the [official envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/configuration) for all the available configurations.
@ -91,7 +91,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/etcd/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name Etcd bitnami/etcd
docker run -it --name Etcd bitnami/etcd
```
### Docker Compose
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/etcd/docker-compose.yml
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/etcd/docker-compose.yml
docker-compose up
```
## Why use Bitnami Images?
@ -57,7 +57,7 @@ To run this application you need [Docker Engine](https://www.docker.com/products
The recommended way to get the Bitnami Etcd Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/etcd).
```console
$ docker pull bitnami/etcd:latest
docker pull bitnami/etcd:latest
```
To use a specific version, you can pull a versioned tag. You can view the
@ -65,15 +65,15 @@ To use a specific version, you can pull a versioned tag. You can view the
in the Docker Hub Registry.
```console
$ docker pull bitnami/etcd:[TAG]
docker pull bitnami/etcd:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -89,7 +89,7 @@ In this example, we will create a Etcd client instance that will connect to the
#### Step 1: Create a network
```console
$ docker network create app-tier --driver bridge
docker network create app-tier --driver bridge
```
#### Step 2: Launch the Etcd server instance
@ -97,7 +97,7 @@ $ docker network create app-tier --driver bridge
Use the `--network app-tier` argument to the `docker run` command to attach the Etcd container to the `app-tier` network.
```console
$ docker run -d --name Etcd-server \
docker run -d --name Etcd-server \
--network app-tier \
--publish 2379:2379 \
--publish 2380:2380 \
@ -111,7 +111,7 @@ $ docker run -d --name Etcd-server \
Finally we create a new container instance to launch the Etcd client and connect to the server created in the previous step:
```console
$ docker run -it --rm \
docker run -it --rm \
--network app-tier \
--env ALLOW_NONE_AUTHENTICATION=yes \
bitnami/etcd:latest etcdctl --endpoints http://etcd-server:2379 put /message Hello
@ -153,7 +153,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -161,7 +161,7 @@ $ docker-compose up -d
The configuration can easily be setup by mounting your own configuration file on the directory `/opt/bitnami/etcd/conf`:
```console
$ docker run --name Etcd -v /path/to/Etcd.conf.yml:/opt/bitnami/Etcd/conf/etcd.conf.yml bitnami/etcd:latest
docker run --name Etcd -v /path/to/Etcd.conf.yml:/opt/bitnami/Etcd/conf/etcd.conf.yml bitnami/etcd:latest
```
After that, your configuration will be taken into account in the server's behaviour.
@ -194,7 +194,7 @@ The previous rule applies to all [etcd flags](https://coreos.com/etcd/docs/lates
### 3.4.13-debian-10-r7
* Arbitrary user ID(s) are supported again, see https://github.com/etcd-io/etcd/issues/12158 for more information abut the changes in the upstream source code
* Arbitrary user ID(s) are supported again, see <https://github.com/etcd-io/etcd/issues/12158> for more information abut the changes in the upstream source code
### 3.4.10-debian-10-r0
@ -220,7 +220,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

52
bitnami/express/README.md
View File

@ -13,9 +13,9 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
### Local workspace
```console
$ mkdir ~/myapp && cd ~/myapp
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/express/docker-compose.yml
$ docker-compose up
mkdir ~/myapp && cd ~/myapp
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/express/docker-compose.yml
docker-compose up
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options for the [MongoDB&reg; container](https://github.com/bitnami/containers/blob/main/bitnami/mongodb#readme) for a more secure deployment.
@ -29,7 +29,7 @@ $ docker-compose up
* 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.
# Supported tags and respective `Dockerfile` links
## Supported tags and respective `Dockerfile` links
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
@ -59,13 +59,13 @@ cd ~/myapp
Download the [docker-compose.yml](https://raw.githubusercontent.com/bitnami/containers/main/bitnami/express/docker-compose.yml) file in the application directory:
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/express/docker-compose.yml
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/express/docker-compose.yml
```
Finally launch the Express application development environment using:
```console
$ docker-compose up
docker-compose up
```
Among other things, the above command creates a container service, named `myapp`, for Express development and bootstraps a new Express application in the application directory. You can use your favorite IDE for developing the application.
@ -89,30 +89,30 @@ Commands can be launched inside the `myapp` Express Development Container with `
The general structure of the `exec` command is:
```console
$ docker-compose exec <service> <command>
docker-compose exec <service> <command>
```
, where `<service>` is the name of the container service as described in the `docker-compose.yml` file and `<command>` is the command you want to launch inside the service.
Following are a few examples of launching some commonly used Express development commands inside the `myapp` service container.
- Load the Node.js REPL:
* Load the Node.js REPL:
```console
$ docker-compose exec myapp node
docker-compose exec myapp node
```
- List installed NPM modules:
* List installed NPM modules:
```console
$ docker-compose exec myapp npm ls
docker-compose exec myapp npm ls
```
- Install a NPM module:
* Install a NPM module:
```console
$ docker-compose exec myapp npm install bootstrap --save
$ docker-compose restart myapp
docker-compose exec myapp npm install bootstrap --save
docker-compose restart myapp
```
## Connecting to Database
@ -127,15 +127,15 @@ The Express Development Container generates a Dockerfile in your working directo
1. Build your Docker image
```console
$ docker build -t myregistry/myapp:1.0.0
```
```console
docker build -t myregistry/myapp:1.0.0
```
2. Push to an image registry
```console
$ docker push myregistry/myapp:1.0.0
```
```console
docker push myregistry/myapp:1.0.0
```
3. Update orchestration files to reference the pushed image
@ -143,11 +143,11 @@ The Express Development Container generates a Dockerfile in your working directo
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/blob/main/bitnami/express/issues/new). Be sure to include the following information in your issue:
- Host OS and version
- Docker version (`docker version`)
- Output of `docker info`
- Version of this container
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
* Host OS and version
* Docker version (`docker version`)
* Output of `docker info`
* Version of this container
* The command you used to run the container, and any relevant output you saw (masking any sensitive information)
### Community supported solution
@ -165,7 +165,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

5
bitnami/external-dns/README.md
View File

@ -13,7 +13,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
Deploy ExternalDNS on your [GKE cluster](https://github.com/kubernetes-incubator/external-dns/blob/master/docs/tutorials/nginx-ingress.md).
```console
$ docker run --name external-dns bitnami/external-dns:latest
docker run --name external-dns bitnami/external-dns:latest
```
## Why use Bitnami Images?
@ -56,13 +56,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

23
bitnami/fluent-bit/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name fluent-bit bitnami/fluent-bit:latest
docker run --name fluent-bit bitnami/fluent-bit:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Fluent Bit Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/fluent-bit).
```console
$ docker pull bitnami/fluent-bit:latest
docker pull bitnami/fluent-bit:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/fluent-bit/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/fluent-bit:[TAG]
docker pull bitnami/fluent-bit:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create fluent-bit-network --driver bridge
docker network create fluent-bit-network --driver bridge
```
#### Step 2: Launch the Fluent Bit container within your network
@ -76,7 +76,7 @@ $ docker network create fluent-bit-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `fluent-bit-network` network.
```console
$ docker run --name fluent-bit-node1 --network fluent-bit-network bitnami/fluent-bit:latest
docker run --name fluent-bit-node1 --network fluent-bit-network bitnami/fluent-bit:latest
```
#### Step 3: Run another container
@ -113,7 +113,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -133,7 +133,7 @@ Fluent Bit supports multiple extensions via plugins.
The Bitnami fluent-bit Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs fluent-bit
docker logs fluent-bit
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -155,13 +155,14 @@ The Bitnami team will review any PR that is created, feel free to create a PR if
New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

59
bitnami/fluentd/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name fluentd bitnami/fluentd:latest
docker run --name fluentd bitnami/fluentd:latest
```
You can find the available configuration options in the [Environment Variables](#environment-variables) section.
@ -42,21 +42,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Fluentd Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/fluentd).
```console
$ docker pull bitnami/fluentd:latest
docker pull bitnami/fluentd:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/fluentd/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/fluentd:[TAG]
docker pull bitnami/fluentd:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -70,7 +70,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create fluentd-network --driver bridge
docker network create fluentd-network --driver bridge
```
#### Step 2: Launch the Fluentd container within your network
@ -78,7 +78,7 @@ $ docker network create fluentd-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `fluentd-network` network.
```console
$ docker run --name fluentd-node1 --network fluentd-network bitnami/fluentd:latest
docker run --name fluentd-node1 --network fluentd-network bitnami/fluentd:latest
```
#### Step 3: Run another containers
@ -90,20 +90,20 @@ We can launch another containers using the same flag (`--network NETWORK`) in th
To create an endpoint that collects logs on your host just run:
```console
$ docker run -d -p 24224:24224 -p 24224:24224/udp -v /data:/opt/bitnami/fluentd/log fluentd
docker run -d -p 24224:24224 -p 24224:24224/udp -v /data:/opt/bitnami/fluentd/log fluentd
```
Default configurations are:
- configuration file at `/opt/bitnami/fluentd/conf/fluentd.conf`
- listen port `24224` for Fluentd forward protocol
- store logs with tag `docker.**` into `/opt/bitnami/fluentd/log/docker.*.log`
- store all other logs into `/opt/bitnami/fluentd/log/data.*.log`
* configuration file at `/opt/bitnami/fluentd/conf/fluentd.conf`
* listen port `24224` for Fluentd forward protocol
* store logs with tag `docker.**` into `/opt/bitnami/fluentd/log/docker.*.log`
* store all other logs into `/opt/bitnami/fluentd/log/data.*.log`
You can overwrite the default configuration file by mounting your own configuration file on the directory `/opt/bitnami/fluentd/conf`:
```console
$ docker run --name fluentd -v /path/to/fluentd.conf:/opt/bitnami/fluentd/conf/fluentd.conf bitnami/fluentd:latest
docker run --name fluentd -v /path/to/fluentd.conf:/opt/bitnami/fluentd/conf/fluentd.conf bitnami/fluentd:latest
```
You can also do this by changing the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/fluentd/docker-compose.yml) file present in this repository:
@ -119,7 +119,7 @@ fluentd:
You can also extend the default configuration by importing your custom configuration with the "@include" directive. It is a simple as creating a directory with you custom config files and mount it on the directory `/opt/bitnami/fluentd/conf/conf.d`:
```console
$ docker run --name fluentd -v /path/to/custom-conf-directory:/opt/bitnami/fluentd/conf/conf.d bitnami/fluentd:latest
docker run --name fluentd -v /path/to/custom-conf-directory:/opt/bitnami/fluentd/conf/conf.d bitnami/fluentd:latest
```
You can also do this by changing the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/fluentd/docker-compose.yml) file present in this repository:
@ -138,17 +138,17 @@ Find more information about this feature, consult [official documentation](https
Environment variable below are configurable to control how to execute fluentd process:
- `FLUENTD_CONF`: This variable allows you to specify configuration file name that will be used in -c Fluentd command line option. If you want to use your own configuration file (without any optional plugins), you can do it with this environment variable and Docker volumes (`-v` option of `docker run`).
- `FLUENTD_OPT`: Use this variable to specify other Fluentd command line options, like -v or -q.
- `FLUENTD_DAEMON_USER`: The user that will run the `fluentd` process when the container is run as root.
- `FLUENTD_DAEMON_GROUP`: The group of the user that will run the `fluentd` process when the container is run as root.
* `FLUENTD_CONF`: This variable allows you to specify configuration file name that will be used in -c Fluentd command line option. If you want to use your own configuration file (without any optional plugins), you can do it with this environment variable and Docker volumes (`-v` option of `docker run`).
* `FLUENTD_OPT`: Use this variable to specify other Fluentd command line options, like -v or -q.
* `FLUENTD_DAEMON_USER`: The user that will run the `fluentd` process when the container is run as root.
* `FLUENTD_DAEMON_GROUP`: The group of the user that will run the `fluentd` process when the container is run as root.
## Logging
The Bitnami fluentd Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs fluentd
docker logs fluentd
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -161,8 +161,8 @@ The Bitnami Fluentd Open Source Docker image is designed to be extended so it ca
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can modify the Fluentd command-line options setting the environment variable `FLUENTD_OPT`.
- [Replacing the default configuration file by mounting your own configuration file ](#configuration).
* Settings that can be adapted using environment variables. For instance, you can modify the Fluentd command-line options setting the environment variable `FLUENTD_OPT`.
* [Replacing the default configuration file by mounting your own configuration file](#configuration).
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
@ -190,7 +190,7 @@ Bitnami provides up-to-date versions of fluentd, including security patches, soo
#### Step 1: Get the updated image
```console
$ docker pull bitnami/fluentd:latest
docker pull bitnami/fluentd:latest
```
#### Step 2: Stop and backup the currently running container
@ -198,13 +198,13 @@ $ docker pull bitnami/fluentd:latest
Stop the currently running container using the command
```console
$ docker stop fluentd
docker stop fluentd
```
Next, take a snapshot of the persistent volume `/path/to/fluentd-persistence` using:
```console
$ rsync -a /path/to/fluentd-persistence /path/to/fluentd-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/fluentd-persistence /path/to/fluentd-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the database state should the upgrade fail.
@ -212,15 +212,15 @@ You can use this snapshot to restore the database state should the upgrade fail.
#### Step 3: Remove the currently running container
```console
$ docker rm -v fluentd
docker rm -v fluentd
```
#### Step 4: Run the new image
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
Re-create your container from the new image, restoring your backup if necessary.
```console
$ docker run --name fluentd bitnami/fluentd:latest
docker run --name fluentd bitnami/fluentd:latest
```
## Contributing
@ -232,13 +232,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

76
bitnami/ghost/README.md
View File

@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ghost/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ghost/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@ -26,7 +26,7 @@ $ docker-compose up -d
- 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.
# How to deploy Ghost in Kubernetes?
## How to deploy Ghost in Kubernetes?
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami Ghost Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/ghost).
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Ghost Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/ghost).
```console
$ docker pull bitnami/ghost:latest
docker pull bitnami/ghost:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/ghost/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/ghost:[TAG]
docker pull bitnami/ghost:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## How to use this image
@ -75,8 +75,8 @@ Ghost requires access to a MySQL or MariaDB database to store information. We'll
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/ghost/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ghost/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/ghost/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -86,14 +86,14 @@ If you want to run the application manually instead of using `docker-compose`, t
#### Step 1: Create a network
```console
$ docker network create ghost-network
docker network create ghost-network
```
#### Step 2: Create a volume for MySQL persistence and create a MySQL container
```console
$ docker volume create --name mysql_data
$ docker run -d --name mysql \
docker volume create --name mysql_data
docker run -d --name mysql \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MYSQL_USER=bn_ghost \
--env MYSQL_PASSWORD=bitnami \
@ -106,8 +106,8 @@ $ docker run -d --name mysql \
#### Step 3: Create volumes for Ghost persistence and launch the container
```console
$ docker volume create --name ghost_data
$ docker run -d --name ghost \
docker volume create --name ghost_data
docker run -d --name ghost \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env GHOST_DATABASE_USER=bn_ghost \
@ -161,13 +161,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
#### Step 1: Create a network (if it does not exist)
```console
$ docker network create ghost-network
docker network create ghost-network
```
#### Step 2. Create a MySQL container with host volume
```console
$ docker run -d --name mysql \
docker run -d --name mysql \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MYSQL_USER=bn_ghost \
--env MYSQL_PASSWORD=bitnami \
@ -180,7 +180,7 @@ $ docker run -d --name mysql \
#### Step 3. Create the Ghost container with host volumes
```console
$ docker run -d --name ghost \
docker run -d --name ghost \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env GHOST_DATABASE_USER=bn_ghost \
@ -210,7 +210,7 @@ When you start the Ghost image, you can adjust the configuration of the instance
- For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name ghost -p 80:8080 -p 443:8443 \
docker run -d --name ghost -p 80:8080 -p 443:8443 \
--env GHOST_PASSWORD=my_password \
--network ghost-tier \
--volume /path/to/ghost-persistence:/bitnami/ghost \
@ -219,7 +219,7 @@ When you start the Ghost image, you can adjust the configuration of the instance
Available environment variables:
##### User and Site configuration
#### User and Site configuration
- `GHOST_USERNAME`: Ghost application username. Default: **user**
- `GHOST_PASSWORD`: Ghost application password. Default: **bitnami123**
@ -232,7 +232,7 @@ Available environment variables:
- `GHOST_EXTERNAL_HTTPS_PORT_NUMBER`: Port to used by Ghost to generate URLs and links when accessing using HTTPS. Default: **443**
- `GHOST_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. This is necessary in case you use a database that already has Ghost data. Default: **no**
##### Database connection configuration
#### Database connection configuration
- `GHOST_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mysql**
- `GHOST_DATABASE_PORT_NUMBER`: Port used by the MariaDB or MySQL server. Default: **3306**
@ -243,7 +243,7 @@ Available environment variables:
- `GHOST_DATABASE_SSL_CA_FILE`: Path to the database SSL CA file. No default.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### Create a database for Ghost using mysql-client
#### Create a database for Ghost using mysql-client
- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mysql**
- `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by the MariaDB or MySQL server. Default: **3306**
@ -258,7 +258,7 @@ Available environment variables:
- `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No default.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### SMTP Configuration
#### SMTP Configuration
To configure Ghost to send email using SMTP you can set the following environment variables:
@ -294,7 +294,7 @@ This would be an example of SMTP configuration using a Gmail account:
- For manual execution:
```console
$ docker run -d --name ghost -p 80:8080 -p 443:8443 \
docker run -d --name ghost -p 80:8080 -p 443:8443 \
--env GHOST_DATABASE_USER=bn_ghost \
--env GHOST_DATABASE_NAME=bitnami_ghost \
--env GHOST_SMTP_HOST=smtp.gmail.com \
@ -330,7 +330,7 @@ The Bitnami Ghost container supports connecting the Ghost application to an exte
- For manual execution:
```console
$ docker run -d --name ghost\
docker run -d --name ghost\
-p 8080:8080 -p 8443:8443 \
--network ghost-network \
--env GHOST_DATABASE_HOST=mysql_host \
@ -349,13 +349,13 @@ In case the database already contains data from a previous Ghost installation, y
The Bitnami Ghost Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs ghost
docker logs ghost
```
Or using Docker Compose:
```console
$ docker-compose logs ghost
docker-compose logs ghost
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -369,13 +369,13 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
```console
$ docker stop ghost
docker stop ghost
```
Or using Docker Compose:
```console
$ docker-compose stop ghost
docker-compose stop ghost
```
#### Step 2: Run the backup command
@ -383,7 +383,7 @@ $ docker-compose stop ghost
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/ghost-backups:/backups --volumes-from ghost busybox \
docker run --rm -v /path/to/ghost-backups:/backups --volumes-from ghost busybox \
cp -a /bitnami/ghost /backups/latest
```
@ -394,7 +394,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the MySQL database container:
```diff
$ docker run -d --name mysql \
docker run -d --name mysql \
...
- --volume /path/to/mysql-persistence:/bitnami/mysql \
+ --volume /path/to/mysql-backups/latest:/bitnami/mysql \
@ -404,7 +404,7 @@ For the MySQL database container:
For the Ghost container:
```diff
$ docker run -d --name ghost \
docker run -d --name ghost \
...
- --volume /path/to/ghost-persistence:/bitnami/ghost \
+ --volume /path/to/ghost-backups/latest:/bitnami/ghost \
@ -413,14 +413,14 @@ For the Ghost container:
### Upgrade this image
Bitnami provides up-to-date versions of MySQL and Ghost, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Ghost container. For the MySQL upgrade see: https://github.com/bitnami/containers/blob/main/bitnami/mysql/blob/master/README.md#upgrade-this-image
Bitnami provides up-to-date versions of MySQL and Ghost, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Ghost container. For the MySQL upgrade see: <https://github.com/bitnami/containers/blob/main/bitnami/mysql/blob/master/README.md#upgrade-this-image>
The `bitnami/ghost:latest` tag always points to the most recent release. To get the most recent release you can simple repull the `latest` tag from the Docker Hub with `docker pull bitnami/ghost:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/ghost/tags/).
#### Step 1: Get the updated image
```console
$ docker pull bitnami/ghost:latest
docker pull bitnami/ghost:latest
```
#### Step 2: Stop the running container
@ -428,7 +428,7 @@ $ docker pull bitnami/ghost:latest
Stop the currently running container using the command
```console
$ docker-compose stop ghost
docker-compose stop ghost
```
#### Step 3: Take a snapshot of the application state
@ -448,7 +448,7 @@ docker-compose rm -v ghost
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
## Customize this image
@ -496,7 +496,7 @@ RUN cd /bitnami/ghost \
1. Prepare npm and install an adapter.
2. Add configuration for the adapter.
#### Create a script named `post_ghost_config.sh` using `jq` for adding configuration to the `config.production.json`.
#### Create a script named `post_ghost_config.sh` using `jq` for adding configuration to the `config.production.json`
```console
#!/bin/bash -e
@ -547,7 +547,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

20
bitnami/git/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name git bitnami/git:latest
docker run --name git bitnami/git:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Git Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/git).
```console
$ docker pull bitnami/git:latest
docker pull bitnami/git:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/git/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/git:[TAG]
docker pull bitnami/git:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -60,15 +60,15 @@ $ docker build -t bitnami/APP:latest .
To run commands inside this container you can use `docker run`, for example to execute `git version` you can follow below example
```console
$ docker run --name git bitnami/git:latest git --version
docker run --name git bitnami/git:latest git --version
```
## Notable Changes
### 2.31.0-debian-10-r2
- The `ENTRYPOINT` of the container has been modified to load a proper NSS environment that enables git ssh connections when running the container as non-root.
- The `CMD` is also changed to enter the Bash shell.
* The `ENTRYPOINT` of the container has been modified to load a proper NSS environment that enables git ssh connections when running the container as non-root.
* The `CMD` is also changed to enter the Bash shell.
If you were using the container without replacing the entrypoint [`ENTRYPOINT [ "git" ]`](https://github.com/bitnami/containers/blob/main/bitnami/git/blob/af46ea91cebed3de1a863cb9969210688131b4e9/2/debian-10/Dockerfile#L19), make sure you specify the `git` command now:
@ -93,7 +93,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

60
bitnami/gitea/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name gitea bitnami/gitea:latest
docker run --name gitea bitnami/gitea:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gitea/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gitea/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Gitea Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/gitea).
```console
$ docker pull bitnami/gitea:latest
docker pull bitnami/gitea:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/gitea/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/gitea:[TAG]
docker pull bitnami/gitea:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -73,7 +73,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami/gitea` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
--volume /path/to/gitea-persistence:/bitnami/gitea \
--env ALLOM_EMPTY_PASSWORD=false \
bitnami/gitea:latest
@ -102,7 +102,7 @@ In this example, we will create a Gitea client instance that will connect to the
#### Step 1: Create a network
```console
$ docker network create my-network --driver bridge
docker network create my-network --driver bridge
```
#### Step 2: Launch the Gitea container within your network
@ -110,7 +110,7 @@ $ docker network create my-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `my-network` network.
```console
$ docker run -d --name gitea-server \
docker run -d --name gitea-server \
--network my-network \
--env ALLOW_EMPTY_PASSWORD=yes \
bitnami/gitea:latest
@ -121,7 +121,7 @@ $ docker run -d --name gitea-server \
Finally we create a new container instance to launch the Gitea client and connect to the server created in the previous step:
```console
$ docker run -it --rm \
docker run -it --rm \
--network my-network \
bitnami/gitea:latest gitea-client --host gitea-server
```
@ -158,7 +158,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -170,7 +170,7 @@ Gitea can be configured via environment variables or using a configuration file
The configuration can easily be setup by mounting your own configuration overrides on the directory `/bitnami/gitea/custom/conf/app.ini`:
```console
$ docker run --name gitea \
docker run --name gitea \
--volume /path/to/override.ini:/bitnami/gitea/custom/conf/app.ini:ro \
bitnami/gitea:latest
```
@ -197,14 +197,14 @@ In order to have your custom files inside the docker image you can mount them as
The admin user and password can easily be setup with the Bitnami Gitea Docker image using the following environment variables:
- `GITEA_ADMIN_USER`: Admin user name. Defaults to `bn_user`.
- `GITEA_ADMIN_PASSWORD`: Admin password. Defaults to `bitnami`.
- `GITEA_ADMIN_EMAIL`: Admin user email. Defaults to `user@bitnami.org`.
* `GITEA_ADMIN_USER`: Admin user name. Defaults to `bn_user`.
* `GITEA_ADMIN_PASSWORD`: Admin password. Defaults to `bitnami`.
* `GITEA_ADMIN_EMAIL`: Admin user email. Defaults to `user@bitnami.org`.
Passing the `GITEA_ADMIN_PASSWORD` environment variable when running the image for the first time will set the password of the `GITEA_ADMIN_USER` user to the value of `GITEA_ADMIN_PASSWORD`.
```console
$ docker run --name gitea -e GITEA_ADMIN_PASSWORD=password123 bitnami/gitea:latest
docker run --name gitea -e GITEA_ADMIN_PASSWORD=password123 bitnami/gitea:latest
```
or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/gitea/docker-compose.yml) file present in this repository:
@ -222,15 +222,15 @@ services:
Gitea default ports can be changed using the following environment variables:
- `GITEA_HTTP_PORT`: HTTP port. Defaults to `3000`.
- `GITEA_SSH_LISTEN_PORT`: Port for the built-in SSH server. Defaults to `2222`
* `GITEA_HTTP_PORT`: HTTP port. Defaults to `3000`.
* `GITEA_SSH_LISTEN_PORT`: Port for the built-in SSH server. Defaults to `2222`
## Logging
The Bitnami Gitea Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs gitea
docker logs gitea
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -244,7 +244,7 @@ Bitnami provides up-to-date versions of Gitea, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/gitea:latest
docker pull bitnami/gitea:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/gitea:latest`.
@ -254,31 +254,31 @@ or if you're using Docker Compose, update the value of the image property to `bi
Stop the currently running container using the command
```console
$ docker stop gitea
docker stop gitea
```
or using Docker Compose:
```console
$ docker-compose stop gitea
docker-compose stop gitea
```
Next, take a snapshot of the persistent volume `/path/to/gitea-persistence` using:
```console
$ rsync -a /path/to/gitea-persistence /path/to/gitea-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/gitea-persistence /path/to/gitea-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v gitea
docker rm -v gitea
```
or using Docker Compose:
```console
$ docker-compose rm -v gitea
docker-compose rm -v gitea
```
#### Step 4: Run the new image
@ -286,13 +286,13 @@ $ docker-compose rm -v gitea
Re-create your container from the new image.
```console
$ docker run --name gitea bitnami/gitea:latest
docker run --name gitea bitnami/gitea:latest
```
or using Docker Compose:
```console
$ docker-compose up gitea
docker-compose up gitea
```
## Contributing
@ -311,7 +311,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/gitlab-runner-helper/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name gitlab-runner-helper bitnami/gitlab-runner-helper
docker run -it --name gitlab-runner-helper bitnami/gitlab-runner-helper
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gitlab-runner-helper/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gitlab-runner-helper/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,13 +43,13 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Gitlab Runner Helper Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/gitlab-runner-helper).
```console
$ docker pull bitnami/gitlab-runner:latest
docker pull bitnami/gitlab-runner:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/gitlab-runner-helper/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/gitlab-runner-helper:[TAG]
docker pull bitnami/gitlab-runner-helper:[TAG]
```
If you wish, you can also build the image yourself.
@ -57,9 +57,9 @@ If you wish, you can also build the image yourself.
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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -71,7 +71,7 @@ Bitnami provides up-to-date versions of Gitlab Runner Helper, including security
#### Step 1: Get the updated image
```console
$ docker pull bitnami/gitlab-runner-helper:latest
docker pull bitnami/gitlab-runner-helper:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/gitlab-runner-helper:latest`.
@ -79,13 +79,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v gitlab-runner-helper
docker rm -v gitlab-runner-helper
```
or using Docker Compose:
```console
$ docker-compose rm -v gitlab-runner-helper
docker-compose rm -v gitlab-runner-helper
```
#### Step 3: Run the new image
@ -93,13 +93,13 @@ $ docker-compose rm -v gitlab-runner-helper
Re-create your container from the new image.
```console
$ docker run --name gitlab-runner-helper bitnami/gitlab-runner-helper:latest
docker run --name gitlab-runner-helper bitnami/gitlab-runner-helper:latest
```
or using Docker Compose:
```console
$ docker-compose up gitlab-runner-helper
docker-compose up gitlab-runner-helper
```
## Configuration
@ -109,7 +109,7 @@ $ docker-compose up gitlab-runner-helper
To run commands inside this container you can use `docker run`, for example to execute `gitlab-runner-helper --help` you can follow the example below:
```console
$ docker run --rm --name gitlab-runner-helper bitnami/gitlab-runner–helper:latest --help
docker run --rm --name gitlab-runner-helper bitnami/gitlab-runner–helper:latest --help
```
Check the [official Gitlab Runner Helper documentation](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#helper-image) for the list of the available parameters.
@ -130,7 +130,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/gitlab-runner/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name gitlab-runner bitnami/gitlab-runner
docker run -it --name gitlab-runner bitnami/gitlab-runner
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gitlab-runner/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gitlab-runner/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Gitlab Runner Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/gitlab-runner).
```console
$ docker pull bitnami/gitlab-runner:latest
docker pull bitnami/gitlab-runner:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/gitlab-runner/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/gitlab-runner:[TAG]
docker pull bitnami/gitlab-runner:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -69,7 +69,7 @@ Bitnami provides up-to-date versions of Gitlab Runner, including security patche
#### Step 1: Get the updated image
```console
$ docker pull bitnami/gitlab-runner:latest
docker pull bitnami/gitlab-runner:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/gitlab-runner:latest`.
@ -77,13 +77,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v gitlab-runner
docker rm -v gitlab-runner
```
or using Docker Compose:
```console
$ docker-compose rm -v gitlab-runner
docker-compose rm -v gitlab-runner
```
#### Step 3: Run the new image
@ -91,13 +91,13 @@ $ docker-compose rm -v gitlab-runner
Re-create your container from the new image.
```console
$ docker run --name gitlab-runner bitnami/gitlab-runner:latest
docker run --name gitlab-runner bitnami/gitlab-runner:latest
```
or using Docker Compose:
```console
$ docker-compose up gitlab-runner
docker-compose up gitlab-runner
```
## Configuration
@ -107,7 +107,7 @@ $ docker-compose up gitlab-runner
To run commands inside this container you can use `docker run`, for example to execute `gitlab-runner --help` you can follow the example below:
```console
$ docker run --rm --name gitlab-runner bitnami/gitlab-runner:latest --help
docker run --rm --name gitlab-runner bitnami/gitlab-runner:latest --help
```
Check the [official Gitlab Runner documentation](https://docs.gitlab.com/runner/commands/) for the list of the available parameters.
@ -128,7 +128,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

36
bitnami/golang/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name golang bitnami/golang:latest
docker run --name golang bitnami/golang:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/golang/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/golang/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Golang Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/golang).
```console
$ docker pull bitnami/golang:latest
docker pull bitnami/golang:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/golang/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/golang:[TAG]
docker pull bitnami/golang:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -65,7 +65,7 @@ $ docker build -t bitnami/APP:latest .
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/golang-persistence:/bitnami \
bitnami/golang:latest
```
@ -91,7 +91,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create golang-network --driver bridge
docker network create golang-network --driver bridge
```
#### Step 2: Launch the Golang container within your network
@ -99,7 +99,7 @@ $ docker network create golang-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `golang-network` network.
```console
$ docker run --name golang-node1 --network golang-network bitnami/golang:latest
docker run --name golang-node1 --network golang-network bitnami/golang:latest
```
#### Step 3: Run another containers
@ -113,7 +113,7 @@ We can launch another containers using the same flag (`--network NETWORK`) in th
The default workspace for the Bitnami Golang image is `/go` (GOPATH, consult [Golang documentation](https://golang.org/doc/gopath_code#Workspaces) for more info about workspaces). You can mount your custom Golang project from your host, and run it normally using the `go` command.
```console
$ docker -it --name golang run \
docker -it --name golang run \
-v /path/to/your/project:/go/src/project \
bitnami/golang \
bash -ec 'cd src/project && go run .'
@ -124,7 +124,7 @@ $ docker -it --name golang run \
The Bitnami Golang Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs golang
docker logs golang
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -138,7 +138,7 @@ Bitnami provides up-to-date versions of Golang, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/golang:latest
docker pull bitnami/golang:latest
```
#### Step 2: Stop the running container
@ -146,13 +146,13 @@ $ docker pull bitnami/golang:latest
Stop the currently running container using the command
```console
$ docker stop golang
docker stop golang
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v golang
docker rm -v golang
```
#### Step 4: Run the new image
@ -160,7 +160,7 @@ $ docker rm -v golang
Re-create your container from the new image.
```console
$ docker run --name golang bitnami/golang:latest
docker run --name golang bitnami/golang:latest
```
## Contributing
@ -179,7 +179,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/google-cloud-sdk/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name google-cloud-sdk bitnami/google-cloud-sdk:latest
docker run --name google-cloud-sdk bitnami/google-cloud-sdk:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami google-cloud-sdk Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/google-cloud-sdk).
```console
$ docker pull bitnami/google-cloud-sdk:latest
docker pull bitnami/google-cloud-sdk:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/google-cloud-sdk/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/google-cloud-sdk:[TAG]
docker pull bitnami/google-cloud-sdk:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -60,7 +60,7 @@ $ docker build -t bitnami/APP:latest .
To run commands inside this container you can use `docker run`, for example to execute `google-cloud-sdk --version` you can follow the example below:
```console
$ docker run --rm --name google-cloud-sdk bitnami/google-cloud-sdk:latest -- --version
docker run --rm --name google-cloud-sdk bitnami/google-cloud-sdk:latest -- --version
```
Consult the [google-cloud-sdk Reference Documentation](https://cloud.google.com/sdk/gcloud) to find the completed list of commands available.
@ -70,7 +70,7 @@ Consult the [google-cloud-sdk Reference Documentation](https://cloud.google.com/
It's possible to load your own configuration, which is useful if you want to connect to a remote cluster:
```console
$ docker run --rm --name google-cloud-sdk -v /path/to/your/gcloud/config:/.config/gcloud/configurations/config_default bitnami/google-cloud-sdk:latest
docker run --rm --name google-cloud-sdk -v /path/to/your/gcloud/config:/.config/gcloud/configurations/config_default bitnami/google-cloud-sdk:latest
```
## Contributing
@ -89,7 +89,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/gotrue/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name gotrue bitnami/gotrue
docker run -it --name gotrue bitnami/gotrue
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gotrue/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gotrue/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami GoTrue Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/gotrue).
```console
$ docker pull bitnami/gotrue:latest
docker pull bitnami/gotrue:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/gotrue/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/gotrue:[TAG]
docker pull bitnami/gotrue:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -69,7 +69,7 @@ Bitnami provides up-to-date versions of GoTrue, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/gotrue:latest
docker pull bitnami/gotrue:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/gotrue:latest`.
@ -77,13 +77,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v gotrue
docker rm -v gotrue
```
or using Docker Compose:
```console
$ docker-compose rm -v gotrue
docker-compose rm -v gotrue
```
#### Step 3: Run the new image
@ -91,13 +91,13 @@ $ docker-compose rm -v gotrue
Re-create your container from the new image.
```console
$ docker run --name gotrue bitnami/gotrue:latest
docker run --name gotrue bitnami/gotrue:latest
```
or using Docker Compose:
```console
$ docker-compose up gotrue
docker-compose up gotrue
```
## Configuration
@ -107,7 +107,7 @@ $ docker-compose up gotrue
To run commands inside this container you can use `docker run`, for example to execute `gotrue --help` you can follow the example below:
```console
$ docker run --rm --name gotrue bitnami/gotrue:latest --help
docker run --rm --name gotrue bitnami/gotrue:latest --help
```
Check the [official GoTrue documentation](https://github.com/netlify/gotrue) for more information about how to use GoTrue.
@ -128,7 +128,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

34
bitnami/gradle/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name gradle bitnami/gradle
docker run -it --name gradle bitnami/gradle
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gradle/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/gradle/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Gradle Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/gradle).
```console
$ docker pull bitnami/gradle:latest
docker pull bitnami/gradle:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/gradle/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/gradle:[TAG]
docker pull bitnami/gradle:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -67,14 +67,14 @@ $ docker build -t bitnami/APP:latest .
The default work directory for the Gradle image is `/app`. You can mount a folder from your host here that includes your Gradle build script, and run any task specifying its identifier.
```console
$ docker run --name gradle -v /path/to/app:/app bitnami/gradle \
docker run --name gradle -v /path/to/app:/app bitnami/gradle \
build
```
**Further Reading:**
- [gradle documentation](https://docs.gradle.org/)
- [gradle command-line interface](https://docs.gradle.org/current/userguide/command_line_interface.html)
* [gradle documentation](https://docs.gradle.org/)
* [gradle command-line interface](https://docs.gradle.org/current/userguide/command_line_interface.html)
## Maintenance
@ -85,7 +85,7 @@ Bitnami provides up-to-date versions of Gradle, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/gradle:latest
docker pull bitnami/gradle:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/gradle:latest`.
@ -93,13 +93,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v gradle
docker rm -v gradle
```
or using Docker Compose:
```console
$ docker-compose rm -v gradle
docker-compose rm -v gradle
```
#### Step 3: Run the new image
@ -107,13 +107,13 @@ $ docker-compose rm -v gradle
Re-create your container from the new image.
```console
$ docker run --name gradle bitnami/gradle:latest
docker run --name gradle bitnami/gradle:latest
```
or using Docker Compose:
```console
$ docker-compose up gradle
docker-compose up gradle
```
## Contributing
@ -132,7 +132,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

32
bitnami/grafana-image-renderer/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
```
## Why use Bitnami Images?
@ -46,21 +46,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Grafana Image Renderer Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-image-renderer).
```console
$ docker pull bitnami/grafana-image-renderer:latest
docker pull bitnami/grafana-image-renderer:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-image-renderer/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana-image-renderer:[TAG]
docker pull bitnami/grafana-image-renderer:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -74,7 +74,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create my-network --driver bridge
docker network create my-network --driver bridge
```
#### Step 2: Launch the grafana-image-renderer container within your network
@ -82,7 +82,7 @@ $ docker network create my-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `my-network` network.
```console
$ docker run -d --name grafana-image-renderer \
docker run -d --name grafana-image-renderer \
--env HTTP_PORT="8080" \
--env HTTP_HOST="0.0.0.0" \
--network my-network \
@ -94,7 +94,7 @@ $ docker run -d --name grafana-image-renderer \
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `my-network` network.
```console
$ docker run -d --name grafana \
docker run -d --name grafana \
--network my-network \
--publish 3000:3000 \
--env GF_RENDERING_SERVER_URL="http://grafana-image-renderer:8080/render" \
@ -146,7 +146,7 @@ vi /path/to/grafana-image-renderer-conf/config.json
After changing the configuration, restart your Grafana Image Renderer container for changes to take effect. Using Docker Compose:
```console
$ docker-compose restart grafana-image-renderer
docker-compose restart grafana-image-renderer
```
After that, your configuration will be taken into account in the server's behaviour.
@ -156,7 +156,7 @@ After that, your configuration will be taken into account in the server's behavi
The Bitnami Grafana Image Renderer Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs grafana-image-renderer
docker logs grafana-image-renderer
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -170,7 +170,7 @@ Bitnami provides up-to-date versions of Grafana Image Renderer, including securi
#### Step 1: Get the updated image
```console
$ docker pull bitnami/grafana-image-renderer:latest
docker pull bitnami/grafana-image-renderer:latest
```
#### Step 2: Stop the currently running container
@ -178,13 +178,13 @@ $ docker pull bitnami/grafana-image-renderer:latest
Stop the currently running container using the command
```console
$ docker stop grafana-image-renderer
docker stop grafana-image-renderer
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v grafana-image-renderer
docker rm -v grafana-image-renderer
```
#### Step 4: Run the new image
@ -192,7 +192,7 @@ $ docker rm -v grafana-image-renderer
Re-create your container from the new image:
```console
$ docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
```
## Contributing
@ -211,7 +211,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/grafana-loki/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name grafana-loki bitnami/grafana-loki:latest
docker run --name grafana-loki bitnami/grafana-loki:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami grafana-loki Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-loki).
```console
$ docker pull bitnami/grafana-loki:latest
docker pull bitnami/grafana-loki:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-loki/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana-loki:[TAG]
docker pull bitnami/grafana-loki:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,13 +64,13 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `grafana-loki --version` you can follow the example below:
```console
$ docker run --rm --name grafana-loki bitnami/grafana-loki:latest -- --version
docker run --rm --name grafana-loki bitnami/grafana-loki:latest -- --version
```
In order for the container to work, you need to mount your custom `loki.yaml` file in `/bitnami/grafana-loki/conf/`. The following example runs Grafana Loki with a custom configuration file:
```console
$ docker run --rm --name grafana-loki -v /path/to/loki.yaml:/bitnami/grafana-loki/conf/loki.yaml bitnami/grafana-loki:latest
docker run --rm --name grafana-loki -v /path/to/loki.yaml:/bitnami/grafana-loki/conf/loki.yaml bitnami/grafana-loki:latest
```
Using docker-compose:
@ -103,7 +103,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/grafana-mimir/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name grafana-mimir bitnami/grafana-mimir:latest
docker run --name grafana-mimir bitnami/grafana-mimir:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami grafana-mimir Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-mimir).
```console
$ docker pull bitnami/grafana-mimir:latest
docker pull bitnami/grafana-mimir:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-mimir/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana-mimir:[TAG]
docker pull bitnami/grafana-mimir:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,13 +64,13 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `grafana-mimir --version` you can follow the example below:
```console
$ docker run --rm --name grafana-mimir bitnami/grafana-mimir:latest -- --version
docker run --rm --name grafana-mimir bitnami/grafana-mimir:latest -- --version
```
In order for the container to work, you need to mount your custom `mimir.yaml` file in `/bitnami/grafana-mimir/conf/`. The following example runs Grafana Mimir with a custom configuration file:
```console
$ docker run --rm --name grafana-mimir -v /path/to/mimir.yaml:/bitnami/grafana-mimir/conf/mimir.yaml bitnami/grafana-mimir:latest
docker run --rm --name grafana-mimir -v /path/to/mimir.yaml:/bitnami/grafana-mimir/conf/mimir.yaml bitnami/grafana-mimir:latest
```
Using docker-compose:
@ -103,7 +103,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

13
bitnami/grafana-operator/README.md
View File

@ -44,21 +44,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Grafana Operator Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-operator).
```console
$ docker pull bitnami/grafana-operator:latest
docker pull bitnami/grafana-operator:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-operator/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana-operator:[TAG]
docker pull bitnami/grafana-operator:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -74,13 +74,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/grafana-tempo-query/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name grafana-tempo-query bitnami/grafana-tempo-query:latest
docker run --name grafana-tempo-query bitnami/grafana-tempo-query:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami grafana-tempo-query Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-tempo-query).
```console
$ docker pull bitnami/grafana-tempo-query:latest
docker pull bitnami/grafana-tempo-query:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-tempo-query/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana-tempo-query:[TAG]
docker pull bitnami/grafana-tempo-query:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,13 +64,13 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `grafana-tempo-query --version` you can follow the example below:
```console
$ docker run --rm --name grafana-tempo-query bitnami/grafana-tempo-query:latest -- --version
docker run --rm --name grafana-tempo-query bitnami/grafana-tempo-query:latest -- --version
```
In order for the container to work, you need to mount your custom `tempo-query.yaml` file in `/bitnami/grafana-tempo-query/conf/`. The following example runs Grafana Tempo Query with a custom configuration file:
```console
$ docker run --rm --name grafana-tempo-query -v /path/to/tempo-query.yaml:/bitnami/grafana-tempo-query/conf/tempo-query.yaml bitnami/grafana-tempo-query:latest
docker run --rm --name grafana-tempo-query -v /path/to/tempo-query.yaml:/bitnami/grafana-tempo-query/conf/tempo-query.yaml bitnami/grafana-tempo-query:latest
```
Using docker-compose:
@ -103,7 +103,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

16
bitnami/grafana-tempo-vulture/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name grafana-tempo-vulture bitnami/grafana-tempo-vulture:latest
docker run --name grafana-tempo-vulture bitnami/grafana-tempo-vulture:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami grafana-tempo-vulture Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-tempo-vulture).
```console
$ docker pull bitnami/grafana-tempo-vulture:latest
docker pull bitnami/grafana-tempo-vulture:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-tempo-vulture/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana-tempo-vulture:[TAG]
docker pull bitnami/grafana-tempo-vulture:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,7 +64,7 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `grafana-tempo-vulture --version` you can follow the example below:
```console
$ docker run --rm --name grafana-tempo-vulture bitnami/grafana-tempo-vulture:latest -- --version
docker run --rm --name grafana-tempo-vulture bitnami/grafana-tempo-vulture:latest -- --version
```
Check the [official Grafana Tempo documentation](https://grafana.com/docs/tempo/latest/configuration/) to understand the possible configurations.
@ -85,7 +85,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/grafana-tempo/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name grafana-tempo bitnami/grafana-tempo:latest
docker run --name grafana-tempo bitnami/grafana-tempo:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami grafana-tempo Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-tempo).
```console
$ docker pull bitnami/grafana-tempo:latest
docker pull bitnami/grafana-tempo:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-tempo/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana-tempo:[TAG]
docker pull bitnami/grafana-tempo:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,13 +64,13 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `grafana-tempo --version` you can follow the example below:
```console
$ docker run --rm --name grafana-tempo bitnami/grafana-tempo:latest -- --version
docker run --rm --name grafana-tempo bitnami/grafana-tempo:latest -- --version
```
In order for the container to work, you need to mount your custom `tempo.yaml` file in `/bitnami/grafana-tempo/conf/`. The following example runs Grafana Tempo with a custom configuration file:
```console
$ docker run --rm --name grafana-tempo -v /path/to/tempo.yaml:/bitnami/grafana-tempo/conf/tempo.yaml bitnami/grafana-tempo:latest
docker run --rm --name grafana-tempo -v /path/to/tempo.yaml:/bitnami/grafana-tempo/conf/tempo.yaml bitnami/grafana-tempo:latest
```
Using docker-compose:
@ -103,7 +103,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

58
bitnami/grafana/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name grafana bitnami/grafana:latest
docker run --name grafana bitnami/grafana:latest
```
## Why use Bitnami Images?
@ -46,21 +46,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Grafana Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana).
```console
$ docker pull bitnami/grafana:latest
docker pull bitnami/grafana:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/grafana:[TAG]
docker pull bitnami/grafana:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -74,7 +74,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create grafana-network --driver bridge
docker network create grafana-network --driver bridge
```
#### Step 2: Launch the grafana container within your network
@ -82,7 +82,7 @@ $ docker network create grafana-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `grafana-network` network.
```console
$ docker run --name grafana-node1 --network grafana-network bitnami/grafana:latest
docker run --name grafana-node1 --network grafana-network bitnami/grafana:latest
```
#### Step 3: Run another containers
@ -95,7 +95,7 @@ We can launch another containers using the same flag (`--network NETWORK`) in th
Update the `grafana.ini` configuration file in the `/opt/bitnami/grafana/conf` directory to override default configuration options. You only need to add the options you want to override. Config files are applied in the order of:
```
```config
grafana.ini
default.ini
```
@ -107,7 +107,7 @@ To enable development mode, edit the `grafana.ini` file and set `app_mode = deve
Override the `/opt/bitnami/grafana/conf/grafana.ini` file mounting a volume.
```console
$ docker run --name grafana-node -v /path/to/grafana.ini:/opt/bitnami/grafana/conf/grafana.ini bitnami/grafana:latest
docker run --name grafana-node -v /path/to/grafana.ini:/opt/bitnami/grafana/conf/grafana.ini bitnami/grafana:latest
```
After that, your configuration will be taken into account in the server's behaviour.
@ -127,17 +127,17 @@ grafana:
You can customize this image and include the plugins you desire editing the list of plugins avilable in the script (see the variable "grafana_plugin_list") and build your own image as shown below:
```console
$ cd 8/debian-11
$ docker build -t your-custom-grafana .
cd 8/debian-11
docker build -t your-custom-grafana .
```
#### Install plugins at initialization
When you start the Grafana image, you can specify a comma, semi-colon or space separated list of plugins to install by setting the env. variable `GF_INSTALL_PLUGINS`. The entries in `GF_INSTALL_PLUGINS` have three different formats:
* `plugin_id`: This will download the latest plugin version with name `plugin_id` from [the official Grafana plugins page](https://grafana.com/grafana/plugins).
* `plugin_id:plugin_version`: This will download the plugin with name `plugin_id` and version `plugin_version` from [the official Grafana plugins page](https://grafana.com/grafana/plugins).
* `plugin_id=url`: This will download the plugin with name `plugin_id` using the zip file specified in `url`. In case you want to skip TLS verification, set the variable `GF_INSTALL_PLUGINS_SKIP_TLS` to `yes`.
* `plugin_id`: This will download the latest plugin version with name `plugin_id` from [the official Grafana plugins page](https://grafana.com/grafana/plugins).
* `plugin_id:plugin_version`: This will download the plugin with name `plugin_id` and version `plugin_version` from [the official Grafana plugins page](https://grafana.com/grafana/plugins).
* `plugin_id=url`: This will download the plugin with name `plugin_id` using the zip file specified in `url`. In case you want to skip TLS verification, set the variable `GF_INSTALL_PLUGINS_SKIP_TLS` to `yes`.
For Docker Compose, add the variable name and value under the application section:
@ -152,7 +152,7 @@ grafana:
For manual execution add a `-e` option with each variable and value:
```console
$ docker run -d --name grafana -p 3000:3000 \
docker run -d --name grafana -p 3000:3000 \
-e GF_INSTALL_PLUGINS="grafana-clock-panel:1.1.0,grafana-kubernetes-app,worldpring=https://github.com/raintank/worldping-app/releases/download/v1.2.6/worldping-app-release-1.2.6.zip" \
bitnami/grafana:latest
```
@ -190,7 +190,7 @@ services:
The Bitnami Grafana Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs grafana
docker logs grafana
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -204,7 +204,7 @@ Bitnami provides up-to-date versions of grafana, including security patches, soo
#### Step 1: Get the updated image
```console
$ docker pull bitnami/grafana:latest
docker pull bitnami/grafana:latest
```
#### Step 2: Stop and backup the currently running container
@ -212,13 +212,13 @@ $ docker pull bitnami/grafana:latest
Stop the currently running container using the command
```console
$ docker stop grafana
docker stop grafana
```
Next, take a snapshot of the persistent volume `/path/to/grafana-persistence` using:
```console
$ rsync -a /path/to/grafana-persistence /path/to/grafana-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/grafana-persistence /path/to/grafana-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
You can use this snapshot to restore the database state should the upgrade fail.
@ -226,15 +226,15 @@ You can use this snapshot to restore the database state should the upgrade fail.
#### Step 3: Remove the currently running container
```console
$ docker rm -v grafana
docker rm -v grafana
```
#### Step 4: Run the new image
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
Re-create your container from the new image, restoring your backup if necessary.
```console
$ docker run --name grafana bitnami/grafana:latest
docker run --name grafana bitnami/grafana:latest
```
## Notable Changes
@ -243,19 +243,19 @@ $ docker run --name grafana bitnami/grafana:latest
The number of plugins included in the image by default has been decreased. This decision is supported by the following reasons:
- Bitnami commitment to offer images as less opinionated as possible: only very popular and well-maintained plugins should be included.
- Reducing the image size.
- Security concerns: by reducing the number of plugins, we also reduce the chances to include libraries affected by known vulnerabilities.
* Bitnami commitment to offer images as less opinionated as possible: only very popular and well-maintained plugins should be included.
* Reducing the image size.
* Security concerns: by reducing the number of plugins, we also reduce the chances to include libraries affected by known vulnerabilities.
You can still build your custom image adding your custom plugins or install them during the installization as explained in the [Grafana Plugins section](#grafana-plugins).
### 6.7.3-debian-10-r28
- The `GF_INSTALL_PLUGINS` environment variable is not set by default anymore. This means it doesn't try to install the [`grafana-image-renderer` plugin](https://github.com/grafana/grafana-image-renderer) anymore unless you specify it. As an alternative to install this plugin, you can use the [Grafana Image Renderer container](https://github.com/bitnami/containers/blob/main/bitnami/grafana-image-renderer).
* The `GF_INSTALL_PLUGINS` environment variable is not set by default anymore. This means it doesn't try to install the [`grafana-image-renderer` plugin](https://github.com/grafana/grafana-image-renderer) anymore unless you specify it. As an alternative to install this plugin, you can use the [Grafana Image Renderer container](https://github.com/bitnami/containers/blob/main/bitnami/grafana-image-renderer).
### 6.7.2-debian-10-r18
- Grafana doesn't ship the [`grafana-image-renderer` plugin](https://github.com/grafana/grafana-image-renderer/) by default anymore since it's not compatible with K8s distros with IPv6 disable. Instead, the `GF_INSTALL_PLUGINS` environment variable is set by default including this plugin so it's installed during the container's initialization, users can easily avoid it by overwriting the environment variable.
* Grafana doesn't ship the [`grafana-image-renderer` plugin](https://github.com/grafana/grafana-image-renderer/) by default anymore since it's not compatible with K8s distros with IPv6 disable. Instead, the `GF_INSTALL_PLUGINS` environment variable is set by default including this plugin so it's installed during the container's initialization, users can easily avoid it by overwriting the environment variable.
## Contributing
@ -273,7 +273,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/haproxy/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name haproxy bitnami/haproxy:latest
docker run --name haproxy bitnami/haproxy:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami haproxy Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/haproxy).
```console
$ docker pull bitnami/haproxy:latest
docker pull bitnami/haproxy:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/haproxy/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/haproxy:[TAG]
docker pull bitnami/haproxy:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,13 +64,13 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `haproxy --version` you can follow the example below:
```console
$ docker run --rm --name haproxy bitnami/haproxy:latest -- --version
docker run --rm --name haproxy bitnami/haproxy:latest -- --version
```
In order for the container to work, you need to mount your custom `haproxy.cfg` file in `/bitnami/haproxy/conf/`. The following example runs HAProxy with a custom configuration file:
```console
$ docker run --rm --name haproxy -v /path/to/haproxy.cfg:/bitnami/haproxy/conf/haproxy.cfg bitnami/haproxy:latest
docker run --rm --name haproxy -v /path/to/haproxy.cfg:/bitnami/haproxy/conf/haproxy.cfg bitnami/haproxy:latest
```
Using docker-compose:
@ -103,7 +103,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

34
bitnami/harbor-adapter-trivy/README.md
View File

@ -13,9 +13,9 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
This container is part of the [Harbor solution](https://github.com/bitnami/charts/tree/master/bitnami/harbor) that is primarily intended to be deployed in Kubernetes. You can deploy Harbor solution and then enable this specific container with the command below:
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
## Why use Bitnami Images?
@ -46,21 +46,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Harbor-Adapter-Trivy Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/harbor-adapter-trivy).
```console
$ docker pull bitnami/harbor-adapter-trivy:latest
docker pull bitnami/harbor-adapter-trivy:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/harbor-adapter-trivy/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/harbor-adapter-trivy:[TAG]
docker pull bitnami/harbor-adapter-trivy:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -70,7 +70,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/harbor-adapter-trivy-persistence:/bitnami \
bitnami/harbor-adapter-trivy:latest
```
@ -96,7 +96,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create harbor-adapter-trivy-network --driver bridge
docker network create harbor-adapter-trivy-network --driver bridge
```
#### Step 2: Launch the Harbor-Adapter-Trivy container within your network
@ -104,7 +104,7 @@ $ docker network create harbor-adapter-trivy-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `harbor-adapter-trivy-network` network.
```console
$ docker run --name harbor-adapter-trivy-node1 --network harbor-adapter-trivy-network bitnami/harbor-adapter-trivy:latest
docker run --name harbor-adapter-trivy-node1 --network harbor-adapter-trivy-network bitnami/harbor-adapter-trivy:latest
```
#### Step 3: Run another containers
@ -122,7 +122,7 @@ For further information about the specific component itself, please refer to the
The Bitnami Harbor-Adapter-Trivy Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs harbor-adapter-trivy
docker logs harbor-adapter-trivy
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -136,7 +136,7 @@ Bitnami provides up-to-date versions of Harbor-Adapter-Trivy, including security
#### Step 1: Get the updated image
```console
$ docker pull bitnami/harbor-adapter-trivy:latest
docker pull bitnami/harbor-adapter-trivy:latest
```
#### Step 2: Stop the running container
@ -144,13 +144,13 @@ $ docker pull bitnami/harbor-adapter-trivy:latest
Stop the currently running container using the command
```console
$ docker stop harbor-adapter-trivy
docker stop harbor-adapter-trivy
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v harbor-adapter-trivy
docker rm -v harbor-adapter-trivy
```
#### Step 4: Run the new image
@ -158,7 +158,7 @@ $ docker rm -v harbor-adapter-trivy
Re-create your container from the new image.
```console
$ docker run --name harbor-adapter-trivy bitnami/harbor-adapter-trivy:latest
docker run --name harbor-adapter-trivy bitnami/harbor-adapter-trivy:latest
```
## Contributing
@ -177,7 +177,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/harbor-core/README.md
View File

@ -6,14 +6,12 @@
[Overview of Harbor Core](https://goharbor.io/)
## TL;DR
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
> Please note we are downloading the docker-compose.yml file from the Harbor Portal component repository.
@ -66,7 +64,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/harbor-exporter/README.md
View File

@ -6,14 +6,12 @@
[Overview of harbor-exporter](https://change.me)
## TL;DR
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
> Please note we are downloading the docker-compose.yml file from the Harbor Portal component repository.
@ -66,7 +64,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/harbor-jobservice/README.md
View File

@ -6,14 +6,12 @@
[Overview of Harbor Job Service](https://github.com/goharbor/harbor)
## TL;DR
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
> Please note we are downloading the docker-compose.yml file from the Harbor Portal component repository.
@ -66,7 +64,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

9
bitnami/harbor-notary-server/README.md
View File

@ -13,10 +13,11 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
This container is part of the [Harbor solution](https://github.com/bitnami/charts/tree/master/bitnami/harbor) that is primarily intended to be deployed in Kubernetes. You can deploy Harbor solution and then enable this specific container with the command below:
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
## Why use Bitnami Images?
* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
@ -65,7 +66,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

8
bitnami/harbor-notary-signer/README.md
View File

@ -13,9 +13,9 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
This container is part of the [Harbor solution](https://github.com/bitnami/charts/tree/master/bitnami/harbor) that is primarily intended to be deployed in Kubernetes. You can deploy Harbor solution and then enable this specific container with the command below:
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
## Why use Bitnami Images?
@ -66,7 +66,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/harbor-portal/README.md
View File

@ -6,14 +6,12 @@
[Overview of Harbor](https://goharbor.io/)
## TL;DR
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/archive/main.tar.gz | tar xz --strip=1 --wildcards '*-main/bitnami/harbor-portal/config' && mv bitnami/harbor-portal/config . && rm -rf bitnami
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/archive/main.tar.gz | tar xz --strip=1 --wildcards '*-main/bitnami/harbor-portal/config' && mv bitnami/harbor-portal/config . && rm -rf bitnami
docker-compose up
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options for the [PostgreSQL](https://github.com/bitnami/containers/tree/main/bitnami/postgresql#readme) and [Redis(R)](https://github.com/bitnami/containers/blob/main/bitnami/redis#readme) containers for a more secure deployment.
@ -66,7 +64,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/harbor-registry/README.md
View File

@ -6,14 +6,12 @@
[Overview of Harbor Registry](https://github.com/goharbor/harbor)
## TL;DR
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
> Please note we are downloading the docker-compose.yml file from the Harbor Portal component repository.
@ -66,7 +64,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

10
bitnami/harbor-registryctl/README.md
View File

@ -6,14 +6,12 @@
[Overview of Harbor Registryctl](https://github.com/goharbor/harbor)
## TL;DR
```console
$ curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
$ curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
$ docker-compose up
curl -LO https://raw.githubusercontent.com/bitnami/containers/main/bitnami/harbor-portal/docker-compose.yml
curl -L https://github.com/bitnami/containers/blob/main/bitnami/harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
docker-compose up
```
> Please note we are downloading the docker-compose.yml file from the Harbor Portal component repository.
@ -66,7 +64,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

73
bitnami/influxdb/README.md
View File

@ -11,14 +11,14 @@ InfluxDB(TM) is a trademark owned by InfluxData, which is not affiliated with, a
## TL;DR
```console
$ docker run --name influxdb bitnami/influxdb:latest
docker run --name influxdb bitnami/influxdb:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/influxdb/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/influxdb/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami InfluxDB (TM) Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/influxdb).
```console
$ docker pull bitnami/influxdb:latest
docker pull bitnami/influxdb:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/influxdb/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/influxdb:[TAG]
docker pull bitnami/influxdb:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your application
@ -73,7 +73,7 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami/influxdb` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
--volume /path/to/influxdb-persistence:/bitnami/influxdb \
--env INFLUXDB_HTTP_AUTH_ENABLED=false \
bitnami/influxdb:latest
@ -102,7 +102,7 @@ In this example, we will create a InfluxDB (TM) client instance that will connec
#### Step 1: Create a network
```console
$ docker network create my-network --driver bridge
docker network create my-network --driver bridge
```
#### Step 2: Launch the InfluxDB (TM) container within your network
@ -110,7 +110,7 @@ $ docker network create my-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `my-network` network.
```console
$ docker run -d --name influxdb-server \
docker run -d --name influxdb-server \
--network my-network \
--env INFLUXDB_HTTP_AUTH_ENABLED=false \
bitnami/influxdb:latest
@ -121,7 +121,7 @@ $ docker run -d --name influxdb-server \
Finally we create a new container instance to launch the InfluxDB (TM) client and connect to the server created in the previous step:
```console
$ docker run -it --rm \
docker run -it --rm \
--network my-network \
bitnami/influxdb:latest influx -host influxdb-server
```
@ -158,7 +158,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -174,7 +174,7 @@ Variables must be prefixed by `INFLUXD_`, find more [here](https://docs.influxda
The configuration can easily be setup by mounting your own configuration file (`influxdb.conf`) on the directory `/opt/bitnami/influxdb/etc/`:
```console
$ docker run --name influxdb \
docker run --name influxdb \
--volume /path/to/influxdb.conf:/opt/bitnami/influxdb/etc/influxdb.conf:ro \
bitnami/influxdb:latest
```
@ -201,13 +201,13 @@ In order to have your custom files inside the docker image you can mount them as
The admin user and password can easily be setup with the Bitnami InfluxDB (TM) Docker image using the following environment variables:
- `INFLUXDB_ADMIN_USER`: The database admin user. Defaults to `admin`.
- `INFLUXDB_ADMIN_USER_PASSWORD`: The database admin user password. No defaults.
* `INFLUXDB_ADMIN_USER`: The database admin user. Defaults to `admin`.
* `INFLUXDB_ADMIN_USER_PASSWORD`: The database admin user password. No defaults.
Passing the `INFLUXDB_ADMIN_USER_PASSWORD` environment variable when running the image for the first time will set the password of the `INFLUXDB_ADMIN_USER` user to the value of `INFLUXDB_ADMIN_USER_PASSWORD`.
```console
$ docker run --name influxdb -e INFLUXDB_ADMIN_USER_PASSWORD=password123 bitnami/influxdb:latest
docker run --name influxdb -e INFLUXDB_ADMIN_USER_PASSWORD=password123 bitnami/influxdb:latest
```
or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/influxdb/docker-compose.yml) file present in this repository:
@ -228,7 +228,7 @@ services:
By default the InfluxDB (TM) image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the `INFLUXDB_HTTP_AUTH_ENABLED=false` env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the `INFLUXDB_ADMIN_USER_PASSWORD` for any other scenario. If you are using InfluxDB (TM) v2, authentication is required and `INFLUXDB_HTTP_AUTH_ENABLED` will be ignored.
```console
$ docker run --name influxdb --env INFLUXDB_HTTP_AUTH_ENABLED=false bitnami/influxdb:latest
docker run --name influxdb --env INFLUXDB_HTTP_AUTH_ENABLED=false bitnami/influxdb:latest
```
or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/influxdb/docker-compose.yml) file present in this repository:
@ -244,11 +244,10 @@ services:
### Creating a database on first run
For InfluxDB (TM) v2 you can pass `INFLUXDB_USER_BUCKET` environment variable when running the image for the first time, a new bucket will be created. This is useful if your application requires that a bucket already exists, saving you from having to manually create the bucket using the InfluxDB (TM) CLI.
```console
$ docker run --name influxdb \
docker run --name influxdb \
-e INFLUXDB_ADMIN_USER_PASSWORD=password123 \
-e INFLUXDB_USER_BUCKET=my_bucket \
bitnami/influxdb:latest
@ -259,7 +258,7 @@ $ docker run --name influxdb \
You can create a restricted database user that only has permissions for the database created with the [`INFLUXDB_DB`](#creating-a-database-on-first-run) environment variable. To do this, provide the `INFLUXDB_USER` environment variable and to set a password for the database user provide the `INFLUXDB_USER_PASSWORD` variable.
```console
$ docker run --name influxdb \
docker run --name influxdb \
-e INFLUXDB_ADMIN_USER_PASSWORD=password123 \
-e INFLUXDB_USER=my_user \
-e INFLUXDB_USER_PASSWORD=my_password \
@ -283,17 +282,17 @@ services:
You can also create users with restricted privileges in the database in a very similar way. To do so, user the environment variables below:
- `INFLUXDB_READ_USER`: Specify the user with "read" privileges in the database.
- `INFLUXDB_READ_USER_PASSWORD`: Specify the password of the `INFLUXDB_READ_USER` user.
- `INFLUXDB_WRITE_USER`: Specify the user with "write" privileges in the database.
- `INFLUXDB_WRITE_USER_PASSWORD`: Specify the password of the `INFLUXDB_WRITE_USER` user.
* `INFLUXDB_READ_USER`: Specify the user with "read" privileges in the database.
* `INFLUXDB_READ_USER_PASSWORD`: Specify the password of the `INFLUXDB_READ_USER` user.
* `INFLUXDB_WRITE_USER`: Specify the user with "write" privileges in the database.
* `INFLUXDB_WRITE_USER_PASSWORD`: Specify the password of the `INFLUXDB_WRITE_USER` user.
### Customize the HTTP port readiness
You can modify the timeout for the HTTP port readiness probe where the container waits until the HTTP port is actually ready to receive queries before finish the setup. Use `INFLUXDB_HTTP_READINESS_TIMEOUT` to do this.
```console
$ docker run --name influxdb \
docker run --name influxdb \
-e INFLUXDB_ADMIN_USER_PASSWORD=password123 \
-e INFLUXDB_USER=my_user \
-e INFLUXDB_USER_PASSWORD=my_password \
@ -317,14 +316,14 @@ services:
...
```
- `INFLUXDB_HTTP_READINESS_TIMEOUT`: Spacify the time to wait until the HTTP endpoint is ready in seconds. Default: 60
* `INFLUXDB_HTTP_READINESS_TIMEOUT`: Spacify the time to wait until the HTTP endpoint is ready in seconds. Default: 60
## Logging
The Bitnami InfluxDB (TM) Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs influxdb
docker logs influxdb
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -338,7 +337,7 @@ Bitnami provides up-to-date versions of InfluxDB (TM), including security patche
#### Step 1: Get the updated image
```console
$ docker pull bitnami/influxdb:latest
docker pull bitnami/influxdb:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/influxdb:latest`.
@ -348,31 +347,31 @@ or if you're using Docker Compose, update the value of the image property to `bi
Stop the currently running container using the command
```console
$ docker stop influxdb
docker stop influxdb
```
or using Docker Compose:
```console
$ docker-compose stop influxdb
docker-compose stop influxdb
```
Next, take a snapshot of the persistent volume `/path/to/influxdb-persistence` using:
```console
$ rsync -a /path/to/influxdb-persistence /path/to/influxdb-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
rsync -a /path/to/influxdb-persistence /path/to/influxdb-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v influxdb
docker rm -v influxdb
```
or using Docker Compose:
```console
$ docker-compose rm -v influxdb
docker-compose rm -v influxdb
```
#### Step 4: Run the new image
@ -380,13 +379,13 @@ $ docker-compose rm -v influxdb
Re-create your container from the new image.
```console
$ docker run --name influxdb bitnami/influxdb:latest
docker run --name influxdb bitnami/influxdb:latest
```
or using Docker Compose:
```console
$ docker-compose up influxdb
docker-compose up influxdb
```
## Contributing
@ -405,7 +404,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

18
bitnami/jaeger/README.md
View File

@ -6,12 +6,10 @@
[Overview of jaeger](https://www.jaegertracing.io/)
## TL;DR
```console
$ docker run --name v bitnami/jaeger:latest
docker run --name v bitnami/jaeger:latest
```
## Why use Bitnami Images?
@ -36,21 +34,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Jaeger Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jaeger).
```console
$ docker pull bitnami/jaeger:latest
docker pull bitnami/jaeger:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jaeger/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jaeger:[TAG]
docker pull bitnami/jaeger:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,7 +62,7 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `jaeger-all-in-one --help` you can follow the example below:
```console
$ docker run --rm --name jaeger bitnami/jaeger:latest --help
docker run --rm --name jaeger bitnami/jaeger:latest --help
```
Check the [official jaeger documentation](https://www.jaegertracing.io//docs) for more information.
@ -85,7 +83,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

81
bitnami/jasperreports/README.md
View File

@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jasperreports/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jasperreports/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@ -26,7 +26,7 @@ $ docker-compose up -d
- 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.
# How to deploy JasperReports Server in Kubernetes?
## How to deploy JasperReports Server in Kubernetes?
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami JasperReports Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/jasperreports).
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami JasperReports Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jasperreports).
```console
$ docker pull bitnami/jasperreports:latest
docker pull bitnami/jasperreports:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jasperreports/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jasperreports:[TAG]
docker pull bitnami/jasperreports:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## How to use this image
@ -75,8 +75,8 @@ JasperReports requires access to a MySQL or MariaDB database to store informatio
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jasperreports/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jasperreports/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jasperreports/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Provide jasper specific file config
@ -110,14 +110,14 @@ If you want to run the application manually instead of using `docker-compose`, t
#### Step 1: Create a network
```console
$ docker network create jasperreports-network
docker network create jasperreports-network
```
#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
```console
$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
docker volume create --name mariadb_data
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_jasperreports \
--env MARIADB_PASSWORD=bitnami \
@ -130,8 +130,8 @@ $ docker run -d --name mariadb \
#### Step 3: Create volumes for JasperReports persistence and launch the container
```console
$ docker volume create --name jasperreports_data
$ docker run -d --name jasperreports \
docker volume create --name jasperreports_data
docker run -d --name jasperreports \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
@ -185,13 +185,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
#### Step 1: Create a network (if it does not exist)
```console
$ docker network create jasperreports-network
docker network create jasperreports-network
```
#### Step 2. Create a MariaDB container with host volume
```console
$ docker run -d --name mariadb \
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_jasperreports \
--env MARIADB_PASSWORD=bitnami \
@ -204,7 +204,7 @@ $ docker run -d --name mariadb \
#### Step 3. Create the JasperReports container with host volumes
```console
$ docker run -d --name jasperreports \
docker run -d --name jasperreports \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
@ -234,7 +234,7 @@ When you start the JasperReports image, you can adjust the configuration of the
- For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
--env JASPERREPORTS_PASSWORD=my_password \
--network jasperreports-tier \
--volume /path/to/jasperreports-persistence:/bitnami \
@ -243,14 +243,14 @@ When you start the JasperReports image, you can adjust the configuration of the
Available environment variables:
##### User and Site configuration
#### User and Site configuration
- `JASPERREPORTS_USERNAME`: JasperReports application username. Default: **jasperadmin**
- `JASPERREPORTS_PASSWORD`: JasperReports application password. Default: **bitnami**
- `JASPERREPORTS_EMAIL`: JasperReports application email. Default: **user@example.com**
- `JASPERREPORTS_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. This is necessary in case you use a database that already has JasperReports data. Default: **no**
##### Database connection configuration
#### Database connection configuration
- `JASPERREPORTS_DATABASE_TYPE`: Database type to be used for the JasperReports installation. Allowed values: `mariadb`, `mysql`, `postgresql`. Default: **mariadb**
- `JASPERREPORTS_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mariadb**
@ -260,7 +260,7 @@ Available environment variables:
- `JASPERREPORTS_DATABASE_PASSWORD`: Database password that JasperReports will use to connect with the database. No default.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### Create a database for JasperReports using mysql-client
#### Create a database for JasperReports using mysql-client
- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mariadb**
- `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by the MariaDB or MySQL server. Default: **3306**
@ -275,7 +275,7 @@ Available environment variables:
- `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No default.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### SMTP Configuration
#### SMTP Configuration
To configure JasperReports to send email using SMTP you can set the following environment variables:
@ -286,9 +286,10 @@ To configure JasperReports to send email using SMTP you can set the following en
- `JASPERREPORTS_SMTP_PROTOCOL`: If specified, SMTP protocol to use. Allowed values: *smtp*, *smtps*. Default: **smtp**.
- `JASPERREPORTS_SMTP_EMAIL`: Custom email address for the 'From:' field. If not specified, the `JASPERREPORTS_SMTP_USER` value is used.
##### JasperReports base URL configuration
#### JasperReports base URL configuration
- `JASPERREPORTS_USE_ROOT_URL`: JasperReports application default URL. Default: **false** at <http://example.com/jasperserver>. <http://example.com/> if **true**.
- `JASPERREPORTS_USE_ROOT_URL`: JasperReports application default URL. Default: **false** at http://example.com/jasperserver. http://example.com/ if **true**.
#### Examples
##### SMTP configuration using a Gmail account
@ -315,7 +316,7 @@ This would be an example of SMTP configuration using a Gmail account:
- For manual execution:
```console
$ docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
--env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
--env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
--env JASPERREPORTS_SMTP_HOST=smtp.gmail.com \
@ -351,7 +352,7 @@ The Bitnami JasperReports container supports connecting the JasperReports applic
- For manual execution:
```console
$ docker run -d --name jasperreports\
docker run -d --name jasperreports\
-p 8080:8080 -p 8443:8443 \
--network jasperreports-network \
--env JASPERREPORTS_DATABASE_HOST=mariadb_host \
@ -370,13 +371,13 @@ In case the database already contains data from a previous JasperReports install
The Bitnami JasperReports Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs jasperreports
docker logs jasperreports
```
Or using Docker Compose:
```console
$ docker-compose logs jasperreports
docker-compose logs jasperreports
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -390,13 +391,13 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
```console
$ docker stop jasperreports
docker stop jasperreports
```
Or using Docker Compose:
```console
$ docker-compose stop jasperreports
docker-compose stop jasperreports
```
#### Step 2: Run the backup command
@ -404,7 +405,7 @@ $ docker-compose stop jasperreports
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/jasperreports-backups:/backups --volumes-from jasperreports bitnami/minideb \
docker run --rm -v /path/to/jasperreports-backups:/backups --volumes-from jasperreports bitnami/minideb \
cp -a /bitnami/jasperreports /backups/latest
```
@ -415,7 +416,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the MariaDB database container:
```diff
$ docker run -d --name mariadb \
docker run -d --name mariadb \
...
- --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
@ -425,7 +426,7 @@ For the MariaDB database container:
For the JasperReports container:
```diff
$ docker run -d --name jasperreports \
docker run -d --name jasperreports \
...
- --volume /path/to/jasperreports-persistence:/bitnami/jasperreports \
+ --volume /path/to/jasperreports-backups/latest:/bitnami/jasperreports \
@ -434,14 +435,14 @@ For the JasperReports container:
### Upgrade this image
Bitnami provides up-to-date versions of MariaDB and JasperReports, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the JasperReports container. For the MariaDB upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image
Bitnami provides up-to-date versions of MariaDB and JasperReports, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the JasperReports container. For the MariaDB upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image>
The `bitnami/jasperreports:latest` tag always points to the most recent release. To get the most recent release you can simple repull the `latest` tag from the Docker Hub with `docker pull bitnami/jasperreports:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/jasperreports/tags/).
#### Step 1: Get the updated image
```console
$ docker pull bitnami/jasperreports:latest
docker pull bitnami/jasperreports:latest
```
#### Step 2: Stop the running container
@ -449,7 +450,7 @@ $ docker pull bitnami/jasperreports:latest
Stop the currently running container using the command
```console
$ docker-compose stop jasperreports
docker-compose stop jasperreports
```
#### Step 3: Take a snapshot of the application state
@ -469,7 +470,7 @@ docker-compose rm -v jasperreports
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
## Contributing
@ -488,7 +489,7 @@ The Bitnami team will review any PR that is created, feel free to create a PR if
New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.
# Notable Changes
## Notable Changes
## 7.8.0-debian-10-r275
@ -508,7 +509,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

40
bitnami/java/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name java bitnami/java
docker run -it --name java bitnami/java
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/java/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/java/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -55,21 +55,21 @@ The formatting convention for `prod` tags has been changed:
The recommended way to get the Bitnami Java Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/java).
```console
$ docker pull bitnami/java:latest
docker pull bitnami/java:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/java/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/java:[TAG]
docker pull bitnami/java:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -79,7 +79,7 @@ $ docker build -t bitnami/APP:latest .
The default work directory for the Java image is `/app`. You can mount a folder from your host here that includes your Java jar or war, and run it normally using the `java` command.
```console
$ docker run -it --name java -v /path/to/app:/app bitnami/java:latest \
docker run -it --name java -v /path/to/app:/app bitnami/java:latest \
java -jar package.jar
```
@ -95,22 +95,22 @@ java:
**Further Reading:**
- [Java SE Documentation](https://docs.oracle.com/javase/8/docs/api/)
* [Java SE Documentation](https://docs.oracle.com/javase/8/docs/api/)
## Replace the default truststore using a custom base image
In case you are replacing the default [minideb](https://github.com/bitnami/minideb) base image with a custom base image (based on Debian), it is possible to replace the default truststore located in the `/opt/bitnami/java/lib/security` folder. This is done by setting the `JAVA_EXTRA_SECURITY_DIR` docker build ARG variable, which needs to point to a location that contains a *cacerts* file that would substitute the originally bundled truststore. In the following example we will use a minideb fork that contains a custom *cacerts* file in the */bitnami/java/extra-security* folder:
- In the Dockerfile, replace `FROM docker.io/bitnami/minideb:latest` to use a custom image, defined with the `MYJAVAFORK:TAG` placeholder:
* In the Dockerfile, replace `FROM docker.io/bitnami/minideb:latest` to use a custom image, defined with the `MYJAVAFORK:TAG` placeholder:
```diff
- FROM bitnami/minideb:latest
+ FROM MYFORK:TAG
```
- Run `docker build` setting the value of `JAVA_EXTRA_SECURITY_DIR`. Remember to replace the `MYJAVAFORK:TAG` placeholder.
* Run `docker build` setting the value of `JAVA_EXTRA_SECURITY_DIR`. Remember to replace the `MYJAVAFORK:TAG` placeholder.
```
```console
docker build --build-arg JAVA_EXTRA_SECURITY_DIR=/bitnami/java/extra-security -t MYJAVAFORK:TAG .
```
@ -123,7 +123,7 @@ Bitnami provides up-to-date versions of Java, including security patches, soon a
#### Step 1: Get the updated image
```console
$ docker pull bitnami/java:latest
docker pull bitnami/java:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/java:latest`.
@ -131,13 +131,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v java
docker rm -v java
```
or using Docker Compose:
```console
$ docker-compose rm -v java
docker-compose rm -v java
```
#### Step 3: Run the new image
@ -145,20 +145,20 @@ $ docker-compose rm -v java
Re-create your container from the new image.
```console
$ docker run --name java bitnami/java:latest
docker run --name java bitnami/java:latest
```
or using Docker Compose:
```console
$ docker-compose up java
docker-compose up java
```
## Notable Changes
### 1.8.252-debian-10-r0, 11.0.7-debian-10-r7, and 15.0.1-debian-10-r20
- Java distribution has been migrated from AdoptOpenJDK to OpenJDK Liberica. As part of VMware, we have an agreement with Bell Software to distribute the Liberica distribution of OpenJDK. That way, we can provide support & the latest versions and security releases for Java.
* Java distribution has been migrated from AdoptOpenJDK to OpenJDK Liberica. As part of VMware, we have an agreement with Bell Software to distribute the Liberica distribution of OpenJDK. That way, we can provide support & the latest versions and security releases for Java.
## Contributing
@ -176,7 +176,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

162
bitnami/jenkins/README.md
View File

@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jenkins/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jenkins/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
@ -49,21 +49,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Jenkins Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jenkins).
```console
$ docker pull bitnami/jenkins:latest
docker pull bitnami/jenkins:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jenkins/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jenkins:[TAG]
docker pull bitnami/jenkins:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## How to use this image
@ -73,8 +73,8 @@ $ docker build -t bitnami/APP:latest .
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jenkins/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jenkins/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jenkins/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@ -84,14 +84,14 @@ If you want to run the application manually instead of using `docker-compose`, t
#### Step 1: Create a network
```console
$ docker network create jenkins-network
docker network create jenkins-network
```
#### Step 2: Create volumes for Jenkins persistence and launch the container
```console
$ docker volume create --name jenkins_data
$ docker run -d -p 80:8080 --name jenkins \
docker volume create --name jenkins_data
docker run -d -p 80:8080 --name jenkins \
--network jenkins-network \
--volume jenkins_data:/bitnami/jenkins \
bitnami/jenkins:latest
@ -131,13 +131,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
#### Step 1: Create a network (if it does not exist)
```console
$ docker network create jenkins-network
docker network create jenkins-network
```
#### Step 2. Create the Jenkins container with host volumes
```console
$ docker run -d -p 80:8080 --name jenkins \
docker run -d -p 80:8080 --name jenkins \
--network jenkins-network \
--volume /path/to/jenkins-persistence:/bitnami/jenkins \
bitnami/jenkins:latest
@ -149,7 +149,7 @@ $ docker run -d -p 80:8080 --name jenkins \
When you start the Jenkins image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
- For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jenkins/docker-compose.yml) file present in this repository:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jenkins/docker-compose.yml) file present in this repository:
```yaml
jenkins:
@ -159,10 +159,10 @@ When you start the Jenkins image, you can adjust the configuration of the instan
...
```
- For manual execution add a `--env` option with each variable and value:
* For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d -p 80:8080 --name jenkins \
docker run -d -p 80:8080 --name jenkins \
--env JENKINS_PASSWORD=my_password \
--network jenkins-network \
--volume /path/to/jenkins-persistence:/bitnami/jenkins \
@ -171,36 +171,36 @@ When you start the Jenkins image, you can adjust the configuration of the instan
Available environment variables:
##### User and Site configuration
#### User and Site configuration
- `JENKINS_USERNAME`: Jenkins admin username. Default: **user**
- `JENKINS_PASSWORD`: Jenkins admin password. Default: **bitnami**
- `JENKINS_EMAIL`: Jenkins admin email. Default: **user@example.com**
- `JENKINS_HOME`: Jenkins home directory. Default: **/bitnami/jenkins/home**
- `JENKINS_HTTP_PORT_NUMBER`: Port used by Jenkins for HTTP. Default: **8080**
- `JENKINS_HTTPS_PORT_NUMBER`: Port used by Jenkins for HTTPS. Default: **8443**
- `JENKINS_EXTERNAL_HTTP_PORT_NUMBER`: Port to used by Jenkins to generate URLs and links when accessing using HTTP. Default: **80**
- `JENKINS_EXTERNAL_HTTPS_PORT_NUMBER`: Port to used by Jenkins to generate URLs and links when accessing using HTTPS. Default: **443**
- `JENKINS_JNLP_PORT_NUMBER`: Port used by Jenkins for JNLP. Default: **50000**
- `JENKINS_FORCE_HTTPS`: Enable serving Jenkins only through HTTPS. Default: **no**
- `JENKINS_SKIP_BOOTSTRAP`: Skip performing the initial bootstrapping. Default: **no**
* `JENKINS_USERNAME`: Jenkins admin username. Default: **user**
* `JENKINS_PASSWORD`: Jenkins admin password. Default: **bitnami**
* `JENKINS_EMAIL`: Jenkins admin email. Default: **user@example.com**
* `JENKINS_HOME`: Jenkins home directory. Default: **/bitnami/jenkins/home**
* `JENKINS_HTTP_PORT_NUMBER`: Port used by Jenkins for HTTP. Default: **8080**
* `JENKINS_HTTPS_PORT_NUMBER`: Port used by Jenkins for HTTPS. Default: **8443**
* `JENKINS_EXTERNAL_HTTP_PORT_NUMBER`: Port to used by Jenkins to generate URLs and links when accessing using HTTP. Default: **80**
* `JENKINS_EXTERNAL_HTTPS_PORT_NUMBER`: Port to used by Jenkins to generate URLs and links when accessing using HTTPS. Default: **443**
* `JENKINS_JNLP_PORT_NUMBER`: Port used by Jenkins for JNLP. Default: **50000**
* `JENKINS_FORCE_HTTPS`: Enable serving Jenkins only through HTTPS. Default: **no**
* `JENKINS_SKIP_BOOTSTRAP`: Skip performing the initial bootstrapping. Default: **no**
##### JAVA configuration
#### JAVA configuration
- `JAVA_OPTS`: Customize JVM parameters. No defaults.
* `JAVA_OPTS`: Customize JVM parameters. No defaults.
## Logging
The Bitnami Jenkins Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs jenkins
docker logs jenkins
```
Or using Docker Compose:
```console
$ docker-compose logs jenkins
docker-compose logs jenkins
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -213,15 +213,15 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
- For docker-compose: `$ docker-compose stop jenkins`
- For manual execution: `$ docker stop jenkins`
* For docker-compose: `docker-compose stop jenkins`
* For manual execution: `docker stop jenkins`
#### Step 2: Run the backup command
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/jenkins-backups:/backups --volumes-from jenkins bitnami/bitnami-shell \
docker run --rm -v /path/to/jenkins-backups:/backups --volumes-from jenkins bitnami/bitnami-shell \
cp -a /bitnami/jenkins /backups/latest
```
@ -230,7 +230,7 @@ $ docker run --rm -v /path/to/jenkins-backups:/backups --volumes-from jenkins bi
Restoring a backup is as simple as mounting the backup as volumes in the containers.
```diff
$ docker run -d --name jenkins \
docker run -d --name jenkins \
...
- --volume /path/to/jenkins-persistence:/bitnami/jenkins \
+ --volume /path/to/jenkins-backups/latest:/bitnami/jenkins \
@ -241,16 +241,16 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
Bitnami provides up-to-date versions of Jenkins, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Jenkins container.
### Step 1. Get the updated images:
### Step 1. Get the updated images
```console
$ docker pull bitnami/jenkins:latest
docker pull bitnami/jenkins:latest
```
### Step 2. Stop your container
- For docker-compose: `$ docker-compose stop jenkins`
- For manual execution: `$ docker stop jenkins`
* For docker-compose: `docker-compose stop jenkins`
* For manual execution: `docker stop jenkins`
### Step 3. Take a snapshot of the application state
@ -258,13 +258,13 @@ Follow the steps in [Backing up your container](#backing-up-your-container) to t
### Step 4. Remove the stopped container
- For docker-compose: `$ docker-compose rm -v jenkins`
- For manual execution: `$ docker rm -v jenkins`
* For docker-compose: `docker-compose rm -v jenkins`
* For manual execution: `docker rm -v jenkins`
### Step 5. Run the new image
- For docker-compose: `$ docker-compose up jenkins`
- For manual execution ([mount](#mount-persistent-folders-manually) the directories if needed): `docker run --name jenkins bitnami/jenkins:latest`
* For docker-compose: `docker-compose up jenkins`
* For manual execution mount the directories if needed): `docker run --name jenkins bitnami/jenkins:latest`
## Customize this image
@ -282,7 +282,7 @@ FROM bitnami/jenkins
Here is an example of extending the image with the following modifications:
- Install the `vim` editor
* Install the `vim` editor
```Dockerfile
FROM bitnami/jenkins
@ -299,22 +299,22 @@ USER 1001
To download and install a set of plugins and their dependencies, use the [Plugin Installation Manager tool](https://github.com/jenkinsci/plugin-installation-manager-tool). You can find information about how to use this tool in the guide below:
- [Getting Started with Plugin Installation Manager tool](https://github.com/jenkinsci/plugin-installation-manager-tool#getting-started)
* [Getting Started with Plugin Installation Manager tool](https://github.com/jenkinsci/plugin-installation-manager-tool#getting-started)
Alternatively, it is possible to install plugins using the following env variables:
- `JENKINS_PLUGINS`: Comma-separated list of Jenkins plugins to be installed during the first boot.
- `JENKINS_PLUGINS_LATEST`: If set to false, install the minimum required version of the plugins in `JENKINS_PLUGINS`. Default: **true**
- `JENKINS_PLUGINS_LATEST_SPECIFIED`: If set to true, install the latest dependencies of any plugin that is requested to have the latest version. Default: **false**
- `JENKINS_OVERRIDE_PLUGINS`: If set to true, existing plugins in the persisted volume will be removed and will force plugins to be reinstalled. Default: **false**
- `JENKINS_SKIP_IMAGE_PLUGINS`: If set to true, skip the installation of image built-in plugins. Default: **false**
* `JENKINS_PLUGINS`: Comma-separated list of Jenkins plugins to be installed during the first boot.
* `JENKINS_PLUGINS_LATEST`: If set to false, install the minimum required version of the plugins in `JENKINS_PLUGINS`. Default: **true**
* `JENKINS_PLUGINS_LATEST_SPECIFIED`: If set to true, install the latest dependencies of any plugin that is requested to have the latest version. Default: **false**
* `JENKINS_OVERRIDE_PLUGINS`: If set to true, existing plugins in the persisted volume will be removed and will force plugins to be reinstalled. Default: **false**
* `JENKINS_SKIP_IMAGE_PLUGINS`: If set to true, skip the installation of image built-in plugins. Default: **false**
### Passing JVM parameters
You might need to customize the JVM running Jenkins, typically to pass system properties or to tweak heap memory settings. Use the `JAVA_OPTS` environment variable for this purpose:
```console
$ docker run -d --name jenkins -p 80:8080 \
docker run -d --name jenkins -p 80:8080 \
--env JAVA_OPTS=-Dhudson.footerURL=http://mycompany.com \
bitnami/jenkins:latest
```
@ -323,14 +323,14 @@ $ docker run -d --name jenkins -p 80:8080 \
By default, when running this image, Bitnami implement some logic in order to configure it for working out of the box. This initialization consists of creating the user and password, preparing data to persist, configuring permissions, creating the `JENKINS_HOME`, etc. You can skip it in two ways:
- Setting the `JENKINS_SKIP_BOOTSTRAP` environment variable to `yes`.
- Attaching a volume with a custom `JENKINS_HOME` that contains a functional Jenkins installation.
* Setting the `JENKINS_SKIP_BOOTSTRAP` environment variable to `yes`.
* Attaching a volume with a custom `JENKINS_HOME` that contains a functional Jenkins installation.
### Adding files/directories to the image
You can include files to the image automatically. All files/directories located in `/usr/share/jenkins/ref` are copied to `/bitnami/jenkins/home` (default Jenkins home directory).
#### Examples:
#### Examples
##### Run groovy scripts at Jenkins start up
@ -339,16 +339,16 @@ You can create custom groovy scripts and make Jenkins run them at start up.
However, using this feature will disable the default configuration done by the Bitnami scripts. This is intended to customize the Jenkins configuration by code.
```console
$ mkdir jenkins-init.groovy.d
$ echo "println '--> hello world'" > jenkins-init.groovy.d/AA_hello.groovy
$ echo "println '--> bye world'" > jenkins-init.groovy.d/BA_bye.groovy
mkdir jenkins-init.groovy.d
echo "println '--> hello world'" > jenkins-init.groovy.d/AA_hello.groovy
echo "println '--> bye world'" > jenkins-init.groovy.d/BA_bye.groovy
$ docker run -d -p 80:8080 --name jenkins \
docker run -d -p 80:8080 --name jenkins \
--env "JENKINS_SKIP_BOOTSTRAP=yes" \
--volume "$(pwd)/jenkins-init.groovy.d:/usr/share/jenkins/ref/init.groovy.d" \
bitnami/jenkins:latest
$ docker logs jenkins | grep world
docker logs jenkins | grep world
--> hello world!
--> bye world!
```
@ -358,7 +358,7 @@ $ docker logs jenkins | grep world
You can use your our own `config.xml` file. However, using this feature will disable the default configuration generated by the Bitnami scripts. This is intended to customize the Jenkins configuration by code.
```console
$ docker run -d -p 80:8080 --name jenkins \
docker run -d -p 80:8080 --name jenkins \
--env "JENKINS_SKIP_BOOTSTRAP=yes" \
--volume "$(pwd)/config.xml:/usr/share/jenkins/ref/config.xml" \
bitnami/jenkins:latest
@ -370,45 +370,45 @@ $ docker run -d -p 80:8080 --name jenkins \
### 2.346.3-debian-11-r3
- The preinstalled plugins were removed.
* The preinstalled plugins were removed.
### 2.332.2-debian-10-r21
- HTTPS and HTTP support are enabled by default.
- `JENKINS_ENABLE_HTTPS` has been renamed to `JENKINS_FORCE_HTTPS`.
* HTTPS and HTTP support are enabled by default.
* `JENKINS_ENABLE_HTTPS` has been renamed to `JENKINS_FORCE_HTTPS`.
### 2.277.4-debian-10-r19
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
- Only the Jenkins Home directory is persisted.
- The `install-plugins.sh` script has been deprecated. Instead use the Plugin Installation Manager Tool as explained in the [Installing Plugins](#installing-plugins) section.
- The `DISABLE_JENKINS_INITIALIZATION` environment variable was renamed to `JENKINS_SKIP_BOOTSTRAP`.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* Only the Jenkins Home directory is persisted.
* The `install-plugins.sh` script has been deprecated. Instead use the Plugin Installation Manager Tool as explained in the [Installing Plugins](#installing-plugins) section.
* The `DISABLE_JENKINS_INITIALIZATION` environment variable was renamed to `JENKINS_SKIP_BOOTSTRAP`.
### 2.263.3-debian-10-rXX
- The deprecated plugins below are not included in the image by default anymore:
- [GitHub Organization Folder](https://plugins.jenkins.io/github-organization-folder).
- [Pipeline: Declarative Agent API](https://plugins.jenkins.io/pipeline-model-declarative-agent).
* The deprecated plugins below are not included in the image by default anymore:
* [GitHub Organization Folder](https://plugins.jenkins.io/github-organization-folder).
* [Pipeline: Declarative Agent API](https://plugins.jenkins.io/pipeline-model-declarative-agent).
### 2.222.1-debian-10-r17
- Java distribution has been migrated from AdoptOpenJDK to OpenJDK Liberica. As part of VMware, we have an agreement with Bell Software to distribute the Liberica distribution of OpenJDK. That way, we can provide support & the latest versions and security releases for Java.
* Java distribution has been migrated from AdoptOpenJDK to OpenJDK Liberica. As part of VMware, we have an agreement with Bell Software to distribute the Liberica distribution of OpenJDK. That way, we can provide support & the latest versions and security releases for Java.
### 2.204.4-debian-10-r3
- The Jenkins container has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Jenkins service was started as the `jenkins` user. From now on, both the container and the Jenkins service run as user `jenkins` (`uid=1001`). You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
- Consequences:
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating your Jenkins data ensuring the `jenkins` user has the appropriate permissions.
- No "privileged" actions are allowed anymore.
* The Jenkins container has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Jenkins service was started as the `jenkins` user. From now on, both the container and the Jenkins service run as user `jenkins` (`uid=1001`). You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
* Consequences:
* Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating your Jenkins data ensuring the `jenkins` user has the appropriate permissions.
* No "privileged" actions are allowed anymore.
### 2.121.2-ol-7-r14 / 2.121.2-debian-9-r18
- Use Jetty instead of Tomcat as web server.
* Use Jetty instead of Tomcat as web server.
### 2.107.1-r0
- The Jenkins container has been migrated to the LTS version. From now on, this repository will only track long term support releases from [Jenkins](https://jenkins.io/changelog-stable/).
* The Jenkins container has been migrated to the LTS version. From now on, this repository will only track long term support releases from [Jenkins](https://jenkins.io/changelog-stable/).
## Contributing
@ -426,7 +426,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

28
bitnami/jmx-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name jmx-exporter bitnami/jmx-exporter:latest
docker run --name jmx-exporter bitnami/jmx-exporter:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami JMX Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jmx-exporter).
```console
$ docker pull bitnami/jmx-exporter:latest
docker pull bitnami/jmx-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jmx-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jmx-exporter:[TAG]
docker pull bitnami/jmx-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create jmx-exporter-network --driver bridge
docker network create jmx-exporter-network --driver bridge
```
#### Step 2: Launch the jmx-exporter container within your network
@ -76,7 +76,7 @@ $ docker network create jmx-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `jmx-exporter-network` network.
```console
$ docker run --name jmx-exporter-node1 --network jmx-exporter-network bitnami/jmx-exporter:latest
docker run --name jmx-exporter-node1 --network jmx-exporter-network bitnami/jmx-exporter:latest
```
#### Step 3: Run another containers
@ -92,7 +92,7 @@ Find all the configuration options in the [JMX Prometheus Exporter documentation
The Bitnami JMX Exporter Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs jmx-exporter
docker logs jmx-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -106,7 +106,7 @@ Bitnami provides up-to-date versions of JMX Exporter, including security patches
#### Step 1: Get the updated image
```console
$ docker pull bitnami/jmx-exporter:latest
docker pull bitnami/jmx-exporter:latest
```
#### Step 2: Stop the running container
@ -114,13 +114,13 @@ $ docker pull bitnami/jmx-exporter:latest
Stop the currently running container using the command
```console
$ docker stop jmx-exporter
docker stop jmx-exporter
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v jmx-exporter
docker rm -v jmx-exporter
```
#### Step 4: Run the new image
@ -128,7 +128,7 @@ $ docker rm -v jmx-exporter
Re-create your container from the new image.
```console
$ docker run --name jmx-exporter bitnami/jmx-exporter:latest
docker run --name jmx-exporter bitnami/jmx-exporter:latest
```
## Contributing
@ -147,7 +147,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

205
bitnami/joomla/README.md
View File

@ -13,8 +13,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/joomla/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/joomla/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@ -51,21 +51,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Joomla! Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/joomla).
```console
$ docker pull bitnami/joomla:latest
docker pull bitnami/joomla:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/joomla/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/joomla:[TAG]
docker pull bitnami/joomla:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
### How to use this image
@ -77,8 +77,8 @@ Joomla! requires access to a MySQL or MariaDB database to store information. We'
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/joomla/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/joomla/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/joomla/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
#### Using the Docker Command Line
@ -88,14 +88,14 @@ If you want to run the application manually instead of using `docker-compose`, t
##### Step 1: Create a network
```console
$ docker network create joomla-network
docker network create joomla-network
```
##### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
```console
$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
docker volume create --name mariadb_data
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_joomla \
--env MARIADB_PASSWORD=bitnami \
@ -108,8 +108,8 @@ $ docker run -d --name mariadb \
##### Step 3: Create volumes for Joomla! persistence and launch the container
```console
$ docker volume create --name joomla_data
$ docker run -d --name joomla \
docker volume create --name joomla_data
docker run -d --name joomla \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env JOOMLA_DATABASE_USER=bn_joomla \
@ -163,13 +163,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
##### Step 1: Create a network (if it does not exist)
```console
$ docker network create joomla-network
docker network create joomla-network
```
##### Step 2. Create a MariaDB container with host volume
```console
$ docker run -d --name mariadb \
docker run -d --name mariadb \
--env ALLOW_EMPTY_PASSWORD=yes \
--env MARIADB_USER=bn_joomla \
--env MARIADB_PASSWORD=bitnami \
@ -182,7 +182,7 @@ $ docker run -d --name mariadb \
##### Step 3. Create the Joomla! container with host volumes
```console
$ docker run -d --name joomla \
docker run -d --name joomla \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env JOOMLA_DATABASE_USER=bn_joomla \
@ -199,7 +199,7 @@ $ docker run -d --name joomla \
When you start the Joomla! image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/joomla/docker-compose.yml) file present in this repository:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/joomla/docker-compose.yml) file present in this repository:
```yaml
joomla:
@ -209,10 +209,10 @@ joomla:
...
```
* For manual execution add a `--env` option with each variable and value:
* For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name joomla -p 80:8080 -p 443:8443 \
docker run -d --name joomla -p 80:8080 -p 443:8443 \
--env JOOMLA_PASSWORD=my_password \
--network joomla-tier \
--volume /path/to/joomla-persistence:/bitnami \
@ -221,74 +221,74 @@ joomla:
Available environment variables:
###### User and Site configuration
#### User and Site configuration
- `JOOMLA_USERNAME`: Joomla! application username. Default: **user**
- `JOOMLA_PASSWORD`: Joomla! application password. Default: **bitnami**
- `JOOMLA_EMAIL`: Joomla! application email. Default: **user@example.com**
- `JOOMLA_SITE_NAME`: Joomla! site name. Default: **New Site**
- `JOOMLA_SECRET`: Secret value for data encryption (auto-generated if not provided). No defaults.
- `JOOMLA_LOAD_SAMPLE_DATA`: Load Joomla sample data. Default: **yes**
- `JOOMLA_SKIP_BOOTSTRAP`: Do not initialize the Joomla! database for a new deployment. This is necessary in case you use a database that already has Joomla! data. Default: **no**
* `JOOMLA_USERNAME`: Joomla! application username. Default: **user**
* `JOOMLA_PASSWORD`: Joomla! application password. Default: **bitnami**
* `JOOMLA_EMAIL`: Joomla! application email. Default: **user@example.com**
* `JOOMLA_SITE_NAME`: Joomla! site name. Default: **New Site**
* `JOOMLA_SECRET`: Secret value for data encryption (auto-generated if not provided). No defaults.
* `JOOMLA_LOAD_SAMPLE_DATA`: Load Joomla sample data. Default: **yes**
* `JOOMLA_SKIP_BOOTSTRAP`: Do not initialize the Joomla! database for a new deployment. This is necessary in case you use a database that already has Joomla! data. Default: **no**
###### Use an existing database
#### Use an existing database
- `JOOMLA_DATABASE_TYPE`: Database type. Valid values: *mariadb*, *mysqli*. Default: **mariadb**
- `JOOMLA_DATABASE_HOST`: Hostname for database server. Default: **mariadb**
- `JOOMLA_DATABASE_PORT_NUMBER`: Port used by database server. Default: **3306**
- `JOOMLA_DATABASE_NAME`: Database name that Joomla! will use to connect with the database. Default: **bitnami_joomla**
- `JOOMLA_DATABASE_USER`: Database user that Joomla! will use to connect with the database. Default: **bn_joomla**
- `JOOMLA_DATABASE_PASSWORD`: Database password that Joomla! will use to connect with the database. No defaults.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
* `JOOMLA_DATABASE_TYPE`: Database type. Valid values: *mariadb*, *mysqli*. Default: **mariadb**
* `JOOMLA_DATABASE_HOST`: Hostname for database server. Default: **mariadb**
* `JOOMLA_DATABASE_PORT_NUMBER`: Port used by database server. Default: **3306**
* `JOOMLA_DATABASE_NAME`: Database name that Joomla! will use to connect with the database. Default: **bitnami_joomla**
* `JOOMLA_DATABASE_USER`: Database user that Joomla! will use to connect with the database. Default: **bn_joomla**
* `JOOMLA_DATABASE_PASSWORD`: Database password that Joomla! will use to connect with the database. No defaults.
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
###### Create a database for Joomla! using mysql-client
#### Create a database for Joomla! using mysql-client
- `MYSQL_CLIENT_FLAVOR`: SQL database flavor. Valid values: `mariadb` or `mysql`. Default: **mariadb**.
- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
- `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
- `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
- `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults.
- `MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES`: Database privileges to grant for the user specified in `MYSQL_CLIENT_CREATE_DATABASE_USER` to the database specified in `MYSQL_CLIENT_CREATE_DATABASE_NAME`. No defaults.
- `MYSQL_CLIENT_ENABLE_SSL_WRAPPER`: Whether to force SSL connections to the database via the `mysql` CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: **no**
- `MYSQL_CLIENT_ENABLE_SSL`: Whether to force SSL connections for the database. Default: **no**
- `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
- `MYSQL_CLIENT_SSL_CERT_FILE`: Path to the SSL CA file for the new database. No defaults
- `MYSQL_CLIENT_SSL_KEY_FILE`: Path to the SSL CA file for the new database. No defaults
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
* `MYSQL_CLIENT_FLAVOR`: SQL database flavor. Valid values: `mariadb` or `mysql`. Default: **mariadb**.
* `MYSQL_CLIENT_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
* `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
* `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
* `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults.
* `MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES`: Database privileges to grant for the user specified in `MYSQL_CLIENT_CREATE_DATABASE_USER` to the database specified in `MYSQL_CLIENT_CREATE_DATABASE_NAME`. No defaults.
* `MYSQL_CLIENT_ENABLE_SSL_WRAPPER`: Whether to force SSL connections to the database via the `mysql` CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: **no**
* `MYSQL_CLIENT_ENABLE_SSL`: Whether to force SSL connections for the database. Default: **no**
* `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
* `MYSQL_CLIENT_SSL_CERT_FILE`: Path to the SSL CA file for the new database. No defaults
* `MYSQL_CLIENT_SSL_KEY_FILE`: Path to the SSL CA file for the new database. No defaults
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
###### SMTP Configuration
#### SMTP Configuration
To configure Joomla! to send email using SMTP you can set the following environment variables:
- `JOOMLA_SMTP_HOST`: SMTP host.
- `JOOMLA_SMTP_PORT`: SMTP port.
- `JOOMLA_SMTP_USER`: SMTP account user.
- `JOOMLA_SMTP_PASSWORD`: SMTP account password.
- `JOOMLA_SMTP_PROTOCOL`: SMTP protocol.
- `JOOMLA_SMTP_SENDER_EMAIL`: SMTP sender email.
- `JOOMLA_SMTP_SENDER_NAME`: SMTP sender name.
* `JOOMLA_SMTP_HOST`: SMTP host.
* `JOOMLA_SMTP_PORT`: SMTP port.
* `JOOMLA_SMTP_USER`: SMTP account user.
* `JOOMLA_SMTP_PASSWORD`: SMTP account password.
* `JOOMLA_SMTP_PROTOCOL`: SMTP protocol.
* `JOOMLA_SMTP_SENDER_EMAIL`: SMTP sender email.
* `JOOMLA_SMTP_SENDER_NAME`: SMTP sender name.
###### PHP configuration
#### PHP configuration
- `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
- `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
- `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
- `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
- `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
- `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
- `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
- `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
* `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default.
* `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
* `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
* `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
* `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
* `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
* `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
* `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
###### Example
#### Example
This would be an example of SMTP configuration using a Gmail account:
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/joomla/docker-compose.yml) file present in this repository:
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/joomla/docker-compose.yml) file present in this repository:
```yaml
joomla:
@ -304,10 +304,11 @@ This would be an example of SMTP configuration using a Gmail account:
- JOOMLA_SMTP_PROTOCOL=tls
...
```
* For manual execution:
* For manual execution:
```console
$ docker run -d --name joomla -p 80:8080 -p 443:8443 \
docker run -d --name joomla -p 80:8080 -p 443:8443 \
--env JOOMLA_DATABASE_USER=bn_joomla \
--env JOOMLA_DATABASE_NAME=bitnami_joomla \
--env JOOMLA_SMTP_HOST=smtp.gmail.com \
@ -337,13 +338,13 @@ Bear in mind that in the example above `es_ES.UTF-8 UTF-8` is the locale needed
The Bitnami Joomla! Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs joomla
docker logs joomla
```
Or using Docker Compose:
```console
$ docker-compose logs joomla
docker-compose logs joomla
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -357,13 +358,13 @@ To backup your data, configuration and logs, follow these simple steps:
##### Step 1: Stop the currently running container
```console
$ docker stop joomla
docker stop joomla
```
Or using Docker Compose:
```console
$ docker-compose stop joomla
docker-compose stop joomla
```
##### Step 2: Run the backup command
@ -371,7 +372,7 @@ $ docker-compose stop joomla
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/joomla-backups:/backups --volumes-from joomla busybox \
docker run --rm -v /path/to/joomla-backups:/backups --volumes-from joomla busybox \
cp -a /bitnami/joomla /backups/latest
```
@ -382,7 +383,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the MariaDB database container:
```diff
$ docker run -d --name mariadb \
docker run -d --name mariadb \
...
- --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
@ -392,7 +393,7 @@ For the MariaDB database container:
For the Joomla! container:
```diff
$ docker run -d --name joomla \
docker run -d --name joomla \
...
- --volume /path/to/joomla-persistence:/bitnami/joomla \
+ --volume /path/to/joomla-backups/latest:/bitnami/joomla \
@ -404,12 +405,12 @@ For the Joomla! container:
> **NOTE:** Application upgrades should be done manually inside the docker container following the [official documentation](https://docs.joomla.org/J3.x:Updating_from_an_existing_version).
> As an alternative, you can try upgrading using an updated Docker image. However, any data from the Joomla! container will be lost and you will have to reinstall all the plugins and themes you manually added.
Bitnami provides up-to-date versions of MariaDB and Joomla!, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Joomla! container. For the MariaDB upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image
Bitnami provides up-to-date versions of MariaDB and Joomla!, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Joomla! container. For the MariaDB upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image>
##### Step 1: Get the updated image
```console
$ docker pull bitnami/joomla:latest
docker pull bitnami/joomla:latest
```
##### Step 2: Stop the running container
@ -417,7 +418,7 @@ $ docker pull bitnami/joomla:latest
Stop the currently running container using the command
```console
$ docker-compose stop joomla
docker-compose stop joomla
```
##### Step 3: Take a snapshot of the application state
@ -437,7 +438,7 @@ docker-compose rm -v joomla
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
### Customize this image
@ -448,10 +449,10 @@ The Bitnami Joomla! Docker image is designed to be extended so it can be used as
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
- [Adding custom virtual hosts](https://github.com/bitnami/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
- [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
- [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/apache#using-custom-ssl-certificates).
* Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively.
* [Adding custom virtual hosts](https://github.com/bitnami/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
* [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
* [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/apache#using-custom-ssl-certificates).
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
@ -463,9 +464,9 @@ FROM bitnami/joomla
Here is an example of extending the image with the following modifications:
- Install the `vim` editor
- Modify the Apache configuration file
- Modify the ports used by Apache
* Install the `vim` editor
* Modify the Apache configuration file
* Modify the ports used by Apache
```Dockerfile
FROM bitnami/joomla
@ -508,18 +509,18 @@ Based on the extended image, you can update the [`docker-compose.yml`](https://g
### 3.9.20-debian-10-r0
- The size of the container image has been decreased.
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
- The Joomla! container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
- The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Joomla! site by exporting its content, and importing it on a new Joomla! container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
* The size of the container image has been decreased.
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
* The Joomla! container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
* The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
* Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Joomla! site by exporting its content, and importing it on a new Joomla! container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
### 3.9.6-debian-9-r12 and 3.9.6-ol-7-r14
- This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
- The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
- The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
- Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
* This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
* The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
* The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
* Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
## Contributing

52
bitnami/jruby/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name jruby bitnami/jruby:latest
docker run -it --name jruby bitnami/jruby:latest
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jruby/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jruby/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami JRuby Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jruby).
```console
$ docker pull bitnami/jruby:latest
docker pull bitnami/jruby:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jruby/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jruby:[TAG]
docker pull bitnami/jruby:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Entering the JRuby Interactive Console
@ -65,12 +65,12 @@ $ docker build -t bitnami/APP:latest .
By default, running this image will drop you into the JRuby Interactive Console (`jirb`), where you can interactively test and try things out in JRuby.
```console
$ docker run -it --name jruby bitnami/jruby:latest
docker run -it --name jruby bitnami/jruby:latest
```
**Further Reading:**
- [JRuby Interactive Console Documentation](https://github.com/jruby/jruby/wiki/GettingStarted#jirb-ruby-interactive-console)
* [JRuby Interactive Console Documentation](https://github.com/jruby/jruby/wiki/GettingStarted#jirb-ruby-interactive-console)
## Configuration
@ -79,7 +79,7 @@ $ docker run -it --name jruby bitnami/jruby:latest
The default work directory for the JRuby image is `/app`. You can mount a folder from your host here that includes your Ruby script, and run it normally using the `ruby` command.
```console
$ docker run -it --name jruby -v /path/to/app:/app bitnami/jruby:latest \
docker run -it --name jruby -v /path/to/app:/app bitnami/jruby:latest \
ruby script.rb
```
@ -88,7 +88,7 @@ $ docker run -it --name jruby -v /path/to/app:/app bitnami/jruby:latest \
If your Ruby app has a `Gemfile` defining your app's dependencies and start script, you can install the dependencies before running your app.
```console
$ docker run -it --name jruby -v /path/to/app:/app bitnami/jruby:latest \
docker run -it --name jruby -v /path/to/app:/app bitnami/jruby:latest \
sh -c "bundle install && jruby script.rb"
```
@ -105,8 +105,8 @@ jruby:
**Further Reading:**
- [rubygems.org](https://rubygems.org/)
- [bundler.io](http://bundler.io/)
* [rubygems.org](https://rubygems.org/)
* [bundler.io](http://bundler.io/)
### Accessing a Ruby app running a web server
@ -128,20 +128,20 @@ end
To access your web server from your host machine you can ask Docker to map a random port on your host to port `3000` inside the container.
```console
$ docker run -it --name jruby -P bitnami/jruby:latest
docker run -it --name jruby -P bitnami/jruby:latest
```
Run `docker port` to determine the random port Docker assigned.
```console
$ docker port jruby
docker port jruby
3000/tcp -> 0.0.0.0:32769
```
You can also manually specify the port you want forwarded from your host to the container.
```console
$ docker run -it --name jruby -p 8080:3000 bitnami/jruby:latest
docker run -it --name jruby -p 8080:3000 bitnami/jruby:latest
```
Access your web server in the browser by navigating to `http://localhost:8080`.
@ -157,7 +157,7 @@ We may want to make our Ruby web server only accessible via an nginx web server.
#### Step 1: Create a network
```console
$ docker network create app-tier --driver bridge
docker network create app-tier --driver bridge
```
or using Docker Compose:
@ -198,7 +198,7 @@ Copy the virtual host above, saving the file somewhere on your host. We will mou
#### Step 3: Run the JRuby image with a specific name
```console
$ docker run -it --name myapp \
docker run -it --name myapp \
--network app-tier \
-v /path/to/app:/app \
bitnami/jruby:latest jruby script.rb
@ -220,7 +220,7 @@ myapp:
#### Step 4: Run the nginx image
```console
$ docker run -it \
docker run -it \
-v /path/to/vhost.conf:/bitnami/nginx/conf/vhosts/yourapp.conf \
--network app-tier \
bitnami/nginx:latest
@ -247,7 +247,7 @@ Bitnami provides up-to-date versions of JRuby, including security patches, soon
#### Step 1: Get the updated image
```console
$ docker pull bitnami/jruby:latest
docker pull bitnami/jruby:latest
```
#### Step 2: Stop the running container
@ -255,13 +255,13 @@ $ docker pull bitnami/jruby:latest
Stop the currently running container using the command
```console
$ docker stop jruby
docker stop jruby
```
#### Step 3: Remove the currently running container
```console
$ docker-compose rm -v jruby
docker-compose rm -v jruby
```
#### Step 4: Run the new image
@ -269,13 +269,13 @@ $ docker-compose rm -v jruby
Re-create your container from the new image.
```console
$ docker run --name jruby bitnami/jruby:latest
docker run --name jruby bitnami/jruby:latest
```
or using Docker Compose:
```console
$ docker-compose up ruby
docker-compose up ruby
```
## Contributing
@ -294,7 +294,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

16
bitnami/jsonnet/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name jsonnet bitnami/jsonnet:latest
docker run --name jsonnet bitnami/jsonnet:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Git Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jsonnet).
```console
$ docker pull bitnami/jsonnet:latest
docker pull bitnami/jsonnet:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jsonnet/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jsonnet:[TAG]
docker pull bitnami/jsonnet:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -60,7 +60,7 @@ $ docker build -t bitnami/APP:latest .
To run commands inside this container you can use `docker run`, for example to evaluate jsonnet code:
```console
$ docker run --name jsonnet bitnami/jsonnet:latest -e "{hello: 'world'}"
docker run --name jsonnet bitnami/jsonnet:latest -e "{hello: 'world'}"
```
## Contributing
@ -87,7 +87,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

16
bitnami/jupyter-base-notebook/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name jupyter-base-notebook bitnami/jupyter-base-notebook:latest
docker run --name jupyter-base-notebook bitnami/jupyter-base-notebook:latest
```
## Why use Bitnami Images?
@ -36,21 +36,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami jupyter-base-notebook Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jupyter-base-notebook).
```console
$ docker pull bitnami/jupyter-base-notebook:latest
docker pull bitnami/jupyter-base-notebook:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jupyter-base-notebook/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jupyter-base-notebook:[TAG]
docker pull bitnami/jupyter-base-notebook:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -64,7 +64,7 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `jupyterhub-singleuser --version` you can follow the example below:
```console
$ docker run --rm --name jupyter-base-notebook bitnami/jupyter-base-notebook:latest -- jupyterhub-singleuser --version
docker run --rm --name jupyter-base-notebook bitnami/jupyter-base-notebook:latest -- jupyterhub-singleuser --version
```
Check the [official Jupyter Notebook documentation](https://jupyter.readthedocs.io/en/latest/running.html) for a list of the available parameters.
@ -100,7 +100,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

16
bitnami/jupyterhub/README.md
View File

@ -34,21 +34,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami jupyterhub Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jupyterhub).
```console
$ docker pull bitnami/jupyterhub:latest
docker pull bitnami/jupyterhub:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jupyterhub/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jupyterhub:[TAG]
docker pull bitnami/jupyterhub:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Why use a non-root container?
@ -62,13 +62,13 @@ Non-root container images add an extra layer of security and are generally recom
To run commands inside this container you can use `docker run`, for example to execute `jupyterhub --version` you can follow the example below:
```console
$ docker run --rm --name jupyterhub bitnami/jupyterhub:latest --version
docker run --rm --name jupyterhub bitnami/jupyterhub:latest --version
```
Check the [official Jupyter Hub documentation](https://jupyterhub.readthedocs.io/en/stable/reference/config-reference.html)i, or run the following to list of the available parameters.
```console
$ docker run --rm --name jupyterhub bitnami/jupyterhub:latest --help-all
docker run --rm --name jupyterhub bitnami/jupyterhub:latest --help-all
```
## Contributing
@ -87,7 +87,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

30
bitnami/jwt-cli/README.md
View File

@ -11,14 +11,14 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run -it --name jwt-cli bitnami/jwt-cli
docker run -it --name jwt-cli bitnami/jwt-cli
```
### Docker Compose
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jwt-cli/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jwt-cli/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami JWT CLI Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jwt-cli).
```console
$ docker pull bitnami/jwt-cli:latest
docker pull bitnami/jwt-cli:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jwt-cli/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jwt-cli:[TAG]
docker pull bitnami/jwt-cli:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Maintenance
@ -69,7 +69,7 @@ Bitnami provides up-to-date versions of JWT CLI, including security patches, soo
#### Step 1: Get the updated image
```console
$ docker pull bitnami/jwt-cli:latest
docker pull bitnami/jwt-cli:latest
```
or if you're using Docker Compose, update the value of the image property to `bitnami/jwt-cli:latest`.
@ -77,13 +77,13 @@ or if you're using Docker Compose, update the value of the image property to `bi
#### Step 2: Remove the currently running container
```console
$ docker rm -v jwt-cli
docker rm -v jwt-cli
```
or using Docker Compose:
```console
$ docker-compose rm -v jwt-cli
docker-compose rm -v jwt-cli
```
#### Step 3: Run the new image
@ -91,13 +91,13 @@ $ docker-compose rm -v jwt-cli
Re-create your container from the new image.
```console
$ docker run --name jwt-cli bitnami/jwt-cli:latest
docker run --name jwt-cli bitnami/jwt-cli:latest
```
or using Docker Compose:
```console
$ docker-compose up jwt-cli
docker-compose up jwt-cli
```
## Configuration
@ -107,7 +107,7 @@ $ docker-compose up jwt-cli
To run commands inside this container you can use `docker run`, for example to execute `jwt --help` you can follow the example below:
```console
$ docker run --rm --name jwt-cli bitnami/jwt-cli:latest --help
docker run --rm --name jwt-cli bitnami/jwt-cli:latest --help
```
Check the [official JWT CLI documentation](https://github.com/mike-engel/jwt-cli) for more information about how to use JWT CLI.
@ -128,7 +128,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

28
bitnami/kafka-exporter/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name kafka-exporter bitnami/kafka-exporter:latest
docker run --name kafka-exporter bitnami/kafka-exporter:latest
```
## Why use Bitnami Images?
@ -40,21 +40,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Kafka Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/kafka-exporter).
```console
$ docker pull bitnami/kafka-exporter:latest
docker pull bitnami/kafka-exporter:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/kafka-exporter/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/kafka-exporter:[TAG]
docker pull bitnami/kafka-exporter:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Connecting to other containers
@ -68,7 +68,7 @@ Containers attached to the same network can communicate with each other using th
#### Step 1: Create a network
```console
$ docker network create kafka-exporter-network --driver bridge
docker network create kafka-exporter-network --driver bridge
```
#### Step 2: Launch the kafka-exporter container within your network
@ -76,7 +76,7 @@ $ docker network create kafka-exporter-network --driver bridge
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `kafka-exporter-network` network.
```console
$ docker run --name kafka-exporter-node1 --network kafka-exporter-network bitnami/kafka-exporter:latest
docker run --name kafka-exporter-node1 --network kafka-exporter-network bitnami/kafka-exporter:latest
```
#### Step 3: Run another containers
@ -92,7 +92,7 @@ Find all the configuration options in the [Kafka Prometheus Exporter documentati
The Bitnami Kafka Exporter Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs kafka-exporter
docker logs kafka-exporter
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -106,7 +106,7 @@ Bitnami provides up-to-date versions of Kafka Exporter, including security patch
#### Step 1: Get the updated image
```console
$ docker pull bitnami/kafka-exporter:latest
docker pull bitnami/kafka-exporter:latest
```
#### Step 2: Stop the running container
@ -114,13 +114,13 @@ $ docker pull bitnami/kafka-exporter:latest
Stop the currently running container using the command
```console
$ docker stop kafka-exporter
docker stop kafka-exporter
```
#### Step 3: Remove the currently running container
```console
$ docker rm -v kafka-exporter
docker rm -v kafka-exporter
```
#### Step 4: Run the new image
@ -128,7 +128,7 @@ $ docker rm -v kafka-exporter
Re-create your container from the new image.
```console
$ docker run --name kafka-exporter bitnami/kafka-exporter:latest
docker run --name kafka-exporter bitnami/kafka-exporter:latest
```
## Contributing
@ -147,7 +147,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

77
bitnami/kafka/README.md
View File

@ -15,8 +15,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/kafka/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/kafka/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/kafka/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
## Why use Bitnami Images?
@ -51,7 +51,7 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Apache Kafka Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/kafka).
```console
$ docker pull bitnami/kafka:latest
docker pull bitnami/kafka:latest
```
To use a specific version, you can pull a versioned tag. You can view the
@ -59,15 +59,15 @@ To use a specific version, you can pull a versioned tag. You can view the
in the Docker Hub Registry.
```console
$ docker pull bitnami/kafka:[TAG]
docker pull bitnami/kafka:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your data
@ -105,7 +105,7 @@ In this example, we will create an Apache Kafka client instance that will connec
#### Step 1: Create a network
```console
$ docker network create app-tier --driver bridge
docker network create app-tier --driver bridge
```
#### Step 2: Launch the Zookeeper server instance
@ -113,7 +113,7 @@ $ docker network create app-tier --driver bridge
Use the `--network app-tier` argument to the `docker run` command to attach the Zookeeper container to the `app-tier` network.
```console
$ docker run -d --name zookeeper-server \
docker run -d --name zookeeper-server \
--network app-tier \
-e ALLOW_ANONYMOUS_LOGIN=yes \
bitnami/zookeeper:latest
@ -124,7 +124,7 @@ $ docker run -d --name zookeeper-server \
Use the `--network app-tier` argument to the `docker run` command to attach the Apache Kafka container to the `app-tier` network.
```console
$ docker run -d --name kafka-server \
docker run -d --name kafka-server \
--network app-tier \
-e ALLOW_PLAINTEXT_LISTENER=yes \
-e KAFKA_CFG_ZOOKEEPER_CONNECT=zookeeper-server:2181 \
@ -136,7 +136,7 @@ $ docker run -d --name kafka-server \
Finally we create a new container instance to launch the Apache Kafka client and connect to the server created in the previous step:
```console
$ docker run -it --rm \
docker run -it --rm \
--network app-tier \
-e KAFKA_CFG_ZOOKEEPER_CONNECT=zookeeper-server:2181 \
bitnami/kafka:latest kafka-topics.sh --list --bootstrap-server kafka-server:9092
@ -177,7 +177,7 @@ services:
Launch the containers using:
```console
$ docker-compose up -d
docker-compose up -d
```
## Configuration
@ -210,7 +210,7 @@ The configuration can easily be setup with the Bitnami Apache Kafka Docker image
Additionally, any environment variable beginning with `KAFKA_CFG_` will be mapped to its corresponding Apache Kafka key. For example, use `KAFKA_CFG_BACKGROUND_THREADS` in order to set `background.threads` or `KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE` in order to configure `auto.create.topics.enable`.
```console
$ docker run --name kafka -e KAFKA_CFG_ZOOKEEPER_CONNECT=zookeeper:2181 -e ALLOW_PLAINTEXT_LISTENER=yes -e KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE=true bitnami/kafka:latest
docker run --name kafka -e KAFKA_CFG_ZOOKEEPER_CONNECT=zookeeper:2181 -e ALLOW_PLAINTEXT_LISTENER=yes -e KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE=true bitnami/kafka:latest
```
or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/kafka/docker-compose.yml) file present in this repository:
@ -252,7 +252,7 @@ services:
To deploy it, run the following command in the directory where the `docker-compose.yml` file is located:
```
```console
docker-compose up -d
```
@ -261,7 +261,7 @@ docker-compose up -d
Apache Kafka Raft (KRaft) makes use of a new quorum controller service in Kafka which replaces the previous controller and makes use of an event-based variant of the Raft consensus protocol.
This greatly simplifies Kafka’s architecture by consolidating responsibility for metadata into Kafka itself, rather than splitting it between two different systems: ZooKeeper and Kafka.
More Info can be found here: https://developer.confluent.io/learn/kraft/
More Info can be found here: <https://developer.confluent.io/learn/kraft/>
> **NOTE:** According to [KIP-833](https://cwiki.apache.org/confluence/display/KAFKA/KIP-833%3A+Mark+KRaft+as+Production+Ready), KRaft is now in a production-ready state.
@ -389,7 +389,7 @@ Keep in mind the following notes:
* When prompted to enter a password, use the same one for all.
* Set the Common Name or FQDN values to your Apache Kafka container hostname, e.g. `kafka.example.com`. After entering this value, when prompted "What is your first and last name?", enter this value as well.
* As an alternative, you can disable host name verification setting the environment variable `KAFKA_CFG_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM` to an empty string.
* When setting up a Apache Kafka Cluster (check [this section](#setting-up-a-kafka-cluster) for more information), each Apache Kafka broker and logical client needs its own keystore. You will have to repeat the process for each of the brokers in the cluster.
* When setting up a Apache Kafka Cluster (check [this section](#setting-up-an-apache-kafka-cluster) for more information), each Apache Kafka broker and logical client needs its own keystore. You will have to repeat the process for each of the brokers in the cluster.
The following docker-compose file is an example showing how to mount your JKS certificates protected by the password `certificatePassword123`. Additionally it is specifying the Apache Kafka container hostname and the credentials for the client and zookeeper users.
@ -463,6 +463,7 @@ When configuring Apache Kafka with `SASL` or `SASL_SSL` for communications with
* `KAFKA_CLIENT_USERS`: Apache Kafka client user. Default: **user**
* `KAFKA_CLIENT_PASSWORDS`: Apache Kafka client user password. Default: **bitnami**
#### Apache Kafka ZooKeeper client configuration
There are different options of configuration to connect a Zookeeper server.
@ -502,12 +503,12 @@ In order to authenticate Apache Kafka against a Zookeeper server with `SASL_SSL`
An Apache Kafka cluster can easily be setup with the Bitnami Apache Kafka Docker image using the following environment variables:
- `KAFKA_CFG_ZOOKEEPER_CONNECT`: Comma separated host:port pairs, each corresponding to a Zookeeper Server.
* `KAFKA_CFG_ZOOKEEPER_CONNECT`: Comma separated host:port pairs, each corresponding to a Zookeeper Server.
Create a Docker network to enable visibility to each other via the docker container name
```console
$ docker network create app-tier --driver bridge
docker network create app-tier --driver bridge
```
#### Step 1: Create the first node for Zookeeper
@ -515,7 +516,7 @@ $ docker network create app-tier --driver bridge
The first step is to create one Zookeeper instance.
```console
$ docker run --name zookeeper \
docker run --name zookeeper \
--network app-tier \
-e ALLOW_ANONYMOUS_LOGIN=yes \
-p 2181:2181 \
@ -527,7 +528,7 @@ $ docker run --name zookeeper \
The first step is to create one Apache Kafka instance.
```console
$ docker run --name kafka1 \
docker run --name kafka1 \
--network app-tier \
-e KAFKA_CFG_ZOOKEEPER_CONNECT=zookeeper:2181 \
-e ALLOW_PLAINTEXT_LISTENER=yes \
@ -540,7 +541,7 @@ $ docker run --name kafka1 \
Next we start a new Apache Kafka container.
```console
$ docker run --name kafka2 \
docker run --name kafka2 \
--network app-tier \
-e KAFKA_CFG_ZOOKEEPER_CONNECT=zookeeper:2181 \
-e ALLOW_PLAINTEXT_LISTENER=yes \
@ -553,7 +554,7 @@ $ docker run --name kafka2 \
Next we start another new Apache Kafka container.
```console
$ docker run --name kafka3 \
docker run --name kafka3 \
--network app-tier \
-e KAFKA_CFG_ZOOKEEPER_CONNECT=zookeeper:2181 \
-e ALLOW_PLAINTEXT_LISTENER=yes \
@ -616,7 +617,7 @@ Topic:mytopic PartitionCount:3 ReplicationFactor:3 Configs:
The image looks for configuration files (server.properties, log4j.properties, etc.) in the `/bitnami/kafka/config/` directory, this directory can be changed by setting the KAFKA_MOUNTED_CONF_DIR environment variable.
```console
$ docker run --name kafka -v /path/to/server.properties:/bitnami/kafka/config/server.properties bitnami/kafka:latest
docker run --name kafka -v /path/to/server.properties:/bitnami/kafka/config/server.properties bitnami/kafka:latest
```
After that, your changes will be taken into account in the server's behaviour.
@ -650,13 +651,13 @@ vi /path/to/server.properties
After changing the configuration, restart your Apache Kafka container for changes to take effect.
```console
$ docker restart kafka
docker restart kafka
```
Or using Docker Compose:
```console
$ docker-compose restart kafka
docker-compose restart kafka
```
## Logging
@ -664,13 +665,13 @@ $ docker-compose restart kafka
The Bitnami Apache Kafka Docker image sends the container logs to the `stdout`. To view the logs:
```console
$ docker logs kafka
docker logs kafka
```
Or using Docker Compose:
```console
$ docker-compose logs kafka
docker-compose logs kafka
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
@ -684,13 +685,13 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
```console
$ docker stop kafka
docker stop kafka
```
Or using Docker Compose:
```console
$ docker-compose stop kafka
docker-compose stop kafka
```
#### Step 2: Run the backup command
@ -698,14 +699,14 @@ $ docker-compose stop kafka
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/kafka-backups:/backups --volumes-from kafka busybox \
docker run --rm -v /path/to/kafka-backups:/backups --volumes-from kafka busybox \
cp -a /bitnami/kafka /backups/latest
```
Or using Docker Compose:
```console
$ docker run --rm -v /path/to/kafka-backups:/backups --volumes-from `docker-compose ps -q kafka` busybox \
docker run --rm -v /path/to/kafka-backups:/backups --volumes-from `docker-compose ps -q kafka` busybox \
cp -a /bitnami/kafka /backups/latest
```
@ -714,7 +715,7 @@ $ docker run --rm -v /path/to/kafka-backups:/backups --volumes-from `docker-comp
Restoring a backup is as simple as mounting the backup as volumes in the container.
```console
$ docker run -v /path/to/kafka-backups/latest:/bitnami/kafka bitnami/kafka:latest
docker run -v /path/to/kafka-backups/latest:/bitnami/kafka bitnami/kafka:latest
```
You can also modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/kafka/docker-compose.yml) file present in this repository:
@ -732,7 +733,7 @@ Bitnami provides up-to-date versions of Apache Kafka, including security patches
#### Step 1: Get the updated image
```console
$ docker pull bitnami/kafka:latest
docker pull bitnami/kafka:latest
```
or if you're using Docker Compose, update the value of the image property to
@ -747,13 +748,13 @@ Follow the steps on [creating a backup](#backing-up-your-container).
#### Step 3: Remove the currently running container
```console
$ docker rm -v kafka
docker rm -v kafka
```
Or using Docker Compose:
```console
$ docker-compose rm -v kafka
docker-compose rm -v kafka
```
#### Step 4: Run the new image
@ -761,13 +762,13 @@ $ docker-compose rm -v kafka
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
```console
$ docker run --name kafka bitnami/kafka:latest
docker run --name kafka bitnami/kafka:latest
```
Or using Docker Compose:
```console
$ docker-compose up kafka
docker-compose up kafka
```
## Notable Changes
@ -882,7 +883,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

46
bitnami/kapacitor/README.md
View File

@ -6,13 +6,13 @@
[Overview of Kapacitor &trade;](https://github.com/influxdata/kapacitor)
# TL;DR;
## TL;DR
```console
$ docker run --name kapacitor bitnami/kapacitor:latest
docker run --name kapacitor bitnami/kapacitor:latest
```
# Why use Bitnami Images?
## Why use Bitnami Images?
* 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.
@ -21,7 +21,7 @@ $ docker run --name kapacitor bitnami/kapacitor:latest
* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DTC)](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.
# Supported tags and respective `Dockerfile` links
## Supported tags and respective `Dockerfile` links
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
@ -29,67 +29,67 @@ You can see the equivalence between the different tags by taking a look at the `
Subscribe to project updates by watching the [bitnami/containers GitHub repo](https://github.com/bitnami/containers).
# Get this image
## Get this image
The recommended way to get the Bitnami kapacitor Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/kapacitor).
```console
$ docker pull bitnami/kapacitor:latest
docker pull bitnami/kapacitor:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/kapacitor/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/kapacitor:[TAG]
docker pull bitnami/kapacitor:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
# Persisting your application
## Persisting your application
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
For persistence you should mount a directory at the `/bitnami/kapacitor` path. If the mounted directory is empty, it will be initialized on the first run.
```console
$ docker run \
docker run \
-v /path/to/kapacitor-persistence:/bitnami/kapacitor \
bitnami/kapacitor:latest
```
# Configuration
## Configuration
## Running commands
The container has the `kapacitor`, `kapacitord` and `tickfmt` commands available. To run commands inside this container you can use `docker run`, for example to execute `kapacitord --help` you can follow the example below:
```console
$ docker run --rm --name kapacitor bitnami/kapacitor:latest -- kapacitord --help
docker run --rm --name kapacitor bitnami/kapacitor:latest -- kapacitord --help
```
Check the [official Kapacitor documentation](https://docs.influxdata.com/kapacitor) for a list of the available parameters.
# Contributing
## Contributing
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/containers/blob/main/bitnami/kapacitor/issues) or submitting a [pull request](https://github.com/bitnami/containers/blob/main/bitnami/kapacitor/pulls) with your contribution.
# Issues
## Issues
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to include the following information in your issue:
- Host OS and version
- Docker version (`docker version`)
- Output of `docker info`
- Version of this container
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
* Host OS and version
* Docker version (`docker version`)
* Output of `docker info`
* Version of this container
* The command you used to run the container, and any relevant output you saw (masking any sensitive information)
# License
## License
Copyright &copy; 2023 Bitnami
@ -97,7 +97,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

15
bitnami/keycloak-config-cli/README.md
View File

@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --rm --name Keycloak Config CLI bitnami/keycloak-config-cli:latest
docker run --rm --name Keycloak Config CLI bitnami/keycloak-config-cli:latest
```
## Why use Bitnami Images?
@ -44,21 +44,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Keycloak Config CLI Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/keycloak-config-cli).
```console
$ docker pull bitnami/keycloak-config-cli:latest
docker pull bitnami/keycloak-config-cli:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/keycloak-config-cli/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/keycloak-config-cli:[TAG]
docker pull bitnami/keycloak-config-cli:[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. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
$ git clone https://github.com/bitnami/containers.git
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/APP:latest .
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Configuration
@ -74,13 +74,14 @@ We'd love for you to contribute to this container. You can request new features
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright &copy; 2023 Bitnami
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,

Some files were not shown because too many files have changed in this diff Show More