This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to branch feature/SLING-9595 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-starter.git
commit 3b8aa6e5b60576274ea652d2a043048942d29c7a Author: Robert Munteanu <[email protected]> AuthorDate: Wed Aug 5 19:18:31 2020 +0200 SLING-9595 - Fully switch starter build to the feature model Update documentation. --- README.md | 64 ++++++++++++++------------------------------------------------- 1 file changed, 14 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 85f617b..512facd 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,8 @@ This module is part of the [Apache Sling](https://sling.apache.org) project. -The starter project produces both a Standalone Java Application which -contains everything needed to run the Launchpad in a single JAR file and a Web -Application. +The starter project produces feature artifacts that can be launched using the +[Feature Launcher](https://github.com/apache/sling-org-apache-sling-feature-launcher). It is **not meant to be a production-ready setup**, more as a way to facilitate experimenting and learning Sling. @@ -17,7 +16,7 @@ See [Releasing a new version of the Sling starter](https://cwiki.apache.org/conf How to run the Sling Starter module in Standalone mode ---------------------------------------- - NOTE: "mvn clean" deletes the "sling" work directory in the project base + NOTE: "mvn clean" deletes the "launcher" work directory in the project base directory. It is advisable to use a work directory outside of the project directory. @@ -27,57 +26,22 @@ How to run the Sling Starter module in Standalone mode in the current directory. -2) Start the generated jar with +2) Download the feature launcher using - java -jar target/org.apache.sling.starter-10-SNAPSHOT.jar - -Use the correct version number instead of 10-SNAPSHOT, if needed. - -3) Browse Sling in: - - http://localhost:8080 - -How to run the Sling Starter module in webapp mode ----------------------------------------- + mvn dependency:get dependency:copy -Dartifact=org.apache.sling:org.apache.sling.feature.launcher:1.1.4 + + mvn dependency:copy -Dartifact=org.apache.sling:org.apache.sling.feature.launcher:1.1.4 -1) Build the Sling Starter using +3) Start Sling backed by an Oak SegmentStore with - mvn clean install + java -jar target/dependency/org.apache.sling.feature.launcher-1.1.4.jar -f target/slingfeature-tmp/feature-oak_tar.json -in the current directory. - -2) Deploy target/org.apache.sling.starter-10-SNAPSHOT.war to your favorite application -server or servlet container. Servlet 3.1 is a minimum requirement for the web app. +4) Browse Sling in: -Experimental Feature Model support ----------------------------------------- - -During the build the provisioning model files will be converted on the fly to feature model files -on-the-fly. The conversion taking into account the `oak_tar` runmode places its results in -`target/fm/oak_tar`. In a similar way, the MongoDB feature files are placed under -`target/fm/oak_mongo`. - -For convenience, the results are aggregates in a single, standalone feature file. Due to technical -limitations only a single aggregate feature file is created, by default the `oak_tar` one, found -under `target/slingfeature-tmp/feature-oak_tar.json`. - -If you don't have a copy of the feature launcher jar, download it, for instance using - - $ mvn dependency:get dependency:copy \ - -Dartifact=org.apache.sling:org.apache.sling.feature.launcher:LATEST \ - -DoutputDirectory=. - -To launch Sling using the feature launcher, simply execute - - $ java -jar org.apache.sling.feature.launcher-*.jar -f target/slingfeature-tmp/feature-oak_tar.json - -To clean up the repository state just delete the `launcher` directory. + http://localhost:8080 -To generate the oak_mongo aggregate run the build and define the `fm.oak_mongo` property, e.g. +For MongoDB support replace the launch command with - $ mvn clean package -Dfm.oak_mongo - -The instruction to launch Sling then becomes + java -jar target/dependency/org.apache.sling.feature.launcher-1.1.4.jar -f target/slingfeature-tmp/feature-oak_tar.json - $ java -jar org.apache.sling.feature.launcher-*.jar -f target/slingfeature-tmp/feature-oak_mongo.json - +This expects a MongoDB server to be running locally.
