inteligr8/alfresco-sdk
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-sdk.git synced 2025-06-02 17:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Archetypes - Update README files

Browse Source 
Update the README files of the archetypes with the new approach of the
Alfresco SDK.
This commit is contained in:
Jose Luis Osorno 2018-12-20 15:39:54 +01:00
parent 6cd3e0c0c2
commit 4c2ac6db7d
4 changed files with 84 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/README.md
View File

@ -2,30 +2,43 @@
This is an All-In-One (AIO) project for Alfresco SDK 4.0. This is an All-In-One (AIO) project for Alfresco SDK 4.0.
Run with `mvn clean install -DskipTests=true alfresco:run` or `./run.sh` and verify that it Run with `./run.sh build_start` or `./run.bat build_start` and verify that it
* Runs the embedded Tomcat + H2 DB * Runs Alfresco Content Service (ACS)
* Runs Alfresco Platform (Repository)
* Runs Alfresco Solr4
* Runs Alfresco Share * Runs Alfresco Share
* Packages both as JAR and AMP assembly for modules * Runs Alfresco Search Service (ASS)
* Runs PostgreSQL database
* Deploys the JAR assembled modules
All the services of the project are now run as docker containers. The run script offers the next tasks:
* `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).
# Few things to notice # Few things to notice
* No parent pom * No parent pom
* No WAR projects, all handled by the Alfresco Maven Plugin * No WAR projects, the jars are included in the custom docker images
* No runner project - it's all in the Alfresco Maven Plugin * No runner project - the Alfresco environment is now managed through [Docker](https://www.docker.com/)
* Standard JAR packaging and layout * Standard JAR packaging and layout
* Works seamlessly with Eclipse and IntelliJ IDEA * Works seamlessly with Eclipse and IntelliJ IDEA
* JRebel for hot reloading, JRebel maven plugin for generating rebel.xml, agent usage: `MAVEN_OPTS=-Xms256m -Xmx1G -agentpath:/home/martin/apps/jrebel/lib/libjrebel64.so` * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml [JRebel integration documentation]
* AMP as an assembly * AMP as an assembly
* [Configurable Run mojo](https://github.com/Alfresco/alfresco-sdk/blob/sdk-3.0/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RunMojo.java) in the `alfresco-maven-plugin` * Persistent test data through restart thanks to the use of Docker volumes for ACS, ASS and database data
* No unit testing/functional tests just yet * Integration tests module to execute tests against the final environment (dockerised)
* Resources loaded from META-INF * Resources loaded from META-INF
* Web Fragment (this includes a sample servlet configured via web fragment) * Web Fragment (this includes a sample servlet configured via web fragment)
# TODO # TODO
* Abstract assembly into a dependency so we don't have to ship the assembly in the archetype * Abstract assembly into a dependency so we don't have to ship the assembly in the archetype
* Purge
* Functional/remote unit tests * Functional/remote unit tests

48
archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/README.md
View File

@ -1,34 +1,42 @@
# Alfresco Platform JAR Module - SDK 3 # Alfresco ACS JAR Module - SDK 4.0
To run use `mvn clean install -DskipTests=true alfresco:run` or `./run.sh` and verify that it This is an ACS project for Alfresco SDK 4.0.
* Runs the embedded Tomcat Run with `./run.sh build_start` or `./run.bat build_start` and verify that it
* Runs Alfresco Platform (Repository)
* Packages both as JAR and AMP assembly * Runs Alfresco Content Service (ACS)
* (Optional) Runs Alfresco Share
Try cloning it, change the port and play with `enableShare` and `enablePlatform`. * Runs Alfresco Search Service (ASS)
* Runs PostgreSQL database
Protip: This module will work just fine as a Share module if the files are changed and * Deploys the JAR assembled module
if the enablePlatform and enableSolr is disabled.
All the services of the project are now run as docker containers. The run script offers the next tasks:
* `build_start`. Build the whole project, recreate the ACS docker image, start the dockerised environment composed by ACS, Share (optional), 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_acs`. Build the ACS module, recreate the ACS docker image and restart the ACS container.
* `build_test`. Build the whole project, recreate the ACS docker image, start the dockerised environment, execute the integration tests and stop
the environment.
* `test`. Execute the integration tests (the environment must be already started).
# Few things to notice # Few things to notice
* No parent pom * No parent pom
* WAR assembly is handled by the Alfresco Maven Plugin configuration * No WAR projects, the jars are included in the custom docker images
* No runner project - the Alfresco environment is now managed through [Docker](https://www.docker.com/)
* Standard JAR packaging and layout * Standard JAR packaging and layout
* Works seamlessly with Eclipse and IntelliJ IDEA * Works seamlessly with Eclipse and IntelliJ IDEA
* JRebel for hot reloading, JRebel maven plugin for generating rebel.xml, agent usage: `MAVEN_OPTS=-Xms256m -Xmx1G -agentpath:/home/martin/apps/jrebel/lib/libjrebel64.so` * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml [JRebel integration documentation]
* AMP as an assembly * AMP as an assembly
* [Configurable Run mojo](https://github.com/Alfresco/alfresco-sdk/blob/sdk-3.0/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RunMojo.java) in the `alfresco-maven-plugin` * Persistent test data through restart thanks to the use of Docker volumes for ACS, ASS and database data
* No unit testing/functional tests just yet
* Resources loaded from META-INF * Resources loaded from META-INF
* Web Fragment (this includes a sample servlet configured via web fragment) * Web Fragment (this includes a sample servlet configured via web fragment)
# TODO # TODO
* Abstract assembly into a dependency so we don't have to ship the assembly in the archetype * Abstract assembly into a dependency so we don't have to ship the assembly in the archetype
* Purge,
* Functional/remote unit tests * Functional/remote unit tests

36
archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/README.md
View File

@ -1,29 +1,43 @@
# Alfresco Share JAR Module - SDK 4.0 # Alfresco Share JAR Module - SDK 4.0
To run this module use `mvn clean install -DskipTests=true alfresco:run` or `./run.sh` and verify that it This is a Share project for Alfresco SDK 4.0.
* Runs the embedded Tomcat + H2 DB Run with `./run.sh build_start` or `./run.bat build_start` and verify that it
* Runs Alfresco Content Service (ACS)
* Runs Alfresco Share * Runs Alfresco Share
* Packages both as JAR and AMP assembly * Runs Alfresco Search Service (ASS)
* Runs PostgreSQL database
* Deploys the JAR assembled module
All the services of the project are now run as docker containers. The run script offers the next tasks:
Note. You access Share as follows: http://localhost:8081/share * `build_start`. Build the whole project, recreate the Share docker image, start the dockerised environment composed by ACS, Share, ASS and
PostgreSQL and tail the logs of all the containers.
Note. You need an Alfresco Platform instance running at http://localhost:8080/alfresco that Share can talk to. * `start`. Start the dockerised environment without building the project and tail the logs of all the containers.
Typically you will just kick off a platform-jar module for that. * `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 Share docker image, 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).
# Few things to notice # Few things to notice
* No parent pom * No parent pom
* WAR assembly is handled by the Alfresco Maven Plugin configuration, if needed * No WAR projects, the jars are included in the custom docker images
* No runner project - the Alfresco environment is now managed through [Docker](https://www.docker.com/)
* Standard JAR packaging and layout * Standard JAR packaging and layout
* Works seamlessly with Eclipse and IntelliJ IDEA * Works seamlessly with Eclipse and IntelliJ IDEA
* JRebel for hot reloading, JRebel maven plugin for generating rebel.xml, agent usage: `MAVEN_OPTS=-Xms256m -Xmx1G -agentpath:/home/martin/apps/jrebel/lib/libjrebel64.so` * JRebel for hot reloading, JRebel maven plugin for generating rebel.xml [JRebel integration documentation]
* AMP as an assembly * AMP as an assembly
* [Configurable Run mojo](https://github.com/Alfresco/alfresco-sdk/blob/sdk-3.0/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RunMojo.java) in the `alfresco-maven-plugin` * Persistent test data through restart thanks to the use of Docker volumes for ACS, ASS and database data
* No unit testing/functional tests just yet
* Resources loaded from META-INF * Resources loaded from META-INF
* Web Fragment (this includes a sample servlet configured via web fragment) * Web Fragment (this includes a sample servlet configured via web fragment)
# TODO # TODO
* Abstract assembly into a dependency so we don't have to ship the assembly in the archetype * Abstract assembly into a dependency so we don't have to ship the assembly in the archetype
* Functional/remote unit tests

7
pom.xml
View File

@ -103,6 +103,13 @@
<timezone>-5</timezone> <timezone>-5</timezone>
<url>http://rgauss.com/</url> <url>http://rgauss.com/</url>
</contributor> </contributor>
<contributor>
<name>Jose Luis Osorno Gil</name>
<email>joseluis.osorno@ixxus.com</email>
<organization>Ixxus</organization>
<organizationUrl>http://www.ixxus.com</organizationUrl>
<timezone>+1</timezone>
</contributor>
</contributors> </contributors>
<!-- All the modules of the Alfresco SDK --> <!-- All the modules of the Alfresco SDK -->