bitnami-containers/bitnami/drupal/README.md

245 lines
18 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Bitnami Secure Image for Drupal
> Drupal is one of the most versatile open source content management systems in the world. It is pre-configured with the Ctools and Views modules, Drush and Let's Encrypt auto-configuration support.
[Overview of Drupal](https://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
docker run --name drupal bitnami/drupal:latest
```
**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 Secure Images?
Those are hardened, minimal CVE images built and maintained by Bitnami. Bitnami Secure Images are based on the cloud-optimized, security-hardened enterprise [OS Photon Linux](https://vmware.github.io/photon/). Why choose BSI images?
- Hardened secure images of popular open source software with Near-Zero Vulnerabilities
- Vulnerability Triage & Prioritization with VEX Statements, KEV and EPSS Scores
- Compliance focus with FIPS, STIG, and air-gap options, including secure bill of materials (SBOM)
- Software supply chain provenance attestation through in-toto
- First class support for the internets favorite Helm charts
Each image comes with valuable security metadata. You can view the metadata in [our public catalog here](https://app-catalog.vmware.com/bitnami/apps). Note: Some data is only available with [commercial subscriptions to BSI](https://bitnami.com/).
![Alt text](https://github.com/bitnami/containers/blob/main/BSI%20UI%201.png?raw=true "Application details")
![Alt text](https://github.com/bitnami/containers/blob/main/BSI%20UI%202.png?raw=true "Packaging report")
If you are looking for our previous generation of images based on Debian Linux, please see the [Bitnami Legacy registry](https://hub.docker.com/u/bitnamilegacy).
## 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://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-work-with-non-root-containers-index.html).
## How to deploy Drupal 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 Drupal Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/drupal).
## 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://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-understand-rolling-tags-containers-index.html).
## Get this image
The Bitnami Drupal Docker image is only available to [Bitnami Secure Images](https://bitnami.com) customers.
## How to use this image
Drupal requires access to a MySQL or MariaDB database to store information. We'll use the [Bitnami Docker Image for MariaDB](https://github.com/bitnami/containers/tree/main/bitnami/mariadb) for the database requirements.
## 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).
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.
> **NOTE** As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
## Configuration
The following section describes the supported environment variables
### Environment variables
The following tables list the main variables you can set.
#### Customizable environment variables
| Name | Description | Default Value |
|-------------------------------|------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
| `DRUPAL_DATA_TO_PERSIST` | Files to persist relative to the Drupal installation directory. To provide multiple values, separate them with a whitespace. | `sites/ themes/ modules/ profiles/` |
| `DRUPAL_PROFILE` | Drupal installation profile. | `standard` |
| `DRUPAL_SITE_NAME` | Drupal blog name. | `My blog` |
| `DRUPAL_SKIP_BOOTSTRAP` | Whether to perform initial bootstrapping for the application. | `nil` |
| `DRUPAL_ENABLE_MODULES` | Comma or space separated list of installed modules to enable during the first initialization. | `nil` |
| `DRUPAL_CONFIG_SYNC_DIR` | Drupal sync configuration directory location. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. | `nil` |
| `DRUPAL_HASH_SALT` | Drupal string used to generate random values. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. | `nil` |
| `DRUPAL_USERNAME` | Drupal user name. | `user` |
| `DRUPAL_PASSWORD` | Drupal user password. | `bitnami` |
| `DRUPAL_EMAIL` | Drupal user e-mail address. | `user@example.com` |
| `DRUPAL_SMTP_HOST` | Drupal SMTP server host. | `nil` |
| `DRUPAL_SMTP_PORT_NUMBER` | Drupal SMTP server port number. | `25` |
| `DRUPAL_SMTP_USER` | Drupal SMTP server user. | `nil` |
| `DRUPAL_SMTP_PASSWORD` | Drupal SMTP server user password. | `nil` |
| `DRUPAL_SMTP_PROTOCOL` | Drupal SMTP server protocol. | `standard` |
| `DRUPAL_DATABASE_HOST` | Database server host. | `$DRUPAL_DEFAULT_DATABASE_HOST` |
| `DRUPAL_DATABASE_PORT_NUMBER` | Database server port. | `3306` |
| `DRUPAL_DATABASE_NAME` | Database name. | `bitnami_drupal` |
| `DRUPAL_DATABASE_USER` | Database user name. | `bn_drupal` |
| `DRUPAL_DATABASE_PASSWORD` | Database user password. | `nil` |
| `DRUPAL_DATABASE_TLS_CA_FILE` | TLS CA certificate for connections. | `nil` |
#### Read-only environment variables
| Name | Description | Value |
|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| `DRUPAL_BASE_DIR` | Drupal installation directory. | `${BITNAMI_ROOT_DIR}/drupal` |
| `DRUPAL_CONF_FILE` | Configuration file for Drupal. | `${DRUPAL_BASE_DIR}/sites/default/settings.php` |
| `DRUPAL_MODULES_DIR` | Drupal modules directory. | `${DRUPAL_BASE_DIR}/modules` |
| `DRUPAL_VOLUME_DIR` | Drupal directory for mounted configuration files. | `${BITNAMI_VOLUME_DIR}/drupal` |
| `DRUPAL_MOUNTED_CONF_FILE` | Mounted configuration file for Drupal. It will be copied to the Drupal installation directory during the initialization process. | `${DRUPAL_VOLUME_DIR}/settings.php` |
| `DRUPAL_DEFAULT_DATABASE_HOST` | Default database server host. | `mariadb` |
| `PHP_DEFAULT_MEMORY_LIMIT` | Default PHP memory limit. | `256M` |
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.
#### SMTP configuration
The `DRUPAL_SMTP_*` environment variables allows you configure the SMTP settings in the application. Please take a look at the environment variables information above for more information.
### FIPS configuration in Bitnami Secure Images
The Bitnami Drupal Docker image from the [Bitnami Secure Images](https://go-vmware.broadcom.com/contact-us) catalog includes extra features and settings to configure the container with FIPS capabilities. You can configure the next environment variables:
- `OPENSSL_FIPS`: whether OpenSSL runs in FIPS mode or not. `yes` (default), `no`.
## 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:latest
```
## Customize this image
The Bitnami Drupal 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 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:
```Dockerfile
FROM bitnami/drupal
## Put your customizations below
...
```
## 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.
## 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`.
## 8.5.3-r1
- The drupal container now uses drush to install and update the Drupal application.
## License
Copyright © 2026 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
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.