bitnami-containers/bitnami/drupal-nginx/README.md

# Bitnami package for Drupal with NGINX

## What is Drupal with NGINX?

> Drupal with NGINX enhances the popular open source CMS with the performance and security of NGINX. Drupal's modular architecture lets you create many different types of websites and applications.

[Overview of Drupal with NGINX](http://drupal.org)
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

## 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
```

**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.

## 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.
* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
* All our images are based on [**minideb**](https://github.com/bitnami/minideb) -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or **scratch** -an explicitly empty image-.
* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images.
* Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use Drupal with NGINX in production? Try [VMware Tanzu Application Catalog](https://bitnami.com/enterprise), the enterprise edition of Bitnami Application Catalog.

## Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/).

### 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/).

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 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
```

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]
```

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 .
```

## How to use this image

### Run Drupal with a Database Container

Running Drupal with a database server is the recommended way. You can either use docker-compose or run the containers manually.

#### Run the application using Docker Compose

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
```

#### 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

  ```console
  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 \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -e MARIADB_USER=bn_drupal \
    -e MARIADB_DATABASE=bitnami_drupal \
    --net drupal-network \
    --volume mariadb_data:/bitnami/mariadb \
    bitnami/mariadb:latest
  ```

##### 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 \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -e DRUPAL_DATABASE_USER=bn_drupal \
    -e DRUPAL_DATABASE_NAME=bitnami_drupal \
    --net drupal-network \
    --volume drupal_data:/bitnami/drupal
    bitnami/drupal-nginx:latest
  ```

Access your application at `http://your-ip:8080/`

### 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/drupal` path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the MariaDB data](https://github.com/bitnami/containers/blob/main/bitnami/mariadb#persisting-your-database).

The above examples define the Docker volumes named mariadb_data and drupal_data. The Drupal application state will persist as long as volumes are not removed.

To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

#### Mount host directories as data volumes with Docker Compose

This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal-nginx/docker-compose.yml) file present in this repository:

```diff
   mariadb:
     ...
     volumes:
-      - 'mariadb_data:/bitnami/mariadb'
+      - /path/to/mariadb-persistence:/bitnami/mariadb
   ...
   drupal:
     ...
     volumes:
-      - 'drupal_data:/bitnami/drupal'
+      - /path/to/drupal-persistence:/bitnami/drupal
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  drupal_data:
-    driver: local
```

> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.

#### Mount host directories as data volumes using the Docker command line

##### Step 1: Create a network (if it does not exist)

```console
docker network create drupal-network
```

##### 2. Create a MariaDB container with host volume

```console
docker run -d --name mariadb \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=bn_drupal \
  -e MARIADB_PASSWORD=bitnami \
  -e MARIADB_DATABASE=bitnami_drupal \
  --net drupal-network \
  --volume /path/to/mariadb-persistence:/bitnami \
  bitnami/mariadb:latest
```

##### Step 3. Create the Drupal container with host volumes

```console
docker run -d --name drupal \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env DRUPAL_DATABASE_USER=bn_drupal \
  --env DRUPAL_DATABASE_PASSWORD=bitnami \
  --env DRUPAL_DATABASE_NAME=bitnami_drupal \
  --network drupal-network \
  --volume /path/to/drupal-persistence:/bitnami/drupal \
  bitnami/drupal-nginx:latest
```

## Configuration

### Environment variables

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:

```yaml
drupal:
  ...
  environment:
    - DRUPAL_PASSWORD=my_password
  ...
```

* For manual execution add a `--env` option with each variable and value:

  ```console
  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 \
    bitnami/drupal-nginx:latest
  ```

Available environment variables:

#### 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.

#### 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**

#### 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**

#### 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).

#### 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_OUTPUT_BUFFERING`: Size of the output buffer for PHP. Default: **8196**

#### 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:

