docker-compose-moodle

Leer en Español

This project quickly builds a local workspace for Moodle (Nginx, PHP-FPM with XDEBUG y Postgres) using containers for each of its main components. The local workspace is built and managed by Docker Compose

Quickstart:

1. Install Docker. Check out how to install Docker
2. Install Docker Compose. Check out how to install Docker Compose
3. Download this repo: git clone https://github.com/jobcespedes/docker-compose-moodle.git && cd docker-compose-moodle
4. Clone Moodle repo: git clone --branch MOODLE_401_STABLE --depth 1 https://github.com/moodle/moodle html
5. Run with: docker-compose up -d

Contents

1. Environment Variables
2. Docker Compose Resources
3. Workspace Operations
4. Debugging with XDEBUG
5. Moodle Cron Debugging
6. Database management with Pgadmin4
7. Backup and restore database
8. Install Docker
9. Install Docker Compose

Environment variables

The following table describes environment variables set in .env. The defaults work for a initial setup. They can be modified if needed.

Docker Compose resources

The following table sums up Docker Compose resources.

Project management with Docker Compose

Inside project folder

1. Run project

   docker-compose up -d
   # Different project name
   # docker-compose -p my-proj up -d

2. Stop project

   docker-compose stop
   # docker-compose stop php-fpm

3. Start project

   docker-compose start
   # docker-compose start php-fpm

4. Remove project

   docker-compose down
   # Remove volumes too
   # docker-compose --volumes
   # With different project name:
   # docker-compose -p my-proj down

5. Logs

   docker-compose logs
   # docker-compose logs -f --tail="20" php-fpm

XDEBUG

Use idekey PHPTEST

PHPStorm

Debug config for IDE PHPStorm:

1. Add server:
   • Settings -> Languages -> PHP -> Servers
   • Name: localhost
   • Host: localhost
   • Port: 80
   • Debugger: Xdebug
   • Use path mapping: checked
   • Absolute path on the server: /var/www/html

2. Add PHP remote debug
   • Run / Debug Configurations -> PHP remote debug
   • Use server created in step #1 and set idekey PHPTEST

3. Enable Start listening for PHP Debug Connections

VSCode

Debug config for IDE VSCode here

Cron debugging

Follow previous steps, set a breakpoint and then run:

docker-compose exec php-fpm php admin/cli/cron.php

There is a scrip for Specific cron tasks. For example:

docker-compose exec php-fpm php admin/tool/task/cli/schedule_task.php --execute='\core\task\cache_cleanup_task'
# Listing tasks
# docker-compose exec php-fpm php admin/tool/task/cli/schedule_task.php --list

Pgadmin4

Config pgadmin4

1. Go to http://localhost:5050
2. In File -> Preferences -> Binary paths set /usr/bin
3. Add new server:
   • Tab General
     • Name: Any name you want
   • Tab Connection
     • Host name/address: postgres
     • Host Username: user
     • Host Password: password
   • Save

Backup and restore database

When needed, backup and restore of the database could be done in the following way.

# Set env vars
POSTGRES_USER=user
POSTGRES_DB=moodle
DB_DUMP_NAME=dump-init.$(date +"%Y%m%d%H%M%S").dump

# Backup
# -Fc  Output a custom-format archive suitable for input into pg_restore
docker-compose exec postgres pg_dump -U ${POSTGRES_USER} ${POSTGRES_DB} -Fc -f /opt/db_dumps/${DB_DUMP_NAME}

# Restore
# -c  Clean (drop) database objects before recreating them.
# -C  Create the database before restoring into it
docker-compose exec postgres pg_restore -U ${POSTGRES_USER} -d postgres -c -C -O --role ${POSTGRES_USER} /opt/db_dumps/${DB_DUMP_NAME}

A database can be automatically restored when postgres service starts. By placing a dump file inside 'db_dumps' folder and naming it "dump-init.dump", postgres container will try to restore that file as an initial database if data directory is empty.

IMPORTANT: Depending of size, database initial availability could be delayed

Español

Este es un repositorio para crear rápidamente un entorno de trabajo con Moodle (Nginx, PHP-FPM con XDEBUG y Postgres) usando contenedores para cada uno sus principales componentes. El entorno de trabajo se crea y gestiona con Docker Compose.

