bitnami-containers/bitnami/joomla
Bitnami Bot febb0ef20f
[bitnami/joomla] Release 5.0.1-debian-11-r1 (#53553)
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
2023-12-07 13:46:18 +01:00
..
5/debian-11 [bitnami/joomla] Release 5.0.1-debian-11-r1 (#53553) 2023-12-07 13:46:18 +01:00
README.md
docker-compose.yml

README.md

Bitnami package for Joomla!

What is Joomla!?

Joomla! is an award winning open source CMS platform for building websites and applications. It includes page caching, page compression and Let's Encrypt auto-configuration support.

Overview of Joomla! 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

Docker Compose

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 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 -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). 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 Joomla! in production? Try VMware Tanzu Application Catalog, the enterprise edition of Bitnami Application Catalog.

How to deploy Joomla! 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 Joomla! Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

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.

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

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.

Get this image

The recommended way to get the Bitnami Joomla! Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/joomla:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

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.

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

Joomla! requires access to a MySQL or MariaDB database to store information. We'll use the Bitnami Docker Image for MariaDB for the database requirements.

Run the application using Docker Compose

The main folder of this repository contains a functional docker-compose.yml file. Run the application using it as shown below:

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

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

Step 1: Create a network
docker network create joomla-network
Step 2: Create a volume for MariaDB persistence and create a MariaDB container
$ 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 \
  --env MARIADB_DATABASE=bitnami_joomla \
  --network joomla-network \
  --volume mariadb_data:/bitnami/mariadb \
  bitnami/mariadb:latest
Step 3: Create volumes for Joomla! persistence and launch the container
$ 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 \
  --env JOOMLA_DATABASE_PASSWORD=bitnami \
  --env JOOMLA_DATABASE_NAME=bitnami_joomla \
  --network joomla-network \
  --volume joomla_data:/bitnami/joomla \
  bitnami/joomla:latest

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

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/joomla 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 joomla_data. The Joomla! 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 file present in this repository:

   mariadb:
     ...
     volumes:
-      - 'mariadb_data:/bitnami/mariadb'
+      - /path/to/mariadb-persistence:/bitnami/mariadb
   ...
   joomla:
     ...
     volumes:
-      - 'joomla_data:/bitnami/joomla'
+      - /path/to/joomla-persistence:/bitnami/joomla
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  joomla_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)
docker network create joomla-network
Step 2. Create a MariaDB container with host volume
docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_joomla \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_joomla \
  --network joomla-network \
  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest
Step 3. Create the Joomla! container with host volumes
docker run -d --name joomla \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env JOOMLA_DATABASE_USER=bn_joomla \
  --env JOOMLA_DATABASE_PASSWORD=bitnami \
  --env JOOMLA_DATABASE_NAME=bitnami_joomla \
  --network joomla-network \
  --volume /path/to/joomla-persistence:/bitnami/joomla \
  bitnami/joomla:latest

Configuration

Environment variables

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 file present in this repository:
joomla:
  ...
  environment:
    - JOOMLA_PASSWORD=my_password
  ...
  • For manual execution add a --env option with each variable and value:

    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 \
      bitnami/joomla:latest
    

Available environment variables:

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

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

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

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.

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:

  joomla:
    ...
    environment:
      - JOOMLA_DATABASE_USER=bn_joomla
      - JOOMLA_DATABASE_NAME=bitnami_joomla
      - ALLOW_EMPTY_PASSWORD=yes
      - JOOMLA_SMTP_HOST=smtp.gmail.com
      - JOOMLA_SMTP_PORT=587
      - JOOMLA_SMTP_USER=your_email@gmail.com
      - JOOMLA_SMTP_PASSWORD=your_password
      - JOOMLA_SMTP_PROTOCOL=tls
  ...
  • For manual execution:

    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 \
      --env JOOMLA_SMTP_PORT=587 \
      --env JOOMLA_SMTP_USER=your_email@gmail.com \
      --env JOOMLA_SMTP_PASSWORD=your_password \
      --env JOOMLA_SMTP_PROTOCOL=tls \
      --network joomla-tier \
      --volume /path/to/joomla-persistence:/bitnami \
      bitnami/joomla:latest
    

Installing additional language packs

By default, this container packs a generic English version of Joomla!. Nevertheless, more Language Packs can be added to the default configuration using the in-platform Administration interface. In order to fully support a new Language Pack it is also a requirement to update the system's locales files. We highly recommend extending the default image and adding as many locales as needed: +Stop the currently running container using the command

FROM bitnami/joomla
RUN echo "es_ES.UTF-8 UTF-8" >> /etc/locale.gen && locale-gen

Bear in mind that in the example above es_ES.UTF-8 UTF-8 is the locale needed for the desired Language Pack to install. You may change this value to the locale corresponding to your pack.

Logging

The Bitnami Joomla! Docker image sends the container logs to stdout. To view the logs:

docker logs joomla

Or using Docker Compose:

docker-compose logs joomla

You can configure the containers logging driver 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
docker stop joomla

Or using Docker Compose:

docker-compose stop joomla
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.

docker run --rm -v /path/to/joomla-backups:/backups --volumes-from joomla busybox \
  cp -a /bitnami/joomla /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:

 $ 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 Joomla! container:

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

Upgrade this image

NOTE: Application upgrades should be done manually inside the docker container following the official documentation. 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

Step 1: Get the updated image
docker pull bitnami/joomla:latest
Step 2: Stop the running container

Stop the currently running container using the command

docker-compose stop joomla
Step 3: Take a snapshot of the application state

Follow the steps in 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:

docker-compose rm -v joomla
Step 5: Run the new image

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

docker-compose up -d

Customize this image

The Bitnami Joomla! 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:

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:

FROM bitnami/joomla
### Put your customizations below
...

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
FROM bitnami/joomla

### Change user to perform privileged actions
USER 0
### Install 'vim'
RUN install_packages vim
### Revert to the original non-root user
USER 1001

### Enable mod_ratelimit module
RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf

### Modify the ports used by Apache by default
## It is also possible to change these environment variables at runtime
ENV APACHE_HTTP_PORT_NUMBER=8181
ENV APACHE_HTTPS_PORT_NUMBER=8143
EXPOSE 8181 8143

Based on the extended image, you can update the docker-compose.yml file present in this repository to add other features:

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

Notable Changes

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

We'd love for you to contribute to this container. You can request new features by creating an issue or submitting a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.

License

Copyright © 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.