UI Framework module

 Create 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 configurations and may change the content. Try new modules in a test environment first. A module consists of a JAR file and may include dependent JAR files. Modules are responsible for updating their own content and configurations across versions. Be sure to keep only one version of each module and its dependencies.

To install a module:

1. Stop the application server.
2. Copy the module JAR files into the WEB-INF/lib directory. The location of this directory depends on the application server.
   
   • Tomcat: /webapps/magnoliaAuthor/WEB-INF/lib
   • JBoss: /server/default/deploy/magnoliaAuthor/WEB-INF/lib
3. Restart the server.
4. Go to the AdminCentral URL.
5. Start the Web update process.
6. 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.

 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.