| 1 |
Running locally |
| 2 |
=============== |
| 3 |
|
| 4 |
This project uses the Maven Cargo plugin to run the CMS and site locally in Tomcat. |
| 5 |
From the project root folder, execute: |
| 6 |
|
| 7 |
$ mvn clean install |
| 8 |
$ mvn -P cargo.run |
| 9 |
|
| 10 |
Access the CMS at http://localhost:8080/cms, and the site at http://localhost:8080/site |
| 11 |
Logs are located in target/tomcat7x/logs |
| 12 |
|
| 13 |
Building distribution |
| 14 |
===================== |
| 15 |
|
| 16 |
To build a Tomcat distribution tarball containing only deployable artifacts: |
| 17 |
|
| 18 |
$ mvn clean install |
| 19 |
$ mvn -P dist |
| 20 |
|
| 21 |
See also src/main/assembly/distribution.xml if you need to customize the distribution. |
| 22 |
|
| 23 |
Using JRebel |
| 24 |
============ |
| 25 |
|
| 26 |
Set the environment variable REBEL_HOME to the directory containing jrebel.jar. |
| 27 |
|
| 28 |
Build with: |
| 29 |
|
| 30 |
$ mvn clean install -Djrebel |
| 31 |
|
| 32 |
Start with: |
| 33 |
|
| 34 |
$ mvn -P cargo.run -Djrebel |
| 35 |
|
| 36 |
Best Practice for development |
| 37 |
============================= |
| 38 |
|
| 39 |
Use the option -Drepo.path=/some/path/to/repository during start up. This will avoid |
| 40 |
your repository to be cleared when you do a mvn clean. |
| 41 |
|
| 42 |
For example start your project with: |
| 43 |
|
| 44 |
$ mvn -P cargo.run -Drepo.path=/home/usr/tmp/repo |
| 45 |
|
| 46 |
or with jrebel: |
| 47 |
|
| 48 |
$ mvn -P cargo.run -Drepo.path=/home/usr/tmp/repo -Djrebel |
| 49 |
|
| 50 |
Hot deploy |
| 51 |
========== |
| 52 |
|
| 53 |
To hot deploy, redeploy or undeploy the CMS or site: |
| 54 |
|
| 55 |
$ cd cms (or site) |
| 56 |
$ mvn cargo:redeploy (or cargo:undeploy, or cargo:deploy) |
| 57 |
|
| 58 |
Automatic Export |
| 59 |
================ |
| 60 |
|
| 61 |
To have your repository changes automatically exported to filesystem during local development, log into |
| 62 |
http://localhost:8080/cms/console and press the "Enable Auto Export" button at the top right. To set this |
| 63 |
as the default for your project edit the file |
| 64 |
./bootstrap/configuration/src/main/resources/configuration/modules/autoexport-module.xml |
| 65 |
|
| 66 |
Monitoring with JMX Console |
| 67 |
=========================== |
| 68 |
You may run the following command: |
| 69 |
|
| 70 |
$ jconsole |
| 71 |
|
| 72 |
Now open the local process org.apache.catalina.startup.Bootstrap start |