Please see Observation module documentation for Magnolia 4.5 while we update this page for Magnolia 5.
The Observation module is bundled with Magnolia CMS and typically already installed. You can download it from our Nexus repository
Observation is a Community Edition module. It is typically already installed. Launch the Configuration app and go to
/modules/observation to check.
Take a backup of your system before you install a module. Uninstalling a module is not as simple as removing the .jar file. Modules add and change configuration and may change content. Try new modules in a test environment first. A module consist of a JAR file and may include dependent JAR files. Modules are responsible for updating their own content and configuration across versions. Be sure to keep only one version of each module and its dependencies.
To install a module:
- Stop the application server.
- Copy the module JAR files into the
WEB-INF/libdirectory. The location of this directory depends on the application server.
- Restart the server.
- Go to the AdminCentral URL.
- Start the Web update process.
- Click Start up Magnolia.
Repeat the steps for each author and public instance.
To uninstall a module, remove the module JAR file from the
/WEB-INF/lib folder and restart Magnolia CMS.
However, this is rarely enough. Modules add and modify configuration during installation. The use of a module also changes content. Removing all of these changes is difficult without knowing the installation tasks in detail. To test a module, use the embedded Derby database and take a backup of your
repositories folder. Install the module and try it. When you are done testing, remove the module JAR and restore the
repositories folder from the backup. This way you can go back to square one. We also recommend that you segregate the development and production environments. Take regular backups for disaster recovery so you can revert to a prior state in a routine fashion.