You are here

All-in-One (AIO) archetype usage

The Share archetype has common usage patterns.

The All-in-One Alfresco project is composed by the following modules:

  • repo-amp: A Repository Tier AMP project, demonstrating sample project structure and demo component loading.
  • repo: An alfresco.war Repository Extension, overlaying the Alfresco WAR with custom resources / classes and depending on the amp project
  • share-amp: A Share Tier AMP project, demonstrating sample project structure and demo component loading.
  • share: A share.war extension, overlaying the Share WAR with the custom developed share-amp
  • solr: An Alfresco alfresco-*-* overlay / customization to configure Apache Solr cores properties
  • runner: A Tomcat + H2 runner, capable of running all the aforementioned projects in embedded mode for demo / integration-testing purposes

Common usage patterns of the Share archetype:

Command Description
./ Run the project (also sets up Spring Loaded for hot reloading). See inside script for further details.
mvn package Runs unit tests and packages all custom modules in their respective ${}/${}.amp
mvn install Like mvn package but also installs AMP in local Maven repository where it can be accessed by projects that depend on it.
mvn install -DskipTests=true Like mvn install but skips unit tests.
mvn install -Prun Like mvn install but also triggers the runner project ro run Alfresco, Share, Solr, and Web Quick Start in Jetty (with H2 embedded database).
mvn install -Prun,enterprise Like mvn install -Prun but uses Enterprise artifacts. Note you need to have set up access to the private repository containing the Enterprise artifacts.
mvn clean -Ppurge Removes DB, alf_data, indexes and log files. Useful to purge the development repo (by default self contained in ${project.basedir}/alf_data_dev.
Note: This is an important command to use if you change significant settings in your project. For example, if you change the Alfresco edition from Community to Enterprise. It is important to purge databases and other data that might otherwise be persisted.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.