bitnami/moodle repository overview

⁠Bitnami LMS powered by Moodle™ LMS

⁠What is Bitnami LMS powered by Moodle™ LMS?

Overview of Bitnami LMS powered by Moodle™ LMS⁠ Disclaimer: The respective trademarks mentioned in the offering are owned by the respective companies. We do not provide commercial license of any of these products. This listing has an open source license. Moodle(TM) LMS is run and maintained by Moodle HQ, that is a completely and separate project from Bitnami.

⁠TL;DR

docker run --name moodle bitnami/moodle: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⁠ 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⁠. 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 internet’s favorite Helm charts

Each image comes with valuable security metadata. You can view the metadata in our public catalog here⁠. Note: Some data is only available with commercial subscriptions to BSI⁠.

If you are looking for our previous generation of images based on Debian Linux, please see the Bitnami Legacy registry⁠.

⁠How to deploy Moodle™ 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 Chart for Moodle™ GitHub repository⁠.

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

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 Docker Image for Moodle™ is to pull the prebuilt image from the Docker Hub Registry⁠.

docker pull bitnami/moodle: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/moodle:[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

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

⁠Using the Docker Command Line

⁠Step 1: Create a network

docker network create moodle-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_moodle \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_moodle \
  --network moodle-network \
  --volume mariadb_data:/bitnami/mariadb \
  bitnami/mariadb:latest

⁠Step 3: Create volumes for Moodle™ persistence and launch the container

$ docker volume create --name moodle_data
docker run -d --name moodle \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MOODLE_DATABASE_USER=bn_moodle \
  --env MOODLE_DATABASE_PASSWORD=bitnami \
  --env MOODLE_DATABASE_NAME=bitnami_moodle \
  --network moodle-network \
  --volume moodle_data:/bitnami/moodle \
  --volume moodledata_data:/bitnami/moodledata \
  bitnami/moodle:latest

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

⁠Run the application using Docker Compose

curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/moodle/docker-compose.yml > docker-compose.yml
docker-compose up -d

Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart⁠.

If you detect any issue in the docker-compose.yaml file, feel free to report it or contribute with a fix by following our Contributing Guidelines⁠.

⁠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/moodle path and another at /bitnami/moodledata. 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⁠.

The above examples define the Docker volumes named mariadb_data, moodle_data and moodledata_data. The Moodle™ 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
   ...
   moodle:
     ...
     volumes:
-      - moodle_data:/bitnami/moodle
+      - /path/to/moodle-persistence:/bitnami/moodle
-      - moodledata_data:/bitnami/moodledata
+      - /path/to/moodledata-persistence:/bitnami/moodle
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  moodle_data:
-    driver: local

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

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

docker network create moodle-network

⁠Step 2. Create a MariaDB container with host volume

docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_moodle \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_moodle \
  --network moodle-network \
  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest

⁠Step 3. Create the Moodle™ container with host volumes

docker run -d --name moodle \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MOODLE_DATABASE_USER=bn_moodle \
  --env MOODLE_DATABASE_PASSWORD=bitnami \
  --env MOODLE_DATABASE_NAME=bitnami_moodle \
  --network moodle-network \
  --volume /path/to/moodle-persistence:/bitnami/moodle \
  --volume /path/to/moodledata-persistence:/bitnami/moodledata \
  bitnami/moodle:latest

⁠Configuration

⁠Environment variables

⁠Customizable environment variables

⁠Read-only environment variables

When you start the Moodle™ 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:

moodle:
  ...
  environment:
    - MOODLE_PASSWORD=my_password
  ...

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

  docker run -d --name moodle -p 80:8080 -p 443:8443 \
    --env MOODLE_PASSWORD=my_password \
    --network moodle-tier \
    --volume /path/to/moodle-persistence:/bitnami/moodle \
    --volume /path/to/moodledata-persistence:/bitnami/moodledata \
    bitnami/moodle:latest
  

  Copy

⁠Examples

This would be an example of SMTP configuration using a Gmail account:

• Modify the docker-compose.yml⁠ file present in this repository:

  moodle:
    ...
    environment:
      - MOODLE_DATABASE_USER=bn_moodle
      - MOODLE_DATABASE_NAME=bitnami_moodle
      - ALLOW_EMPTY_PASSWORD=yes
      - MOODLE_SMTP_HOST=smtp.gmail.com
      - MOODLE_SMTP_PORT=587
      - [email protected]
      - MOODLE_SMTP_PASSWORD=your_password
      - MOODLE_SMTP_PROTOCOL=tls
  ...
  

  Copy

• For manual execution:

  docker run -d --name moodle -p 80:8080 -p 443:8443 \
    --env MOODLE_DATABASE_USER=bn_moodle \
    --env MOODLE_DATABASE_NAME=bitnami_moodle \
    --env MOODLE_SMTP_HOST=smtp.gmail.com \
    --env MOODLE_SMTP_PORT=587 \
    --env [email protected] \
    --env MOODLE_SMTP_PASSWORD=your_password \
    --env MOODLE_SMTP_PROTOCOL=tls \
    --network moodle-tier \
    --volume /path/to/moodle-persistence:/bitnami/moodle \
    --volume /path/to/moodledata-persistence:/bitnami/moodledata \
    bitnami/moodle:latest
  

  Copy

This would be an instance ready to be put behind the NGINX load balancer.

• Modify the docker-compose.yml⁠ file present in this repository:

  moodle:
    ...
    environment:
      - MOODLE_HOST=example.com
      - MOODLE_REVERSEPROXY=true
      - MOODLE_SSLPROXY=true
  ...
  

  Copy

• For manual execution:

  docker run -d --name moodle -p 80:8080 -p 443:8443 \
    --env MOODLE_HOST=example.com \
    --env MOODLE_REVERSEPROXY=true \
    --env MOODLE_SSLPROXY=true \
    --network moodle-tier \
    --volume /path/to/moodle-persistence:/bitnami/moodle \
    --volume /path/to/moodledata-persistence:/bitnami/moodledata \
    bitnami/moodle:latest
  

  Copy

⁠Installing additional language packs

By default, this container packs a generic English version of Moodle™. 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. To do that, you have several options:

⁠Build the default image with the EXTRA_LOCALES build-time variable

You can add extra locales using the EXTRA_LOCALES build-time variable when building the Docker image. The values must be separated by commas or semicolons (and optional spaces), and refer to entries in the /usr/share/i18n/SUPPORTED file inside the container.

For example, the following value would add French, German, Italian and Spanish, you would specify the following value in EXTRA_LOCALES:

fr_FR.UTF-8 UTF-8, de_DE.UTF-8 UTF-8, it_IT.UTF-8 UTF-8, es_ES.UTF-8 UTF-8

To use EXTRA_LOCALES, you have two options:

• Modify the docker-compose.yml⁠ file present in this repository:

  moodle:
  ...
    # image: bitnami/moodle:latest # remove this line !
    build:
      context: .
      dockerfile: Dockerfile
      args:
        - EXTRA_LOCALES=fr_FR.UTF-8 UTF-8, de_DE.UTF-8 UTF-8, it_IT.UTF-8 UTF-8, es_ES.UTF-8 UTF-8
  ...
  

  Copy

• For manual execution, clone the repository and run the following command inside the X/debian-12 directory:

  docker build -t bitnami/moodle:latest --build-arg EXTRA_LOCALES="fr_FR.UTF-8 UTF-8, de_DE.UTF-8 UTF-8, it_IT.UTF-8 UTF-8, es_ES.UTF-8 UTF-8" .
  

  Copy

⁠Enable all supported locales using the WITH_ALL_LOCALES build-time variable

You can generate all supported locales by setting the build environment variable WITH_ALL_LOCALES=yes. Note that the generation of all the locales takes some time.

To use WITH_ALL_LOCALES, you have two options:

• Modify the docker-compose.yml⁠ file present in this repository:

  moodle:
  ...
    # image: bitnami/moodle:latest # remove this line !
    build:
      context: .
      dockerfile: Dockerfile
      args:
        - WITH_ALL_LOCALES=yes
  ...
  

  Copy

• For manual execution, clone the repository and run the following command inside the X/debian-12 directory:

  docker build -t bitnami/moodle:latest --build-arg WITH_ALL_LOCALES=yes .
  

  Copy

⁠Extending the default image

Finally, you can extend⁠ the default image and adding as many locales as needed:

FROM bitnami/moodle
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.

⁠FIPS configuration in Bitnami Secure Images

The Bitnami Bitnami LMS powered by Moodle™ LMS Docker image from the Bitnami Secure Images⁠ 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 Docker image for Moodle™ sends the container logs to stdout. To view the logs:

docker logs moodle

Or using Docker Compose:

docker-compose logs moodle

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.

By default, the logging of debug information is disabled. You can enable it by setting the environment variable BITNAMI_DEBUG to true.

⁠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 moodle

Or using Docker Compose:

docker-compose stop moodle

⁠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/moodle-backups:/backups --volumes-from moodle busybox \
  cp -a /bitnami/moodle /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 Moodle™ container:

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

⁠Upgrade this image

Bitnami provides up-to-date versions of MariaDB and Moodle™, 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 Moodle™ container. For the MariaDB upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image⁠

Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/containers/blob/main/bitnami/moodle/README.md⁠