Skip to content

maxkratz/bitnami-docker-moodle

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bitnami Docker Image for MoodleTM LMS

What is MoodleTM?

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. MoodleTM LMS is run and maintained by Moodle HQ, that is a completely and separate project from Bitnami.

Moodle(TM) is a very popular open source learning management solution (LMS) for the delivery of elearning courses and programs. It’s used not only by universities, but also by hundreds of corporations around the world who provide eLearning education for their employees. Moodle(TM) features a simple interface, drag-and-drop features, role-based permissions, deep reporting, many language translations, a well-documented API and more. With some of the biggest universities and organizations already using it, Moodle(TM) is ready to meet the needs of just about any size organization.

https://moodle.org/

TL;DR

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

You can find the default credentials and available configuration options in the Environment Variables section.

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 which gives you a small base container image and the familiarity of a leading Linux distribution.
  • 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 daily with the latest distribution packages available.

This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.

How to deploy MoodleTM 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 MoodleTM 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.

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.

Subscribe to project updates by watching the bitnami/moodle GitHub repo.

Get this image

The recommended way to get the Bitnami Docker Image for MoodleTM 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.

$ docker build -t bitnami/moodle:latest 'https://github.com/bitnami/bitnami-docker-moodle.git#master:3/debian-10'

How to use this image

MoodleTM 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/bitnami-docker-moodle/master/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 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 MoodleTM 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 \
  bitnami/moodle: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/moodle 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/bitnami-docker-mariadb#persisting-your-database).

The above examples define the Docker volumes named mariadb_data and moodle_data. The MoodleTM 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
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  moodle_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 moodle-network

Step 2. Create a MariaDB container with host volume

$ 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 /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3. Create the MoodleTM the container with host volumes

$ 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 /path/to/moodle-persistence:/bitnami/moodle \
  bitnami/moodle:latest

Configuration

Environment variables

When you start the MoodleTM 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 \
  bitnami/moodle:latest

Available environment variables:

User and Site configuration
  • MOODLE_USERNAME: Moodle application username. Default: user
  • MOODLE_PASSWORD: Moodle application password. Default: bitnami
  • MOODLE_EMAIL: Moodle application email. Default: user@example.com
  • MOODLE_SITE_NAME: Moodle site name. Default: New Site
  • MOODLE_SKIP_BOOTSTRAP: Do not initialize the Moodle database for a new deployment. This is necessary in case you use a database that already has Moodle data. Default: no
Use an existing database
  • MOODLE_DATABASE_TYPE: Database type. Valid values: mariadb, mysqli. Default: mariadb
  • MOODLE_DATABASE_HOST: Hostname for database server. Default: mariadb
  • MOODLE_DATABASE_PORT_NUMBER: Port used by database server. Default: 3306
  • MOODLE_DATABASE_NAME: Database name that Moodle will use to connect with the database. Default: bitnami_moodle
  • MOODLE_DATABASE_USER: Database user that Moodle will use to connect with the database. Default: bn_moodle
  • MOODLE_DATABASE_PASSWORD: Database password that Moodle 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 Moodle using mysql-client
  • 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.
  • ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no
SMTP Configuration

To configure MoodleTM to send email using SMTP you can set the following environment variables:

  • MOODLE_SMTP_HOST: SMTP host.
  • MOODLE_SMTP_PORT: SMTP port.
  • MOODLE_SMTP_USER: SMTP account user.
  • MOODLE_SMTP_PASSWORD: SMTP account password.
  • MOODLE_SMTP_PROTOCOL: SMTP protocol.
PHP configuration
  • 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_EXPOSE_PHP: Enables HTTP header with PHP version. Default: yes
Example

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

  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
      - MOODLE_SMTP_USER=your_email@gmail.com
      - MOODLE_SMTP_PASSWORD=your_password
      - MOODLE_SMTP_PROTOCOL=tls
  ...
  • 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 MOODLE_SMTP_USER=your_email@gmail.com \
  --env MOODLE_SMTP_PASSWORD=your_password \
  --env MOODLE_SMTP_PROTOCOL=tls \
  --network moodle-tier \
  --volume /path/to/moodle-persistence:/bitnami \
  bitnami/moodle:latest

Installing additional language packs

By default, this container packs a generic English version of MoodleTM. Nevertheless, more Langage 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

NOTE: The locales en_AU.UTF-8 UTF-8 and en_US.UTF-8 UTF-8 will always be packaged, defaulting to en_US.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:3' # 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"
    ...
  • For manual execution, clone the repository and run the following command inside the 3/debian-10 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" .

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:3' # remove this line !
      build:
        context: .
        dockerfile: Dockerfile
        args:
          - WITH_ALL_LOCALES=yes
    ...
  • For manual execution, clone the repository and run the following command inside the 3/debian-10 directory:

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

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.

Logging

The Bitnami Docker image for MoodleTM 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.

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 MoodleTM container:

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

Upgrade this image

NOTE: Since Moodle(TM) 3.4.0-r1, the 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 Moodle(TM) 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 MoodleTM, 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 MoodleTM container. For the MariaDB upgrade see: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

Step 1: Get the updated image

$ docker pull bitnami/moodle:latest

Step 2: Stop the running container

Stop the currently running container using the command

$ docker-compose stop moodle

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 moodle

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 Docker image for MoodleTM 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/moodle
## 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/moodle
LABEL maintainer "Bitnami <containers@bitnami.com>"

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

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

Notable Changes

3.9.0-debian-10-r17

  • The size of the container image has been decreased.
  • The configuration logic is now based on Bash scripts in the rootfs/ folder.
  • The MoodleTM 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 MoodleTM site by exporting its content, and importing it on a new MoodleTM container. Follow the steps in Backing up your container and Restoring a backup to migrate the data between the old and new container.

3.7.1-debian-9-r38 and 3.7.1-ol-7-r40

  • It is now possible to use existing MoodleTM databases from other installations, as requested in #95. In order to do this, use the environment variable MOODLE_SKIP_INSTALL, which forces the container not to run the initial MoodleTM setup wizard.

3.7.0-debian-9-r12 and 3.7.0-ol-7-r13

  • 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 submit 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 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)

License

Copyright (c) 2020 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

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.