Pasos rápidos para crear proyecto:

1. Tener Docker. Ver como instalar Docker
2. Tener Docker Compose. Ver como instalar Docker Compose
3. Descargar este repo y acceder a él: git clone https://github.com/jobcespedes/docker-compose-moodle.git && cd docker-compose-moodle
4. Copiar repositorio de código de Moodle: git clone --branch MOODLE_401_STABLE --depth 1 https://github.com/moodle/moodle html
5. Desplegar con: docker-compose up -d

Variables de ambiente

La siguiente tabla contiene las variables utilizadas en el archivo .env para Docker Compose. Los valores por defecto funcionan para una configuración inicial. Cámbielos de ser necesario.

Estructura de Docker Compose

A continuación se incluye una tabla que resume la estructura del archivo de Docker Compose:

Gestión del proyecto con Docker Compose

Dentro de la carpeta del proyecto

1. Correr proyecto

   docker-compose up -d
   # Nombrar el proyecto diferente a la carpeta:
   # docker-compose -p mi-proy up -d

2. Detener el proyecto

   docker-compose stop
   # docker-compose stop php-fpm

3. Iniciar el proyecto

   docker-compose start
   # docker-compose start php-fpm

4. Eliminar proyecto

   docker-compose down
   # Eliminar los volumenes también:
   # docker-compose --volumes
   # Eliminar con un nombre de proyecto especifico:
   # docker-compose -p mi-proy down

5. Logs

   docker-compose logs
   # docker-compose logs -f --tail="20" php-fpm

XDEBUG

Se utiliza el idekey PHPTEST

PHPStorm

Configuración para depurar con IDE PHPStorm:

1. Agregar server:
   • Settings -> Languages -> PHP -> Servers
   • Name: localhost
   • Host: localhost
   • Port: 80
   • Debugger: Xdebug
   • Use path mapping: checked
   • Absolute path on the server: /var/www/html

2. Agregar PHP remote debug
   • Run / Debug Configurations -> PHP remote debug
   • Use server created in step #1 and set idekey PHPTEST

3. Activar botón Start listening for PHP Debug Connections

Depurar tareas de cron

Siga los pasos anteriores, establezca una interrupción y ejecuta en el la línea de comandos:

docker-compose exec php-fpm php admin/cli/cron.php

Se pueden ejecutar también tareas específicas de cronPor ejemplo:

docker-compose exec php-fpm php admin/tool/task/cli/schedule_task.php --execute='\core\task\cache_cleanup_task'
# Listar tareas
# docker-compose exec php-fpm php admin/tool/task/cli/schedule_task.php --list

Pgadmin4

Pasos para usar pgadmin4

1. Ingresar a http://localhost:5050
2. En File -> Preferences -> Binary paths establecer en /usr/bin
3. Agregar nuevo servidor:
   • Pestaña General
     • Name: Un nombre para el servidor
   • Pestaña Connection
     • Host name/address: postgres
     • Host Username: user
     • Host Password: password
   • Guardar

Respaldar y restaurar la base de datos

Es posible respaldar y restaurar la base de datos de la siguiente manera.

# Establecer vars de entorno
POSTGRES_USER=user
POSTGRES_DB=moodle
DB_DUMP_NAME=dump-init.$(date +"%Y%m%d%H%M%S").dump

# Respaldar
# -Fc  Formato personalizado para pg_restore
docker-compose exec postgres pg_dump -U ${POSTGRES_USER} ${POSTGRES_DB} -Fc -f /opt/db_dumps/${DB_DUMP_NAME}

# Restaurar
# -c  Limpia los objetos de la base de datos antes de recrearlos
# -C  Crea la base de datos antes de restaurarla
docker-compose exec postgres pg_restore -U ${POSTGRES_USER} -d postgres -c -C -O --role ${POSTGRES_USER} /opt/db_dumps/${DB_DUMP_NAME}

Se puede restaurar una base de datos, usando pg_dump (formato personalizado de Posgres), a la caperta 'db_dumps' y nombrando el archivo como dump-init.dump

IMPORTANTE: Dependiendo del tamaño, la ejecución de este sql podría demorar la disponibilidad inicial de la base de datos.