2.2 KiB
Working with generated projects
After generating your project, using one of the Alfresco SDK 4.0 Maven archetypes, it is important to know how to build/run/test these projects.
The Alfresco Platform 6 deployment architecture is highly based on container technologies, specifically in Docker. Due to that, the projects generated using the Alfresco SDK 4.0 archetypes set up their local environment making an intensive use of Docker and Docker compose technologies.
If you're not familiar to these technologies, it is highly recommended visiting the Docker documentation website. This site offers a great quantity of training resources about Docker and Docker compose.
Run script
All the projects generated using the Alfresco SDK 4.0 archetypes provide an utility script to work with the project. This script is run.sh for Unix systems
and run.bat for Windows systems.
The execution of this script must be followed by a parameter that dictates the task to be executed in the project. The list of available tasks is:
| Task | Description |
|---|---|
build_start |
Build the whole project, recreate the ACS and Share docker images, start the dockerised environment composed by ACS, Share, ASS and PostgreSQL and tail the logs of all the containers. |
start |
Start the dockerised environment without building the project and tail the logs of all the containers. |
stop |
Stop the dockerised environment. |
purge |
Stop the dockerised container and delete all the persistent data (docker volumes). |
tail |
Tail the logs of all the containers. |
reload_share |
Build the Share module, recreate the Share docker image and restart the Share container. |
reload_acs |
Build the ACS module, recreate the ACS docker image and restart the ACS container. |
build_test |
Build the whole project, recreate the ACS and Share docker images, start the dockerised environment, execute the integration tests from the integration-tests module and stop the environment. |
test |
Execute the integration tests (the environment must be already started). |