src/main/webapp/get-started.html - unomi-site - Git at Google

 <!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
     <meta name="description" content="">
     <meta name="author" content="">
     <link rel="icon" href="images/favicon.ico">

     <title>Apache Unomi&trade; Open Source Customer Data Platform | Getting Started </title>

     <!-- Google Analytics -->
     <script>
     (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
     (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
     m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
     })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

     ga('create', 'UA-70313240-1', 'auto');
     ga('send', 'pageview');
     </script>
     <!-- End Google Analytics -->

     <!-- Bootstrap core CSS -->
     <link href="css/bootstrap.min.css" rel="stylesheet">
     <!-- Fontawesome CSS CDN -->
     <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
     <!-- Custom styles for this template -->
     <link href="css/unomi.css" rel="stylesheet">
   </head>
   <body>

     <header>
       <nav class="navbar navbar-expand-md navbar-light bg-white fixed-top border-bottom box-shadow">
         <div class="container">
           <a class="navbar-brand" href="index.html">
             <img src="images/unomi-86x20.png" alt="Logo Apache Unomi"/>
           </a>
           <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse"
                   aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation">
             <span class="navbar-toggler-icon"></span>
           </button>
           <div class="collapse navbar-collapse justify-content-end" id="navbarCollapse">
             <div>
               <ul class="navbar-nav mr-auto align-items-center text-uppercase">
                 <li class="nav-item active">
                   <a class="nav-link" href="get-started.html">Get started <span class="sr-only">(current)</span></a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link" href="use-cases.html">Use cases</a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link" href="download.html">Download</a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link" href="documentation.html">Documentation</a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link" href="resources.html">Resources</a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link" href="contribute.html">Contribute</a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link" href="community.html">Community</a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link disabled" target="_blank" href="https://www.apache.org">
                     <img src="images/apache-feather-tm-new.png" alt="Logo Apache Feather"/>
                   </a>
                 </li>
               </ul>
             </div>
           </div>
         </div>
       </nav>
     </header>

     <main>
       <div class="container pt-5 pb-5">
         <!-- in a few words -->
         <div class="row pb-2 pt-4">
           <div class="col-md-12">
             <h5 class="project-heading"><span class="text-muted">Apache Unomi </span>in a few words</h5>
             <div class="pb-2 pt-2">
               <p>Apache Unomi is a REST server that manages user profiles and events related to the profiles. It can be used to integrate personalization and profile management within very different systems such as CMS, CRMs, Issue Trackers, native mobile application. It was designed to be easy to integrate with external systems, promoting profile sharing and re-use in very different applications.</p>
               <p>Basically the server tracks users using different mechanisms (by default cookies), builds a progressively populated profile and associates events that are performed by a user with his profile. Events may range from a click on a page, to a file being downloaded, a native mobile application button being clicked, or anything that can be sent to the server.</p>
               <p>The server has a built-in rule system that makes it possible to perform any action when an event is collected for a profile. It also has the notion of user segments, making it possible to classify user profiles into dynamic sub-groups, notably to build personalized experiences for specific segments.</p>
               <p>As Apache Unomi is built as an OSGi application running inside <a target="_blank" href="https://karaf.apache.org">Apache Karaf</a>, it is extremely extensible and built to be scalable. For example it is possible to plugin new conditions, actions, or any other service that may be needed such as beacon tracking or push notifications.</p>
               <p>Apache Unomi is also the reference implementation of the upcoming <a target="_blank" href="https://www.oasis-open.org/committees/cxs/">OASIS Context Server (CXS) standard</a> to help standardize personalization of online experience while promoting ethical web experience management and increased user privacy controls.</p>
             </div>
           </div>
         </div><!-- in a few words -->

         <!-- what is unique -->
         <div class="row pb-2 pt-4">
           <div class="col-md-12">
             <h5 class="project-heading">What is unique about <span class="text-muted">Apache Unomi</span> ?</h5>
             <div class="pb-2 pt-2">
               <p>One of the most unique features of this server is its privacy management features. Using the privacy REST API, it is possible for integrators to build user facing UIs that let them manage their profile, and control how they are being tracked, what data has been collected and even anonymize previously collected data or future data ! Finally there is even the possibility for end-users to delete their profile information completely.</p>
               <p>It is becoming more and more important to address privacy issues correctly, and it is even becoming more and more of a legal issue since a lot of legislation is now appearing in many countries to make sure that user’s right to privacy is respected.</p>
               <p>Of course these possibilities have no default UI inside of Apache Unomi so it is left up to the developers to expose them (or not).</p>
             </div>
           </div>
         </div><!-- what is unique -->

         <div id="quickstart" class="row featurette pt-4">
           <div class="col-md-12">
             <h2 class="featurette-heading">5 Minutes Quick start !</h2>
             <ol style="list-style-type: decimal">
               <li>Install JDK 8 (see <a target="_blank" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</a> and make sure you set the JAVA_HOME variable <a target="_blank" href="https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/">https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/</a></li>
               <li>Download ElasticSearch here : <a target="_blank" href="https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3">https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3</a> (please <strong>make sure</strong> you use the proper version : 5.6.3 for Unomi &gt;= 1.3 and 5.1.2 for Unomi &lt;= 1.2)</li>
               <li>Uncompress it and change the <code>config/elasticsearch.yml</code> to include the following config : <code>cluster.name: contextElasticSearch</code></li>
               <li>Launch ElasticSearch using : <code>bin/elasticsearch</code></li>
               <li>Download Apache Unomi here : <a target="_blank" href="http://unomi.incubator.apache.org/download.html">http://unomi.incubator.apache.org/download.html</a></li>
               <li>Start it using : <code>./bin/karaf</code></li>
               <li>Start the Apache Unomi packages using <code>unomi:start</code> in the Apache Karaf Shell</li>
               <li>Wait for startup to complete</li>
               <li>Try accessing <a target="_blank" href="https://localhost:9443/cxs/cluster">https://localhost:9443/cxs/cluster</a> with username/password: karaf/karaf . You might get a certificate warning in your browser, just accept it despite the warning it is safe.</li>
               <li>Request your first context by simply accessing : <a target="_blank" href="http://localhost:8181/context.js?sessionId=1234">http://localhost:8181/context.js?sessionId=1234</a></li>
               <li>If something goes wrong, you should check the logs in ./data/log/karaf.log. If you get errors on ElasticSearch, make sure you are using the proper version.</li>
             </ol>
           </div>
         </div>

       </div>
     </main>

     <!-- FOOTER -->
     <footer class="container-fluid bg-dark pt-5 pb-3 text-white text-center footer">

       <div class="container pb-5">
         <div class="row">
           <div class="col-3 col-md-3">
             <h5>Start</h5>
             <ul class="list-unstyled text-small">
               <li><a href="get-started.html" title="Get started">Get started</a></li>
               <li><a href="get-started.html#quickstart" title="Quick start">Quick start</a></li>
               <li><a href="download.html" title="Download">Download</a></li>
             </ul>
           </div>

           <div class="col-3 col-md-3">
             <h5>Documentation</h5>
             <ul class="list-unstyled text-small">
               <li><a href="documentation.html" title="Main documentation">Main documentation</a></li>
               <li><a href="use-cases.html" title="More use cases">More use cases</a></li>
               <li><a href="rest-api-doc/index.html" title="REST API documentation">REST API documentation</a></li>
               <li><a href="unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a></li>
             </ul>
           </div>

           <div class="col-3 col-md-3">
             <h5>Community</h5>
             <ul class="list-unstyled text-small">
               <li><a href="community.html" title="Mailing lists">Contact Us</a></li>
               <li><a href="contribute.html" title="Contribute">Contribute</a></li>
               <li><a href="community-team.html" title="Team">Team</a></li>
               <li><a href="community-maturity-model-report.html" title="Maturity model report card">Maturity model report card</a></li>
             </ul>
           </div>

           <div class="col-3 col-md-3">
             <h5>About</h5>
             <ul class="list-unstyled text-small">
               <li><a target="_blank" href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee">OASIS CXS Committee</a></li>
               <li><a href="privacy-policy.html" title="Site policy">Site policy</a></li>
               <li><a target="_blank" href="https://www.apache.org/events/current-event.html" title="Apache Events">Apache Events</a></li>
               <li><a target="_blank" href="https://www.apache.org/licenses/" title="License">License</a></li>
               <li><a target="_blank" href="https://www.apache.org/security/" title="Security">Security</a></li>
               <li><a target="_blank" href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
               <li><a target="_blank" href="https://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
             </ul>
           </div>
           <div class="w-100 pt-md-3"></div>
         </div>
       </div>

       <p class="float-right"><a href="#">Back to top</a></p>
       <p>Copyright &copy;2014 - 2019 <a target="_blank" href="https://www.apache.org">Apache Software Foundation</a> - All Rights Reserved - Powered by <a target="_blank" href="https://karaf.apache.org">Apache Karaf&trade;</a><br/>
         Apache Unomi, Unomi, Apache and the Apache feather logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
     </footer>

     <!-- Bootstrap core JavaScript
     ================================================== -->
     <!-- Placed at the end of the document so the pages load faster -->
     <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
     <script>window.jQuery || document.write('<script src="assets/js/vendor/jquery-slim.min.js"><\/script>')</script>
     <script src="assets/js/vendor/popper.min.js"></script>
     <script src="js/bootstrap.min.js"></script>
   </body>
 </html>
	<!doctype html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
	<meta name="description" content="">
	<meta name="author" content="">
	<link rel="icon" href="images/favicon.ico">

	<title>Apache Unomi™ Open Source Customer Data Platform \| Getting Started </title>

	<!-- Google Analytics -->
	<script>
	(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]\|\|function(){
	(i[r].q=i[r].q\|\|[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
	})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

	ga('create', 'UA-70313240-1', 'auto');
	ga('send', 'pageview');
	</script>
	<!-- End Google Analytics -->

	<!-- Bootstrap core CSS -->
	<link href="css/bootstrap.min.css" rel="stylesheet">
	<!-- Fontawesome CSS CDN -->
	<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
	<!-- Custom styles for this template -->
	<link href="css/unomi.css" rel="stylesheet">
	</head>
	<body>

	<header>
	<nav class="navbar navbar-expand-md navbar-light bg-white fixed-top border-bottom box-shadow">
	<div class="container">
	<a class="navbar-brand" href="index.html">
	<img src="images/unomi-86x20.png" alt="Logo Apache Unomi"/>
	</a>
	<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse"
	aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation">
	<span class="navbar-toggler-icon"></span>
	</button>
	<div class="collapse navbar-collapse justify-content-end" id="navbarCollapse">
	<div>
	<ul class="navbar-nav mr-auto align-items-center text-uppercase">
	<li class="nav-item active">
	<a class="nav-link" href="get-started.html">Get started <span class="sr-only">(current)</span></a>
	</li>
	<li class="nav-item">
	<a class="nav-link" href="use-cases.html">Use cases</a>
	</li>
	<li class="nav-item">
	<a class="nav-link" href="download.html">Download</a>
	</li>
	<li class="nav-item">
	<a class="nav-link" href="documentation.html">Documentation</a>
	</li>
	<li class="nav-item">
	<a class="nav-link" href="resources.html">Resources</a>
	</li>
	<li class="nav-item">
	<a class="nav-link" href="contribute.html">Contribute</a>
	</li>
	<li class="nav-item">
	<a class="nav-link" href="community.html">Community</a>
	</li>
	<li class="nav-item">
	<a class="nav-link disabled" target="_blank" href="https://www.apache.org">
	<img src="images/apache-feather-tm-new.png" alt="Logo Apache Feather"/>
	</a>
	</li>
	</ul>
	</div>
	</div>
	</div>
	</nav>
	</header>

	<main>
	<div class="container pt-5 pb-5">
	<!-- in a few words -->
	<div class="row pb-2 pt-4">
	<div class="col-md-12">
	<h5 class="project-heading"><span class="text-muted">Apache Unomi </span>in a few words</h5>
	<div class="pb-2 pt-2">
	<p>Apache Unomi is a REST server that manages user profiles and events related to the profiles. It can be used to integrate personalization and profile management within very different systems such as CMS, CRMs, Issue Trackers, native mobile application. It was designed to be easy to integrate with external systems, promoting profile sharing and re-use in very different applications.</p>
	<p>Basically the server tracks users using different mechanisms (by default cookies), builds a progressively populated profile and associates events that are performed by a user with his profile. Events may range from a click on a page, to a file being downloaded, a native mobile application button being clicked, or anything that can be sent to the server.</p>
	<p>The server has a built-in rule system that makes it possible to perform any action when an event is collected for a profile. It also has the notion of user segments, making it possible to classify user profiles into dynamic sub-groups, notably to build personalized experiences for specific segments.</p>
	<p>As Apache Unomi is built as an OSGi application running inside <a target="_blank" href="https://karaf.apache.org">Apache Karaf</a>, it is extremely extensible and built to be scalable. For example it is possible to plugin new conditions, actions, or any other service that may be needed such as beacon tracking or push notifications.</p>
	<p>Apache Unomi is also the reference implementation of the upcoming <a target="_blank" href="https://www.oasis-open.org/committees/cxs/">OASIS Context Server (CXS) standard</a> to help standardize personalization of online experience while promoting ethical web experience management and increased user privacy controls.</p>
	</div>
	</div>
	</div><!-- in a few words -->

	<!-- what is unique -->
	<div class="row pb-2 pt-4">
	<div class="col-md-12">
	<h5 class="project-heading">What is unique about <span class="text-muted">Apache Unomi</span> ?</h5>
	<div class="pb-2 pt-2">
	<p>One of the most unique features of this server is its privacy management features. Using the privacy REST API, it is possible for integrators to build user facing UIs that let them manage their profile, and control how they are being tracked, what data has been collected and even anonymize previously collected data or future data ! Finally there is even the possibility for end-users to delete their profile information completely.</p>
	<p>It is becoming more and more important to address privacy issues correctly, and it is even becoming more and more of a legal issue since a lot of legislation is now appearing in many countries to make sure that user’s right to privacy is respected.</p>
	<p>Of course these possibilities have no default UI inside of Apache Unomi so it is left up to the developers to expose them (or not).</p>
	</div>
	</div>
	</div><!-- what is unique -->

	<div id="quickstart" class="row featurette pt-4">
	<div class="col-md-12">
	<h2 class="featurette-heading">5 Minutes Quick start !</h2>
	<ol style="list-style-type: decimal">
	<li>Install JDK 8 (see <a target="_blank" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</a> and make sure you set the JAVA_HOME variable <a target="_blank" href="https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/">https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/</a></li>
	<li>Download ElasticSearch here : <a target="_blank" href="https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3">https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3</a> (please <strong>make sure</strong> you use the proper version : 5.6.3 for Unomi >= 1.3 and 5.1.2 for Unomi <= 1.2)</li>
	<li>Uncompress it and change the <code>config/elasticsearch.yml</code> to include the following config : <code>cluster.name: contextElasticSearch</code></li>
	<li>Launch ElasticSearch using : <code>bin/elasticsearch</code></li>
	<li>Download Apache Unomi here : <a target="_blank" href="http://unomi.incubator.apache.org/download.html">http://unomi.incubator.apache.org/download.html</a></li>
	<li>Start it using : <code>./bin/karaf</code></li>
	<li>Start the Apache Unomi packages using <code>unomi:start</code> in the Apache Karaf Shell</li>
	<li>Wait for startup to complete</li>
	<li>Try accessing <a target="_blank" href="https://localhost:9443/cxs/cluster">https://localhost:9443/cxs/cluster</a> with username/password: karaf/karaf . You might get a certificate warning in your browser, just accept it despite the warning it is safe.</li>
	<li>Request your first context by simply accessing : <a target="_blank" href="http://localhost:8181/context.js?sessionId=1234">http://localhost:8181/context.js?sessionId=1234</a></li>
	<li>If something goes wrong, you should check the logs in ./data/log/karaf.log. If you get errors on ElasticSearch, make sure you are using the proper version.</li>
	</ol>
	</div>
	</div>

	</div>
	</main>

	<!-- FOOTER -->
	<footer class="container-fluid bg-dark pt-5 pb-3 text-white text-center footer">

	<div class="container pb-5">
	<div class="row">
	<div class="col-3 col-md-3">
	<h5>Start</h5>
	<ul class="list-unstyled text-small">
	<li><a href="get-started.html" title="Get started">Get started</a></li>
	<li><a href="get-started.html#quickstart" title="Quick start">Quick start</a></li>
	<li><a href="download.html" title="Download">Download</a></li>
	</ul>
	</div>

	<div class="col-3 col-md-3">
	<h5>Documentation</h5>
	<ul class="list-unstyled text-small">
	<li><a href="documentation.html" title="Main documentation">Main documentation</a></li>
	<li><a href="use-cases.html" title="More use cases">More use cases</a></li>
	<li><a href="rest-api-doc/index.html" title="REST API documentation">REST API documentation</a></li>
	<li><a href="unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a></li>
	</ul>
	</div>

	<div class="col-3 col-md-3">
	<h5>Community</h5>
	<ul class="list-unstyled text-small">
	<li><a href="community.html" title="Mailing lists">Contact Us</a></li>
	<li><a href="contribute.html" title="Contribute">Contribute</a></li>
	<li><a href="community-team.html" title="Team">Team</a></li>
	<li><a href="community-maturity-model-report.html" title="Maturity model report card">Maturity model report card</a></li>
	</ul>
	</div>

	<div class="col-3 col-md-3">
	<h5>About</h5>
	<ul class="list-unstyled text-small">
	<li><a target="_blank" href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee">OASIS CXS Committee</a></li>
	<li><a href="privacy-policy.html" title="Site policy">Site policy</a></li>
	<li><a target="_blank" href="https://www.apache.org/events/current-event.html" title="Apache Events">Apache Events</a></li>
	<li><a target="_blank" href="https://www.apache.org/licenses/" title="License">License</a></li>
	<li><a target="_blank" href="https://www.apache.org/security/" title="Security">Security</a></li>
	<li><a target="_blank" href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
	<li><a target="_blank" href="https://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
	</ul>
	</div>
	<div class="w-100 pt-md-3"></div>
	</div>
	</div>

	<p class="float-right"><a href="#">Back to top</a></p>
	<p>Copyright ©2014 - 2019 <a target="_blank" href="https://www.apache.org">Apache Software Foundation</a> - All Rights Reserved - Powered by <a target="_blank" href="https://karaf.apache.org">Apache Karaf™</a><br/>
	Apache Unomi, Unomi, Apache and the Apache feather logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
	</footer>

	<!-- Bootstrap core JavaScript
	================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
	<script>window.jQuery \|\| document.write('<script src="assets/js/vendor/jquery-slim.min.js"><\/script>')</script>
	<script src="assets/js/vendor/popper.min.js"></script>
	<script src="js/bootstrap.min.js"></script>
	</body>
	</html>