fling/README.md

# Apache Sling Fling Sample

This module is part of the [Apache Sling](https://sling.apache.org) project.

This is a sample using _Sling Models_, _Sling Query_, _Sling Scripting Thymeleaf_, _Sling Validation_, _Sling Commons Messaging_ (latest snapshot) and _Sling Commons Messaging Mail_ (latest snapshot).

**As it is using some snapshots it might be unstable from time to time, feel free to ask on our mailing list if unsure!**

* [Sling Models](http://sling.apache.org/documentation/bundles/models.html)
* [Sling Query](https://github.com/Cognifide/Sling-Query)
* [Sling Scripting Thymeleaf](http://sling.apache.org/documentation/bundles/scripting/scripting-thymeleaf.html) ([Thymeleaf](http://www.thymeleaf.org/), [Sling i18n](http://sling.apache.org/documentation/bundles/internationalization-support-i18n.html))
* [Sling Validation](https://sling.apache.org/documentation/bundles/validation.html)
* Sling Commons Messaging and Sling Commons Messaging Mail

Additional features used in this sample:

* [Authentication](http://www.thymeleaf.org/)¹: see `org.apache.sling.samples.fling.internal.Activator`
* [Bundle Resources](http://sling.apache.org/documentation/bundles/bundle-resources-extensions-bundleresource.html): see `Sling-Bundle-Resources` in `pom.xml`
* [Content Loading](http://sling.apache.org/documentation/bundles/content-loading-jcr-contentloader.html): see `Sling-Initial-Content` in `pom.xml`
* [Maven Sling Plugin](http://sling.apache.org/documentation/development/sling.html): see `maven-sling-plugin` in `pom.xml`

There are two profiles to install this sample with _Maven Sling Plugin_ into a running local _Sling_ instance for convenience:

When using _[Sling Launchpad](https://sling.apache.org/documentation/the-sling-engine/the-sling-launchpad.html)_ listening on port `8080` with default admin credentials run:

    mvn clean install -P launchpad@localhost

When using _[Apache Karaf](http://karaf.apache.org)_ with _[Sling's Karaf Features](https://github.com/apache/sling/tree/trunk/karaf/org.apache.sling.karaf-features)_ or _[Sling's Karaf Distribution](https://github.com/apache/sling/tree/trunk/karaf/org.apache.sling.karaf-distribution)_ listening on port `8181` with default admin credentials run:

    mvn clean install -P karaf@localhost

This will install initial content under `/apps/fling` and `/content/fling`.

Browse to [http://localhost:8080/fling.html](http://localhost:8080/fling.html) or [http://localhost:8181/fling.html](http://localhost:8181/fling.html).

To install the `sling-samples-fling` feature with dependencies on _Apache Karaf_ run the commands below:

    karaf@root()> feature:repo-add mvn:org.apache.sling/org.apache.sling.launchpad.karaf-features/0.1.1-SNAPSHOT/xml/features
    karaf@root()> feature:install sling-launchpad-oak-tar
    karaf@root()> feature:install sling-samples-fling
    karaf@root()> feature:install sling-auth-form²

For a more detailed user profile add some properties to an user³:

    curl -u admin -FfirstName=Foo -FlastName=Bar http://localhost:8181/system/userManager/user/admin.update.json

1. Pages under _Authentication_ (`/fling/auth`) need authentication.
2. optional feature
3. requires bundle `org.apache.sling.jcr.jackrabbit.usermanager` or feature `sling-jcr-jackrabbit-security` to be installed