DockerStartPlugin

A plugin for Magnolia CLI to start Magnolia using Docker and logs from services.

Installation

Using add-plugin

1. Run the following command in the project's root directory:

   npm run mgnl -- add-plugin @magnolia/cli-docker-start-plugin

   The command will install the plugin, and automatically register the plugin in mgnl.config.js file:

   import DockerStartPlugin from "@magnolia/cli-docker-start-plugin";
   
   export default {
     plugins: [
       new DockerStartPlugin()
     ]
   };

2. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- docker-start --help

Manually

1. Run the following command in the project's root directory:

   npm install @magnolia/cli-docker-start-plugin

2. Manually add DockerStartPlugin to mgnl.config.js file:

   import DockerStartPlugin from "@magnolia/cli-docker-start-plugin";
   
   export default {
     plugins: [
       new DockerStartPlugin()
     ]
   };

3. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- docker-start --help

Usage

Options

| Short | Long | Description | |---------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------| | -r | --regenerate | regenerate the docker-compose.yml file if it already exists | | -t [path] | --tomcat [path] | set the path to the "apache-tomcat" directory or the directory containing it; defaults to the current working directory | | -lmp [path] | --light-modules-path [path] | set the path to the light modules directory; defaults to the value in mgnl.config.js or prompts if not set | | -v | --version | output the version number | | -h | --help | display help for command |

Examples

Start Magnolia with Docker

npm run mgnl -- docker-start

This command checks for Docker and Docker Compose, generates a docker-compose.yml if needed (using Tomcat and light modules paths), starts the services in detached mode, watches for changes, and follows logs with colored output for each service.

Regenerate docker-compose and start

npm run mgnl -- docker-start --regenerate

This command forces regeneration of the docker-compose.yml file before starting the Docker services, useful if paths have changed.

Start with custom Tomcat and light modules paths

npm run mgnl -- docker-start --tomcat "./magnolia/apache-tomcat" --light-modules-path "./magnolia/light-modules"

This command starts Docker using the specified Tomcat directory and light modules path, generating or using docker-compose.yml accordingly, and displays colored service logs.

Plugin Documentation

For detailed documentation of the plugin, please refer to Plugin Documentation

Magnolia CMS

This plugin is created to work with Magnolia CMS. For more information, please refer to Magnolia CMS Documentation