```yaml
  drupal:
    ...
    environment:
      - DRUPAL_DATABASE_USER=bn_drupal
      - DRUPAL_DATABASE_NAME=bitnami_drupal
      - ALLOW_EMPTY_PASSWORD=yes
      - DRUPAL_SMTP_HOST=smtp.gmail.com
      - DRUPAL_SMTP_PORT=587
      - DRUPAL_SMTP_USER=your_email@gmail.com
      - DRUPAL_SMTP_PASSWORD=your_password
      - DRUPAL_SMTP_PROTOCOL=tls
  ...
```

* For manual execution:

  ```console
  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 \
    --env DRUPAL_SMTP_PORT=587 \
    --env DRUPAL_SMTP_USER=your_email@gmail.com \
    --env DRUPAL_SMTP_PASSWORD=your_password \
    --env DRUPAL_SMTP_PROTOCOL=tls \
    --network drupal-tier \
    --volume /path/to/drupal-persistence:/bitnami \
    bitnami/drupal-nginx:latest

  ```

### Logging

The Bitnami Drupal Docker image sends the container logs to `stdout`. To view the logs:

```console
docker logs drupal
```

Or using Docker Compose:

```console
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.

### Maintenance

#### Backing up your container

To backup your data, configuration and logs, follow these simple steps:

##### Step 1: Stop the currently running container

```console
docker stop drupal
```

Or using Docker Compose:

```console
docker-compose stop drupal
```

##### 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/drupal-backups:/backups --volumes-from drupal busybox \
  cp -a /bitnami/drupal /backups/latest
```

#### Restoring a backup

Restoring a backup is as simple as mounting the backup as volumes in the containers.

For the MariaDB database container:

```diff
 $ docker run -d --name mariadb \
   ...
-  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+  --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
   bitnami/mariadb:latest
```

For the Drupal container:

```diff
 $ docker run -d --name drupal \
   ...
-  --volume /path/to/drupal-persistence:/bitnami/drupal \
+  --volume /path/to/drupal-backups/latest:/bitnami/drupal \
   bitnami/drupal-nginx:latest
```

#### 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
```

##### Step 2: Stop the running container

Stop the currently running container using the command

```console
docker-compose stop drupal
```

##### Step 3: Take a snapshot of the application state

Follow the steps in [Backing up your container](#backing-up-your-container) to take a snapshot of the current application state.

##### Step 4: Remove the currently running container

Remove the currently running container by executing the following command:

```console
docker-compose rm -v drupal
```

##### Step 5: Run the new image

Update the image tag in `docker-compose.yml` and re-create your container with the new image:

```console
docker-compose up -d
```

## Customize this image

The Bitnami Drupal with NGINX Docker image is designed to be extended so it can be used as the base image for your custom web applications.

### Extend this image

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).

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:

```Dockerfile
FROM bitnami/drupal-nginx
### Put your customizations below
...
```

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

```Dockerfile
FROM bitnami/drupal-nginx

### Install 'vim'
RUN install_packages vim

### Update ssl_session_timeout
RUN sed -i -r -E 's/ssl_session_timeout\s+5m;/ssl_session_timeout  5m;/' /opt/bitnami/nginx/conf/nginx.conf

### Modify the ports used by NGINX by default
## It is also possible to change these environment variables at runtime
ENV NGINX_HTTP_PORT_NUMBER=8181
ENV NGINX_HTTPS_PORT_NUMBER=8143
EXPOSE 8181 8143
```

Based on the extended image, you can update the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/drupal-nginx/docker-compose.yml) file present in this repository to add other features:

```diff
   drupal:
-    image: bitnami/drupal-nginx:latest
+    build: .
     ports:
-      - '80:8080'
-      - '443:8443'
+      - '80:8181'
+      - '443:8143'
     environment:
+      - PHP_MEMORY_LIMIT=512m
     ...
```

## 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 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`.

## 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/issues) or submitting a [pull request](https://github.com/bitnami/containers/pulls) with your contribution.

## 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 fill the issue template.

## License

Copyright &copy; 2023 VMware, Inc.

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>

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.