UNOMI-205 remove files
Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/6d6c024f Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/6d6c024f Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/6d6c024f Branch: refs/heads/UNOMI-180-CXS-GRAPHQLAPI Commit: 6d6c024ff09b72d75b18c55371d824d7322f66b3 Parents: 5ed92f9 Author: dgaillard <dgaill...@jahia.com> Authored: Fri Oct 19 17:14:26 2018 +0200 Committer: dgaillard <dgaill...@jahia.com> Committed: Fri Oct 19 17:14:26 2018 +0200 ---------------------------------------------------------------------- src/site/markdown/archive.md | 61 --- src/site/markdown/download.md | 50 --- src/site/markdown/index.md | 127 ------ src/site/markdown/license.md | 30 -- src/site/markdown/main.md | 55 --- src/site/markdown/maturity-model-report.md | 221 ---------- src/site/markdown/migrating-elasticsearch.md | 50 --- src/site/markdown/privacy-policy.md | 41 -- src/site/markdown/usecases.md | 85 ---- .../versions/1.1/building-and-deploying.md | 189 --------- src/site/markdown/versions/1.1/clustering.md | 83 ---- src/site/markdown/versions/1.1/concepts.md | 209 --------- src/site/markdown/versions/1.1/configuration.md | 273 ------------ .../markdown/versions/1.1/getting-started.md | 425 ------------------- .../versions/1.2/building-and-deploying.md | 225 ---------- src/site/markdown/versions/1.2/clustering.md | 66 --- src/site/markdown/versions/1.2/concepts.md | 209 --------- src/site/markdown/versions/1.2/configuration.md | 310 -------------- src/site/markdown/versions/1.2/connectors.md | 26 -- .../markdown/versions/1.2/custom-extensions.md | 369 ---------------- .../markdown/versions/1.2/getting-started.md | 107 ----- src/site/markdown/versions/1.2/login-sample.md | 56 --- .../versions/1.2/salesforce-connector.md | 165 ------- src/site/markdown/versions/1.2/samples.md | 23 - .../markdown/versions/1.2/twitter-sample.md | 403 ------------------ .../versions/1.2/weather-update-sample.md | 19 - .../versions/master/building-and-deploying.md | 229 ---------- src/site/markdown/versions/master/clustering.md | 66 --- src/site/markdown/versions/master/concepts.md | 208 --------- .../markdown/versions/master/configuration.md | 350 --------------- src/site/markdown/versions/master/connectors.md | 26 -- .../markdown/versions/master/consent-api.md | 135 ------ .../versions/master/custom-extensions.md | 376 ---------------- .../markdown/versions/master/getting-started.md | 107 ----- .../markdown/versions/master/login-sample.md | 56 --- .../versions/master/salesforce-connector.md | 156 ------- src/site/markdown/versions/master/samples.md | 23 - .../markdown/versions/master/twitter-sample.md | 403 ------------------ .../versions/master/weather-update-sample.md | 19 - .../resources/images/apache-unomi-380x85.png | Bin 28161 -> 0 bytes .../resources/images/apache-unomi-571x128.png | Bin 34486 -> 0 bytes .../resources/images/apache-unomi-large.png | Bin 60570 -> 0 bytes src/site/resources/images/incubator-logo.png | Bin 8923 -> 0 bytes src/site/resources/images/unomi-100x99.png | Bin 18543 -> 0 bytes src/site/resources/images/unomi-200x56.png | Bin 20393 -> 0 bytes src/site/resources/images/unomi-86x20.png | Bin 17610 -> 0 bytes src/site/resources/images/unomi-features.png | Bin 145199 -> 0 bytes src/site/resources/images/unomi-icon.png | Bin 33427 -> 0 bytes .../resources/images/unomi-input-output.png | Bin 87222 -> 0 bytes .../unomi-logical-architecture-diagram.png | Bin 41571 -> 0 bytes src/site/resources/images/unomi-request.png | Bin 132731 -> 0 bytes src/site/resources/images/unomi.png | Bin 57947 -> 0 bytes src/site/resources/images/unomi.xcf | Bin 177483 -> 0 bytes src/site/site.xml | 146 ------- 54 files changed, 6177 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/archive.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/archive.md b/src/site/markdown/archive.md deleted file mode 100644 index a252a83..0000000 --- a/src/site/markdown/archive.md +++ /dev/null @@ -1,61 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -# Previous releases of Apache Unomi - -## Verify the integrity of the files - -It is essential that you verify the integrity of the downloaded files using the PGP or MD5 signatures. - -The PGP signatures can be verified using PGP or GPG. First download the [KEYS](http://www.apache.org/dist/incubator/unomi/KEYS) as well as the PGP signature file for the -relevant file. Make sure you get these files from the main distribution directory, rather than from a mirror. Then -verify the signatures using, for instance: - - % gpg --import KEYS - % gpg --verify unomi-1.2.0-incubating.tar.gz.asc unomi-1.2.0-incubating.tar.gz - -## 1.1.0-incubating - -### Release notes - -Here are the [release notes](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319220&version=12335442) for this version of Apache Unomi - -### Binaries - -* [tar.gz](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.tar.gz) ([MD5](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.tar.gz.md5) - [SHA1](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.tar.gz.sha1) - [PGP](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.tar.gz.asc)) -* [zip](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.zip) ([MD5](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.zip.md5) - [SHA1](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.zip.sha1) - [PGP](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating.zip.asc)) - -### Source code - -* [tar.gz](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.tar.gz) ([MD5](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.tar.gz.md5) - [SHA1](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.tar.gz.sha1) - [PGP](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.tar.gz.asc)) -* [zip](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.zip) ([MD5](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.zip.md5) - [SHA1](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.zip.sha1) - [PGP](http://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-1.1.0-incubating-src.zip.asc)) - -## 1.0.0-incubating - -### Release notes - -Here are the [release notes](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319220&version=12334704) for this version of Apache Unomi - -### Binaries - -* [tar.gz](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating.tar.gz) ([PGP](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating.tar.gz.asc)) -* [zip](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating.zip) ([PGP](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating.zip.asc)) - -### Source code - -* [tar.gz](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating-src.tar.gz) ([PGP](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating-src.tar.gz.asc)) -* [zip](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating-src.zip) ([PGP](http://archive.apache.org/dist/incubator/unomi/1.0.0-incubating/unomi-1.0.0-incubating-src.zip.asc)) http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/download.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/download.md b/src/site/markdown/download.md deleted file mode 100644 index 2243ea7..0000000 --- a/src/site/markdown/download.md +++ /dev/null @@ -1,50 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -# Downloading Apache Unomi - -## 1.2.0-incubating - -###Â Release notes - -Here are the [release notes](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319220&version=12338361) for this version of Apache Unomi - -### Binaries - -We provide convenience binaries in two formats - -* [tar.gz](http://www.apache.org/dyn/closer.lua/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.tar.gz) ([MD5](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.tar.gz.md5) - [SHA1](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.tar.gz.sha1) - [PGP](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.tar.gz.asc)) -* [zip](http://www.apache.org/dyn/closer.lua/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.zip) ([MD5](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.zip.md5) - [SHA1](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.zip.sha1) - [PGP](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating.zip.asc)) - -### Source code - -* [zip](http://www.apache.org/dyn/closer.lua/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating-src.zip) ([MD5](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating-src.zip.md5) - [SHA1](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating-src.zip.sha1) - [PGP](http://www.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-1.2.0-incubating-src.zip.asc)) - -# Verify the integrity of the files - -It is essential that you verify the integrity of the downloaded files using the PGP or MD5 signatures. - -The PGP signatures can be verified using PGP or GPG. First download the [KEYS](http://www.apache.org/dist/incubator/unomi/KEYS) as well as the PGP signature file for the -relevant file. Make sure you get these files from the main distribution directory, rather than from a mirror. Then -verify the signatures using, for instance: - - % gpg --import KEYS - % gpg --verify unomi-1.2.0-incubating.tar.gz.asc unomi-1.2.0-incubating.tar.gz - -# Previous releases - -Previous releases may be found [here](archive.html) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md deleted file mode 100644 index 42381ce..0000000 --- a/src/site/markdown/index.md +++ /dev/null @@ -1,127 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - - - -# The Open Source Customer Data Platform - -## Apache Unomi in one sentence -Apache Unomi is __a Java Open Source customer data platform__, a Java server designed to manage customers, -leads and visitorsâ data and help personalize customersâ experiences while also offering features to respect visitor -privacy rules (such as [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation)) - -## *NEW* Privacy (GPDR consent management) upcoming features in version 1.3 -New to release 1.3 (currently in development, nearing completion) are features to manage visitor consents, in order to -make it easier to comply with new privacy regulations such as the [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) -If you are interested in these new features, you must for the moment build the master branch from source. A quick guide -to these new features is also available [here](versions/master/consent-api.html) - -## For developers -* Uses ElasticSearch for data storage, dynamic data structure -* Highly scalable architecture -* Very simple to deploy and install (simply unzip & run) -* Uses Apache Karaf as the OSGi runtime -* Full & simple REST API -* Extensible through plugin architecture (using OSGi & simple JSON descriptors) -* Apache Open Source project - -## For IT stakeholders and business users -* First-Party Data Collection and Ownership -* Persistent and consolidated profiles for all your audience (customers & leads), storing anonymous and personally -identifiable information -* Regulation-proof and privacy management built-in -* Real-Time Decisioning (Scoring logics, segmentation) -* Open standard, easy integration and extension - -## Why would you need a Customer Data Platform ? -Organizations collect data from multiple sources and channels - sales, web, emails, mobile, brick and mortar - and -all of this data is spread across different departments and technologies. As a result, many professionals are lacking -the data they need to do their job, especially data analysts and marketers. - -A customer data platform helps business users collect all the customer data in one place, providing a complete view -of the customers. When the data is collected, the customer data platform will also play a key role in choosing which -content or offer is more relevant to a customer. - -## The Apache Unomi advantage -Each organization is unique and will always have specific needs, this is why Apache Unomi has been designed to -be extended and to ease the integration of external data. The embedded features such as segmentation, scoring and -built-in privacy will be appreciated by business users while horizontal scalability and open source positioning will -be loved by developers and architects. - -Apache Unomi is also the reference implementation of the upcoming OASIS Context Server (CXS) standard -(https://www.oasis-open.org/committees/cxs/) to help standardize personalization of customer experience while promoting -ethical web experience management and increased user privacy controls. - -## Business cases based on Unomi -* Build a web personalization software to adapt the content on your website to your audience -* Collect data from mobile application and feed Apache Unomi to track and understand your customersâ journeys -* Connect the beacons deployed in your stores to Apache Unomi and consolidate the profile of your customers and leads across all these channels -* Automatically push profiles from Apache Unomi to your CRM when a lead reach a given number of points in one of your scoring plans - -## Unomi logical architecture - -All communication is done using HTTP REST requests and JSON data formats. - - - -## 5 Minute Quick start -1. Install JDK 8 (see [http://www.oracle.com/technetwork/java/javase/downloads/index.html](http://www.oracle.com/technetwork/java/javase/downloads/index.html) and make sure you set the JAVA_HOME variable [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/) -2. Download ElasticSearch here : [https://www.elastic.co/downloads/elasticsearch](https://www.elastic.co/downloads/elasticsearch) (use version 5.1.2 for Unomi <= 1.2, 5.6.3 for Unomi >= 1.3) -3. Uncompress it and change the `config/elasticsearch.yml` to include the following config : `cluster.name: contextElasticSearch` -4. Launch ElasticSearch using : `bin/elasticsearch` -5. Download Apache Unomi here : [http://unomi.incubator.apache.org/download.html](http://unomi.incubator.apache.org/download.html) -6. Start it using : `./bin/karaf` -7. Start the Apache Unomi packages using `unomi:start` in the Apache Karaf Shell -8. Wait for startup to complete -9. Try accessing [https://localhost:9443/cxs/cluster](https://localhost:9443/cxs/cluster) with username/password: karaf/karaf . You might get a certificate warning in your browser, just accept it despite the warning it is safe. -10. Request your first context by simply accessing : [http://localhost:8181/context.js?sessionId=1234](http://localhost:8181/context.js?sessionId=1234) - -### News - -- 2017-09-28 Released version 1.2.0-incubating -- 2017-07-19 New Salesforce CRM connector contributed -- 2016-10-04 Released version 1.1.0-incubating -- 2016-05-22 Released version 1.0.0-incubating -- 2015-11-23 Initial code base import in [Git repository](source-repository.html) -- 2015-11-20 Added [Apache Maturity Model report page](maturity-model-report.html) -- 2015-11-13 Initial web site created -- 2015-10-20 JIRA, mailing lists, git, website space created. -- 2015-10-05 Project enters incubation. - -### Articles & slides - -* [Linux.com : Unomi: A Bridge Between Privacy and Digital Marketing](http://www.linux.com/news/enterprise/cloud-computing/858418-unomi-a-bridge-between-privacy-and-digital-marketing) -* [Introducing Apache Unomi, JavaOne 2015](http://www.slideshare.net/sergehuber/introducing-apache-unomi-javaone-2015-session) This presentation has a cool example of integrating Apache Unomi with IoT devices (Internet of Things) such as beacons, smartphones and even televisions -* [Apache Unomi In-depth, ApacheCon EU 2015](http://www.slideshare.net/sergehuber/apache-unomi-in-depth-apachecon-eu-2015-session) - ---- - -### Disclaimer - -Apache Unomi is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required -of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized -in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability -of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - -[](http://incubator.apache.org) - -[](http://apache.org) - -### Trademarks - -Apache Karaf, Apache Mahout, Apache and the Apache feather logo are either registered trademarks or trademarks of The - Apache Software Foundation in the United States and other countries. http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/license.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/license.md b/src/site/markdown/license.md deleted file mode 100644 index 7715e2f..0000000 --- a/src/site/markdown/license.md +++ /dev/null @@ -1,30 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -# License - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/main.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/main.md b/src/site/markdown/main.md deleted file mode 100644 index be7e0ac..0000000 --- a/src/site/markdown/main.md +++ /dev/null @@ -1,55 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -# General documentation - -In this section we regroup the documentation by Apache Unomi version. - -## Version 1.2 (current) - -- [Building and deploying](versions/1.2/building-and-deploying.html) -- [Getting started](versions/1.2/getting-started.html) -- [Configuration](versions/1.2/configuration.html) -- [Samples](versions/1.2/samples.html) -- [Connectors](versions/1.2/connectors.html) -- [Cluster setup](versions/1.2/clustering.html) -- [Concepts](versions/1.2/concepts.html) -- [Custom extensions](versions/1.2/custom-extensions.html) - -## Version 1.1 - -- [Building and deploying](versions/1.1/building-and-deploying.html) -- [Getting started](versions/1.1/getting-started.html) -- [Configuration](versions/1.1/configuration.html) -- [Cluster setup](versions/1.1/clustering.html) -- [Concepts](versions/1.1/concepts.html) - -## Master (snapshot, in development) - -- [Building and deploying](versions/master/building-and-deploying.html) -- [Getting started](versions/master/getting-started.html) -- [Configuration](versions/master/configuration.html) -- [Samples](versions/master/samples.html) -- [Connectors](versions/master/connectors.html) -- [Cluster setup](versions/master/clustering.html) -- [Concepts](versions/master/concepts.html) -- [Custom extensions](versions/master/custom-extensions.html) -- [Consent API](versions/master/consent-api.html) - -# Migration documentation - -- [ElasticSearch migrations](migrating-elasticsearch.html) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/maturity-model-report.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/maturity-model-report.md b/src/site/markdown/maturity-model-report.md deleted file mode 100644 index 018ddbf..0000000 --- a/src/site/markdown/maturity-model-report.md +++ /dev/null @@ -1,221 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> - -# Unomi Podling Maturity Assessment - -## Overview - -This is an assessment of the Unomi podling's maturity, meant to help inform -the decision (of the mentors, community, Incubator PMC and ASF Board of -Directors) to graduate it as a top-level Apache project. - -It is based on the ASF project maturity model at -https://community.apache.org/apache-way/apache-project-maturity-model.html - -Maintaining such a file is a new, experimental idea as part of the continuous -improvement of the ASF incubation process. Unomi is the second podling where -that happens. - -## Status of this document -Updated 2017-07-19 with the latest status of the project. - -## Overall assessment -Just introduced this report card, we will need to evaluate all the model's parts to see how we fare so far. - -## Maturity model assessment -Mentors and community members are encouraged to contribute to this -and comment on it. - -### Code - -#### CD10 -_The project produces Open Source software, for distribution to the public at no charge._ - -- [ OK ] : everything is hosted at the Apache Software Foundation - -#### CD20 -_The project's code is easily discoverable and publicly accessible._ - -- [ OK ] : it is linked from the main project site and accessible in the public ASF git repository - -#### CD30 -_The code can be built in a reproducible way using widely available standard tools._ - -- [ OK ] : Jenkins is configured on the project. - -#### CD40 -_The full history of the project's code is available via a source code control system, in a way that allows any released version to be recreated._ - -- [ OK ] : everything is in the ASF Git repository. - -#### CD50 -_The provenance of each line of code is established via the source code control system, in a reliable way based on strong authentication of the committer. -When third-party contributions are committed, commit messages provide reliable information about the code provenance._ - -- [ OK ] : Only ASF committers with CLAs may contribute to the project. - -### Licenses and Copyright - -#### LC10 -_The code is released under the Apache License, version 2._0._ - -- [ OK ] : A LICENSE file is also at the root of the ASF Git repository - -#### LC20 -_Libraries that are mandatory dependencies of the project's code do not create more restrictions than the Apache License does._ - -- [ OK ] : NOTICE files contain all the information and has been reviewed on two releases already - -#### LC30 -_The libraries mentioned in LC20 are available as Open Source software._ - -- [ OK ] : See LC20 - -#### LC40 -_Committers are bound by an Individual Contributor Agreement (the "Apache iCLA") that defines which code they are allowed to commit and how they need to identify code that is not their own._ - -- [ OK ] : All committers have registered iCLAs - -#### LC50 -_The copyright ownership of everything that the project produces is clearly defined and documented._ - -- [ OK ] : All source files have the proper Apache license headers. - -### Releases - -#### RE10 -_Releases consist of source code, distributed using standard and open archive formats that are expected to stay readable in the long term._ - -- [ OK ] : Two releases have been produced so far and have been reviewed by IPMCs - -#### RE20 -_Releases are approved by the project's PMC (see CS10), in order to make them an act of the Foundation._ - -- [ OK ] : Happened for two major releases already - -#### RE30 -_Releases are signed and/or distributed along with digests that can be reliably used to validate the downloaded archives._ - -- [ OK ] : See releases [here](http://unomi.apache.org/download.html) - -#### RE40 -_Convenience binaries can be distributed alongside source code but they are not Apache Releases -- they are just a convenience provided with no guarantee._ - -- [ OK ] : See the releases [here](http://unomi.apache.org/download.html) - -### Quality - -#### QU10 -_The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated._ - -- [ OK ] : The project has seen two major releases. Integration tests are performed by Jenkins continuously. Overall quality is mostly good. - -#### QU20 -_The project puts a very high priority on producing secure software._ - -- [ OK ] : For the moment no security issues have been reported, but if they are they will treated quickly. - -#### QU30 -_The project provides a well-documented channel to report security issues, along with a documented way of responding to them._ - -- [ KO ] : We need to document this. - -#### QU40 -_The project puts a high priority on backwards compatibility and aims to document any incompatible changes and provide tools and documentation to help users transition to new features._ - -- [ OK ] : Migration of the data set is handled with an internal tool. [Migration documentation](http://unomi.apache.org/migrating-elasticsearch.html) has already been produced. - -#### QU50 -_The project strives to respond to documented bug reports in a timely manner._ - -- [ OK ] : Usually we try to answer within 24-48 hours. However full resolution may be more difficult. The objective is to keep the community as active as possible. - -### Community - -#### CO10 -_The project has a well-known homepage that points to all the information required to operate according to this maturity model._ - -- [ OK ] : See the [project's home page](http://unomi.incubator.apache.org) - -#### CO20 -_The community welcomes contributions from anyone who acts in good faith and in a respectful manner and adds value to the project._ - -- [ OK ] : We have some active contributions coming from people external to the project initiators. We do our best to welcome them and contribute to the project. - -#### CO30 -_Contributions include not only source code, but also documentation, constructive bug reports, constructive discussions, marketing and generally anything that adds value to the project._ - -- [ ] : to be evaluated - -#### CO40 -_The community is meritocratic and over time aims to give more rights and responsibilities to contributors who add value to the project._ - -- [ ] : to be evaluated - -#### CO50 -_The way in which contributors can be granted more rights such as commit access or decision power is clearly documented and is the same for all contributors._ - -- [ ] : to be evaluated - -#### CO60 -_The community operates based on consensus of its members (see CS10) who have decision power. Dictators, benevolent or not, are not welcome in Apache projects._ - -- [ ] : to be evaluated - -#### CO70 -_The project strives to answer user questions in a timely manner._ - -- [ ] : to be evaluated - -### Consensus Building - -#### CS10 -_The project maintains a public list of its contributors who have decision power -- the project's PMC (Project Management Committee) consists of those contributors._ - -- [ ] : to be evaluated - -#### CS20 -_Decisions are made by consensus among PMC members and are documented on the project's main communications channel. Community opinions are taken into account but the PMC has the final word if needed._ - -- [ ] : to be evaluated - -#### CS30 -_Documented voting rules are used to build consensus when discussion is not sufficient._ - -- [ ] : to be evaluated - -#### CS40 -_In Apache projects, vetoes are only valid for code commits and are justified by a technical explanation, as per the Apache voting rules defined in CS30._ - -- [ ] : to be evaluated - -#### CS50 -_All "important" discussions happen asynchronously in written form on the project's main communications channel. Offline, face-to-face or private discussions that affect the project are also documented on that channel._ - -- [ ] : to be evaluated - -### Independence - -#### IN10 -_The project is independent from any corporate or organizational influence._ - -- [ ] : to be evaluated - -#### IN20 -_Contributors act as themselves as opposed to representatives of a corporation or organization._ - -- [ ] : to be evaluated http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/migrating-elasticsearch.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/migrating-elasticsearch.md b/src/site/markdown/migrating-elasticsearch.md deleted file mode 100644 index 6b5d4fd..0000000 --- a/src/site/markdown/migrating-elasticsearch.md +++ /dev/null @@ -1,50 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -# Migrating ElasticSearch - -## Introduction - -In this section of the documentation we will explain some general notions of how to migrate between ElasticSearch -versions, as well as present specific migration steps to migrate from one version of ElasticSearch used by Apache Unomi -to another, if it is needed. - -## General steps and notions - -Depending on the type of ElasticSearch install you may have, the migration steps will differ. Basically when dealing with -a single node (standalone) installation, a simple procedure may be used that simply copies some directories over, while -in the case of a cluster installation ElasticSearch Snapshot and Restore functionality must be used. - -### Standalone (one node migration) - -In the case of a standalone install, it is generally sufficient, provided the versions are compatible (meaning that only -one major version seperates the two installs), to simply copy over the `data` directory over to the new version. Also -you will need to make sure that you copy over any custom settings from the `config/elasticsearch.yml` file over to the -new version. - -### Cluster migration - -Here we recommend you read the [official upgrading documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html). - -## Migrating between versions used by Apache Unomi. - -### ElasticSearch 5.1.2 to 5.6.3 (Unomi 1.2.0 -> 1.3.0) - -Steps: - -1. Depending on your install, perform either the standalone or cluster migration -2. That's it ! \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/privacy-policy.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/privacy-policy.md b/src/site/markdown/privacy-policy.md deleted file mode 100644 index 9025b4f..0000000 --- a/src/site/markdown/privacy-policy.md +++ /dev/null @@ -1,41 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> - -Privacy Policy -============== -Information about your use of this website is collected using server access -logs and a tracking cookie. The collected information consists of the -following: - -1. The IP address from which you access the website; -1. The type of browser and operating system you use to access our site; -1. The date and time you access our site; -1. The pages you visit; and -1. The addresses of pages from where you followed a link to our site. - -Part of this information is gathered using a tracking cookie set by the [Google Analytics](http://www.google.com/analytics/) -service and handled by Google as described in their [privacy policy](http://www.google.com/privacy.html). -See your browser documentation for instructions on how to disable the -cookie if you prefer not to share this data with Google. - -We use the gathered information to help us make our site more useful to -visitors and to better understand how and when our site is used. We do not -track or collect personally identifiable information or associate gathered -data with any personally identifying information from other sources. - -By using this website, you consent to the collection of this data in the -manner and for the purpose described above. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/usecases.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/usecases.md b/src/site/markdown/usecases.md deleted file mode 100644 index 9f181af..0000000 --- a/src/site/markdown/usecases.md +++ /dev/null @@ -1,85 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -### In a few words - -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. - -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. - -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. - -As Apache Unomi is built as an OSGi application running inside Apache Karaf, 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. - -Apache Unomi is also the reference implementation of the upcoming OASIS Context Server (CXS) standard -(https://www.oasis-open.org/committees/cxs/) to help standardize personalization of online experience -while promoting ethical web experience management and increased user privacy controls. - -### What is unique about Apache Unomi ? - -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. - -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. - -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). - -### Use cases - -#### Use Apache Unomi as a personalization service for a Web CMS - -In this use case Apache Unomi is used to track all the users that visits the sites being managed by the CMS. The -sites may also contain personalized content elements that will use the profile information coming from Apache Unomi -to change their display based on the user. It will also send events (such as login events for example) back to the -server using simple AJAX calls to the Apache Unomi REST API. - -The Web CMS can also build UIs to expose the privacy management feature to end-users of the platform, and will of -course build UIs to perform administration tasks such as profile, segments, goals, rules management. - -#### Use Apache Unomi as an analytics service for a native mobile application - -In this case the server is used as a back-end for a native mobile application that will authenticate a user and then -send events to the server when the user performs certains tasks within the app. Tasks may include pressing a button, -getting close to a location (using GPS or beacons), etc... - -The application may also include a UI to expose the privacy management features of Apache Unomi. - -#### Use Apache Unomi as a centralized profile management system - -In this use case the server is used a centralized profile management system, making it easy to aggregate different -profile information that may be stored in different systems such as CRMs, Issue tracking systems, forums, CMS, ... -One way of achieving this is to make sure that "anonymous" profiles are merged when an event such as a login happens -and a unique cross-system identifier (usually the email address) is detected on each system. - -In this case connectors to all the different systems will need to be developped (and hopefully contributed back to -the Apache Unomi community), so that the centralization of the information is managed by an Open Source and standards -compliant server community. http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/versions/1.1/building-and-deploying.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/versions/1.1/building-and-deploying.md b/src/site/markdown/versions/1.1/building-and-deploying.md deleted file mode 100644 index 7d39902..0000000 --- a/src/site/markdown/versions/1.1/building-and-deploying.md +++ /dev/null @@ -1,189 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> -Building -======== - -Simply type at the root of the project: - - mvn clean install -P generate-package - -The Maven build process will generate both a standalone package you can use directly to start the context server -(see "Deploying the generated package") or a KAR file that you can then deploy using a manual deployment process into -an already installed Apache Karaf server (see "Deploying into an existing Karaf server") - -If you want to build and run the integration tests, you should instead use : - - mvn -P integration-tests clean install - -Deploying the generated package -------------------------------- - -The "package" sub-project generates a pre-configured Apache Karaf installation that is the simplest way to get started. -Simply uncompress the `package/target/unomi-VERSION.tar.gz` (for Linux or Mac OS X) or - `package/target/unomi-VERSION.zip` (for Windows) archive into the directory of your choice. - -You can then start the server simply by using the command on UNIX/Linux/MacOS X : - - ./bin/karaf - -or on Windows shell : - - bin\karaf.bat - - -Deploying into an existing Karaf server ---------------------------------------- - -This is only needed if you didn't use the generated package. Also, this is the preferred way to install a development -environment if you intend to re-deploy the context server KAR iteratively. - -Additional requirements: - - Apache Karaf 3.0.2+, http://karaf.apache.org - - Local copy of the Elasticsearch ZIP package, available here : http://www.elasticsearch.org - -1. Before deploying, make sure that you have Apache Karaf properly installed. You will also have to increase the -default maximum memory size and perm gen size by adjusting the following environment values in the bin/setenv(.bat) -files (at the end of the file): - - ``` - MY_DIRNAME=`dirname $0` - MY_KARAF_HOME=`cd "$MY_DIRNAME/.."; pwd` - export KARAF_OPTS="-Djava.library.path=$MY_KARAF_HOME/lib/sigar" - export JAVA_MAX_MEM=3G - export JAVA_MAX_PERM_MEM=384M - ``` - -2. You will also need to have the Hyperic Sigar native libraries in your Karaf installation, so in order to this -go to the Elasticsearch website (http://www.elasticsearch.org) and download the ZIP package. Decompress it somewhere -on your disk and copy all the files from the lib/sigar directory into Karaf's lib/sigar directory -(must be created first) EXCEPT THE SIGAR.JAR file. - -3. Install the WAR support, CXF into Karaf by doing the following in the Karaf command line: - - ``` - feature:install -v war - feature:repo-add cxf 2.7.11 - feature:install -v cxf/2.7.11 - ``` - -4. Create a new $MY_KARAF_HOME/etc/org.apache.cxf.osgi.cfg file and put the following property inside : - - ``` - org.apache.cxf.servlet.context=/cxs - ``` - -5. Copy the following KAR to the Karaf deploy directory, as in this example line: - - ``` - cp kar/target/unomi-kar-1.0.0-SNAPSHOT.kar ~/java/deployments/unomi/apache-karaf-3.0.1/deploy/ - ``` - -6. If all went smoothly, you should be able to access the context script here : http://localhost:8181/cxs/cluster . - You should be able to login with karaf / karaf and see basic server information. If not something went wrong during the install. - -JDK Selection on Mac OS X -------------------------- - -You might need to select the JDK to run the tests in the itests subproject. In order to do so you can list the -installed JDKs with the following command : - - /usr/libexec/java_home -V - -which will output something like this : - - Matching Java Virtual Machines (7): - 1.7.0_51, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home - 1.7.0_45, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home - 1.7.0_25, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_25.jdk/Contents/Home - 1.6.0_65-b14-462, x86_64: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home - 1.6.0_65-b14-462, i386: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home - 1.6.0_65-b14-462, x86_64: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home - 1.6.0_65-b14-462, i386: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home - - -You can then select the one you want using : - - export JAVA_HOME=`/usr/libexec/java_home -v 1.7.0_51` - -and then check that it was correctly referenced using: - - java -version - -which should give you a result such as this: - - java version "1.7.0_51" - Java(TM) SE Runtime Environment (build 1.7.0_51-b13) - Java HotSpot(TM) 64-Bit Server VM (build 24.51-b03, mixed mode) - - -Running the integration tests ------------------------------ - -The integration tests are not executed by default to make build time minimal, but it is recommended to run the -integration tests at least once before using the server to make sure that everything is ok in the build. Another way -to use these tests is to run them from a continuous integration server such as Jenkins, Apache Gump, Atlassian Bamboo or - others. - -Note : the integration tests require a JDK 7 or more recent ! - -To run the tests simply activate the following profile : - - mvn -P integration-tests clean install - -Running the performance tests ------------------------------ - -Performance tests are based on Gatling. You need to have a running context server or cluster of servers before -executing the tests. - -Test parameteres are editable in the performance-tests/src/test/scala/unomi/Parameters.scala file. baseUrls should -contains the URLs of all your cluster nodes - -Run the test by using the gatling.conf file in performance-tests/src/test/resources : - -``` - export GATLING_CONF=<path>/performance-tests/src/test/resources - gatling.sh -``` - -Reports are generated in performance-tests/target/results. - -Testing with an example page ----------------------------- - -A default test page is provided at the following URL: - -``` - http://localhost:8181/index.html -``` - -This test page will trigger the loading of the /context.js script, which will try to retrieving the user context -or create a new one if it doesn't exist yet. It also contains an experimental integration with Facebook Login, but it -doesn't yet save the context back to the context server. - -Integrating onto a page ------------------------ - - Simply reference the context script in your HTML as in the following example: - -```javascript -<script type="text/javascript"> - (function(){ var u=(("https:" == document.location.protocol) ? "https://localhost:8181/"; : "http://localhost:8181/";); - var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=true; g.src=u+'context.js'; - s.parentNode.insertBefore(g,s); })(); -</script> -``` http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/versions/1.1/clustering.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/versions/1.1/clustering.md b/src/site/markdown/versions/1.1/clustering.md deleted file mode 100644 index 7c51889..0000000 --- a/src/site/markdown/versions/1.1/clustering.md +++ /dev/null @@ -1,83 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -Cluster setup -============= - -Context server relies on Elasticsearch to discover and configure its cluster. You just need to install multiple context -servers on the same network, and enable the discovery protocol in $MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg file : - - discovery.zen.ping.multicast.enabled=true - -All nodes on the same network, sharing the same cluster name will be part of the same cluster. - -###Recommended configurations - -It is recommended to have one node dedicated to the context server, where the other nodes take care of the -Elasticsearch persistence. The node dedicated to the context server will have node.data set to false. - -#### 2 nodes configuration -One node dedicated to context server, 1 node for elasticsearch storage. - -Node A : - - node.data=true - numberOfReplicas=0 - monthlyIndex.numberOfReplicas=0 - -Node B : - - node.data=false - numberOfReplicas=0 - monthlyIndex.numberOfReplicas=0 - -#### 3 nodes configuration -One node dedicated to context server, 2 nodes for elasticsearch storage with fault-tolerance - -Node A : - - node.data=false - numberOfReplicas=1 - monthlyIndex.numberOfReplicas=1 - -Node B : - - node.data=true - numberOfReplicas=1 - monthlyIndex.numberOfReplicas=1 - -Node C : - - node.data=true - numberOfReplicas=1 - monthlyIndex.numberOfReplicas=1 - -### Specific configuration -If multicast is not allowed on your network, you'll need to switch to unicast protocol and manually configure the server IPs. This can be -done by disabling the elasticsearch automatic discovery in $MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg : - - discovery.zen.ping.multicast.enabled=false - - -And then set the property discovery.zen.ping.unicast.hosts in $MY_KARAF_HOME/etc/elasticsearch.yml files : - - - discovery.zen.ping.unicast.hosts: [â192.168.0.1:9300', â192.168.0.2:9300'] - - -More information and configuration options can be found at : -[https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery.html](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery.html) http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/versions/1.1/concepts.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/versions/1.1/concepts.md b/src/site/markdown/versions/1.1/concepts.md deleted file mode 100644 index 4f4e7be..0000000 --- a/src/site/markdown/versions/1.1/concepts.md +++ /dev/null @@ -1,209 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -# Concepts - -Apache Unomi gathers information about users actions, information that is processed and stored by Unomi services. The collected information can then be used to personalize content, derive insights on user behavior, categorize the user profiles into segments along user-definable dimensions or acted upon by algorithms. - -## Items and types -Unomi structures the information it collects using the concept of `Item` which provides the base information (an identifier and a type) the context server needs to process and store the data. Items are persisted according to their type (structure) and identifier (identity). This base structure can be extended, if needed, using properties in the form of key-value pairs. - -These properties are further defined by the `Item`âs type definition which explicits the `Item`âs structure and semantics. By defining new types, users specify which properties (including the type of values they accept) are available to items of that specific type. - -Unomi defines default value types: `date`, `email`, `integer` and `string`, all pretty self-explanatory. While you can think of these value types as "primitive" types, it is possible to extend Unomi by providing additional value types. - - -Additionally, most items are also associated to a scope, which is a concept that Unomi uses to group together related items. A given scope is represented in Unomi by a simple string identifier and usually represents an application or set of applications from which Unomi gathers data, depending on the desired analysis granularity. In the context of web sites, a scope could, for example, represent a site or family of related sites being analyzed. Scopes allow clients accessing the context server to filter data to only see relevant data. - -*Base `Item` structure:* - -```json -{ - "itemType": <type of the item>, - "scope": <scope>, - "itemId": <item identifier>, - "properties": <optional properties> -} -``` - -Some types can be dynamically defined at runtime by calling to the REST API while other extensions are done via Unomi plugins. Part of extending Unomi, therefore, is a matter of defining new types and specifying which kind of Unomi entity (e.g. profiles) they can be affected to. For example, the following JSON document can be passed to Unomi to declare a new property type identified (and named) `tweetNb`, tagged with the `social` tag, targeting profiles and using the `integer` value type. - -*Example JSON type definition:* - -```json -{ - "itemId": "tweetNb", - "itemType": "propertyType", - "metadata": { - "id": "tweetNb", - "name": "tweetNb", - "tags": ["social"] - }, - "target": "profiles", - "type": "integer" -} -``` - - ->Unomi defines a built-in scope (called `systemscope`) that clients can use to share data across scopes. - -## Events -Users' actions are conveyed from clients to the context server using events. Of course, the required information depends on what is collected and users' interactions with the observed systems but events minimally provide a type, a scope and source and target items. Additionally, events are timestamped. Conceptually, an event can be seen as a sentence, the event's type being the verb, the source the subject and the target the object. - - -*Event structure:* - -```json -{ - "eventType": <type of the event>, - "scope": <scope of the event>, - "source": <Item>, - "target": <Item>, - "properties": <optional properties> -} -``` - -Source and target can be any Unomi item but are not limited to them. In particular, as long as they can be described using properties and Unomiâs type mechanism and can be processed either natively or via extension plugins, source and target can represent just about anything. Events can also be triggered as part of Unomiâs internal processes for example when a rule is triggered. - -Events are sent to Unomi from client applications using the JSON format and a typical page view event from a web site could look something like the following: - -*Example page view event:* - -```json -{ - "eventType": "view", - "scope": "ACMESPACE", - "source": { - "itemType": "site", - "scope": "ACMESPACE", - "itemId": "c4761bbf-d85d-432b-8a94-37e866410375" - }, - "target": { - "itemType": "page", - "scope": "ACMESPACE", - "itemId": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71", - "properties": { - "pageInfo": { - "pageID": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71", - "pageName": "Home", - "pagePath": "/sites/ACMESPACE/home", - "destinationURL": "http://localhost:8080/sites/ACMESPACE/home.html";, - "referringURL": "http://localhost:8080/";, - "language": "en" - }, - "category": {}, - "attributes": {} - } - } -} -``` - -## Profiles -By processing events, Unomi progressively builds a picture of who the user is and how they behave. This knowledge is embedded in `Profile` object. A profile is an `Item` with any number of properties and optional segments and scores. Unomi provides default properties to cover common data (name, last name, age, email, etc.) as well as default segments to categorize users. Unomi users are, however, free and even encouraged to create additional properties and segments to better suit their needs. - -Contrary to other Unomi items, profiles are not part of a scope since we want to be able to track the associated user across applications. For this reason, data collected for a given profile in a specific scope is still available to any scoped item that accesses the profile information. - -It is interesting to note that there is not necessarily a one to one mapping between users and profiles as users can be captured across applications and different observation contexts. As identifying information might not be available in all contexts in which data is collected, resolving profiles to a single physical user can become complex because physical users are not observed directly. Rather, their portrait is progressively patched together and made clearer as Unomi captures more and more traces of their actions. Unomi will merge related profiles as soon as collected data permits positive association between distinct profiles, usually as a result of the user performing some identifying action in a context where the user hadnât already been positively identified. - -## Sessions -A session represents a time-bounded interaction between a user (via their associated profile) and a Unomi-enabled application. A session represents the sequence of actions the user performed during its duration. For this reason, events are associated with the session during which they occurred. In the context of web applications, sessions are usually linked to HTTP sessions. - -# Extending Unomi via plugins -Unomi is architected so that users can provided extensions in the form of plugins. - -## Types vs. instances -Several extension points in Unomi rely on the concept of type: the extension defines a prototype for what the actual items will be once parameterized with values known only at runtime. This is similar to the concept of classes in object-oriented programming: types define classes, providing the expected structure and which fields are expected to be provided at runtime, that are then instantiated when needed with actual values. - -## Plugin structure -Being built on top of Apache Karaf, Unomi leverages OSGi to support plugins. A Unomi plugin is, thus, an OSGi bundle specifying some specific metadata to tell Unomi the kind of entities it provides. A plugin can provide the following entities to extend Unomi, each with its associated definition (as a JSON file), located in a specific spot within the `META-INF/cxs/` directory of the bundle JAR file: - - -| Entity | Location in `cxs` directory | -| -------- | -------- | -| ActionType | actions | -| ConditionType | conditions | -| Persona | personas | -| PropertyMergeStrategyType | mergers | -| PropertyType | properties then profiles or sessions subdirectory then `<category name>` directory | -| Rule | rules | -| Scoring | scorings | -| Segment | segments | -| Tag | tags | -| ValueType | values | - -[Blueprint](http://aries.apache.org/modules/blueprint.html) is used to declare what the plugin provides and inject any required dependency. The Blueprint file is located, as usual, at `OSGI-INF/blueprint/blueprint.xml` in the bundle JAR file. - -The plugin otherwise follows a regular maven project layout and should depend on the Unomi API maven artifact: - -```xml -<dependency> - <groupId>org.apache.unomi</groupId> - <artifactId>unomi-api</artifactId> - <version>...</version> -</dependency> -``` - -Some plugins consists only of JSON definitions that are used to instantiate the appropriate structures at runtime while some more involved plugins provide code that extends Unomi in deeper ways. - -In both cases, plugins can provide more that one type of extension. For example, a plugin could provide both `ActionType`s and `ConditionType`s. - -## Extension points - -### ActionType -`ActionType`s define new actions that can be used as consequences of Rules being triggered. When a rule triggers, it creates new actions based on the event data and the rule internal processes, providing values for parameters defined in the associated `ActionType`. Example actions include: âSet user property x to value yâ or âSend a message to service xâ. - -### ConditionType -`ConditionType`s define new conditions that can be applied to items (for example to decide whether a rule needs to be triggered or if a profile is considered as taking part in a campaign) or to perform queries against the stored Unomi data. They may be implemented in Java when attempting to define a particularly complex test or one that can better be optimized by coding it. They may also be defined as combination of other conditions. A simple condition could be: âUser is maleâ, while a more generic condition with parameters may test whether a given property has a specific value: âUser property x has value yâ. - -### Persona -A persona is a "virtual" profile used to represent categories of profiles, and may also be used to test how a personalized experience would look like using this virtual profile. A persona can define predefined properties and sessions. Persona definition make it possible to âemulateâ a certain type of profile, e.g : US visitor, non-US visitor, etc. - -### PropertyMergeStrategyType -A strategy to resolve how to merge properties when merging profile together. - -### PropertyType -Definition for a profile or session property, specifying how possible values are constrained, if the value is multi-valued (a vector of values as opposed to a scalar value). `PropertyType`s can also be categorized using tags or file system structure, using sub-directories to organize definition files. - -### Rule -`Rule`s are conditional sets of actions to be executed in response to incoming events. Triggering of rules is guarded by a condition: the rule is only triggered if the associated condition is satisfied. That condition can test the event itself, but also the profile or the session. Once a rule triggers, a list of actions can be performed as consequences. Also, when rules trigger, a specific event is raised so that other parts of Unomi can react accordingly. - -### Scoring -`Scoring`s are set of conditions associated with a value to assign to profiles when matching so that the associated users can be scored along that dimension. Each scoring element is evaluated and matching profiles' scores are incremented with the associated value. - -### Segments -`Segment`s represent dynamically evaluated groups of similar profiles in order to categorize the associated users. To be considered part of a given segment, users must satisfies the segmentâs condition. If they match, users are automatically added to the segment. Similarly, if at any given point during, they cease to satisfy the segmentâs condition, they are automatically removed from it. - -### Tag -`Tag`s are simple labels that are used to classify all other objects inside Unomi. - -### ValueType -Definition for values that can be assigned to properties ("primitive" types). - -## Other Unomi entities - -### UserList -User list are simple static lists of users. The associated profile stores the lists it belongs to in a specific property. - -### Goal -Goals represent tracked activities / actions that can be accomplished by site (or more precisely scope) visitors. These are tracked in general because they relate to specific business objectives or are relevant to measure site/scope performance. - -Goals can be defined at the scope level or in the context of a particular `Campaign`. Either types of goals behave exactly the same way with the exception of two notable differences: - - duration: scope-level goals are considered until removed while campaign-level goals are only considered for the campaign duration - - audience filtering: any visitor is considered for scope-level goals while campaign-level goals only consider visitors who match the campaign's conditions - -### Campaign -A goal-oriented, time-limited marketing operation that needs to be evaluated for return on investment performance by tracking the ratio of visits to conversions. http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6d6c024f/src/site/markdown/versions/1.1/configuration.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/versions/1.1/configuration.md b/src/site/markdown/versions/1.1/configuration.md deleted file mode 100644 index b925d48..0000000 --- a/src/site/markdown/versions/1.1/configuration.md +++ /dev/null @@ -1,273 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -Configuration -============= - -Changing the default configuration ----------------------------------- - -If you want to change the default configuration, you can perform any modification you want in the $MY_KARAF_HOME/etc directory. - -The context server configuration is kept in the $MY_KARAF_HOME/etc/org.apache.unomi.web.cfg . It defines the -addresses and port where it can be found : - - contextserver.address=localhost - contextserver.port=8181 - contextserver.secureAddress=localhost - contextserver.securePort=9443 - contextserver.domain=apache.org - -If you need to specify an Elasticsearch cluster name that is different than the default, it is recommended to do this -BEFORE you start the server for the first time, or you will loose all the data you have stored previously. - -To change the cluster name, first create a file called - - $MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg - -with the following contents: - - cluster.name=contextElasticSearch - index.name=context - elasticSearchConfig=file:${karaf.etc}/elasticsearch.yml - -And replace the cluster.name parameter here by your cluster name. - -You can also put an elasticsearch configuration file in $MY_KARAF_HOME/etc/elasticsearch.yml , -and put any standard Elasticsearch configuration options in this last file. - -If you want your context server to be a client only on a cluster of elasticsearch nodes, just set the node.data property -to false. - -Installing the MaxMind GeoIPLite2 IP lookup database ----------------------------------------------------- - -The Context Server requires an IP database in order to resolve IP addresses to user location. -The GeoLite2 database can be downloaded from MaxMind here : -http://dev.maxmind.com/geoip/geoip2/geolite2/ - -Simply download the GeoLite2-City.mmdb file into the "etc" directory. - -Installing Geonames database ----------------------------- - -Context server includes a geocoding service based on the geonames database ( http://www.geonames.org/ ). It can be -used to create conditions on countries or cities. - -In order to use it, you need to install the Geonames database into . Get the "allCountries.zip" database from here : -http://download.geonames.org/export/dump/ - -Download it and put it in the "etc" directory, without unzipping it. -Edit $MY_KARAF_HOME/etc/org.apache.unomi.geonames.cfg and set request.geonamesDatabase.forceImport to true, import should start right away. -Otherwise, import should start at the next startup. Import runs in background, but can take about 15 minutes. -At the end, you should have about 4 million entries in the geonames index. - -REST API Security ------------------ - -The Context Server REST API is protected using JAAS authentication and using Basic or Digest HTTP auth. -By default, the login/password for the REST API full administrative access is "karaf/karaf". - -The generated package is also configured with a default SSL certificate. You can change it by following these steps : - -1. Replace the existing keystore in $MY_KARAF_HOME/etc/keystore by your own certificate : - - http://wiki.eclipse.org/Jetty/Howto/Configure_SSL - -2. Update the keystore and certificate password in $MY_KARAF_HOME/etc/custom.properties file : - -``` - org.osgi.service.http.secure.enabled = true - org.ops4j.pax.web.ssl.keystore=${karaf.etc}/keystore - org.ops4j.pax.web.ssl.password=changeme - org.ops4j.pax.web.ssl.keypassword=changeme - org.osgi.service.http.port.secure=9443 -``` - -You should now have SSL setup on Karaf with your certificate, and you can test it by trying to access it on port 9443. - -Automatic profile merging -------------------------- - -The context server is capable of merging profiles based on a common property value. In order to use this, you must -add the MergeProfileOnPropertyAction to a rule (such as a login rule for example), and configure it with the name - of the property that will be used to identify the profiles to be merged. An example could be the "email" property, - meaning that if two (or more) profiles are found to have the same value for the "email" property they will be merged - by this action. - -Upon merge, the old profiles are marked with a "mergedWith" property that will be used on next profile access to delete -the original profile and replace it with the merged profile (aka "master" profile). Once this is done, all cookie tracking -will use the merged profile. - -To test, simply configure the action in the "login" or "facebookLogin" rules and set it up on the "email" property. -Upon sending one of the events, all matching profiles will be merged. - -Securing a production environment ---------------------------------- - -Before going live with a project, you should *absolutely* read the following section that will help you setup a proper -secure environment for running your context server. - -Step 1: Install and configure a firewall - -You should setup a firewall around your cluster of context servers and/or Elasticsearch nodes. If you have an -application-level firewall you should only allow the following connections open to the whole world : - - - http://localhost:8181/context.js - - http://localhost:8181/eventcollector - -All other ports should not be accessible to the world. - -For your Context Server client applications (such as the Jahia CMS), you will need to make the following ports -accessible : - - 8181 (Context Server HTTP port) - 9443 (Context Server HTTPS port) - -The context server actually requires HTTP Basic Auth for access to the Context Server administration REST API, so it is -highly recommended that you design your client applications to use the HTTPS port for accessing the REST API. - -The user accounts to access the REST API are actually routed through Karaf's JAAS support, which you may find the -documentation for here : - - - http://karaf.apache.org/manual/latest/users-guide/security.html - -The default username/password is - - karaf/karaf - -You should really change this default username/password as soon as possible. To do so, simply modify the following -file : - - $MY_KARAF_HOME/etc/users.properties - -For your context servers, and for any standalone Elasticsearch nodes you will need to open the following ports for proper -node-to-node communication : 9200 (Elasticsearch REST API), 9300 (Elasticsearch TCP transport) - -Of course any ports listed here are the default ports configured in each server, you may adjust them if needed. - -Step 2 : Adjust the Context Server IP filtering - -By default the Context Server limits to connections to port 9200 and 9300 to the following IP ranges - - - localhost - - 127.0.0.1 - - ::1 - - the current subnet (i.e., 192.168.1.0-192.168.1.255) - -(this is done using a custom plugin for Elasticsearch, that you may find here : -https://git-wip-us.apache.org/repos/asf/incubator-unomi/context-server/persistence-elasticsearch/plugins/security) - -You can adjust this setting by using the following setting in the $MY_KARAF_HOME/etc/elasticsearch.yml file : - - security.ipranges: localhost,127.0.0.1,::1,10.0.1.0-10.0.1.255 - -Step 3 : Follow industry recommended best practices for securing Elasticsearch - -You may find more valuable recommendations here : - -- https://www.elastic.co/blog/found-elasticsearch-security -- https://www.elastic.co/blog/scripting-security - -Step 4 : Setup a proxy in front of the context server - -As an alternative to an application-level firewall, you could also route all traffic to the context server through -a proxy, and use it to filter any communication. - -Integrating with an Apache HTTP web server ------------------------------------------- - -If you want to setup an Apache HTTP web server in from of Apache Unomi, here is an example configuration using -mod_proxy. - -In your Unomi package directory, in /etc/org.apache.unomi.web.cfg for unomi.apache.org - - contextserver.address=unomi.apache.org - contextserver.port=80 - contextserver.secureAddress=unomi.apache.org - contextserver.securePort=443 - contextserver.domain=apache.org - -Main virtual host config: - - <VirtualHost *:80> - Include /var/www/vhosts/unomi.apache.org/conf/common.conf - </VirtualHost> - - <IfModule mod_ssl.c> - <VirtualHost *:443> - Include /var/www/vhosts/unomi.apache.org/conf/common.conf - - SSLEngine on - - SSLCertificateFile /var/www/vhosts/unomi.apache.org/conf/ssl/24d5b9691e96eafa.crt - SSLCertificateKeyFile /var/www/vhosts/unomi.apache.org/conf/ssl/apache.org.key - SSLCertificateChainFile /var/www/vhosts/unomi.apache.org/conf/ssl/gd_bundle-g2-g1.crt - - - <FilesMatch "\.(cgi|shtml|phtml|php)$"> - SSLOptions +StdEnvVars - </FilesMatch> - <Directory /usr/lib/cgi-bin> - SSLOptions +StdEnvVars - </Directory> - BrowserMatch "MSIE [2-6]" \ - nokeepalive ssl-unclean-shutdown \ - downgrade-1.0 force-response-1.0 - BrowserMatch "MSIE [17-9]" ssl-unclean-shutdown - - </VirtualHost> - </IfModule> - -common.conf: - - ServerName unomi.apache.org - ServerAdmin webmas...@apache.org - - DocumentRoot /var/www/vhosts/unomi.apache.org/html - CustomLog /var/log/apache2/access-unomi.apache.org.log combined - <Directory /> - Options FollowSymLinks - AllowOverride None - </Directory> - <Directory /var/www/vhosts/unomi.apache.org/html> - Options FollowSymLinks MultiViews - AllowOverride None - Order allow,deny - allow from all - </Directory> - <Location /cxs> - Order deny,allow - deny from all - allow from 88.198.26.2 - allow from www.apache.org - </Location> - - RewriteEngine On - RewriteCond %{REQUEST_METHOD} ^(TRACE|TRACK) - RewriteRule .* - [F] - ProxyPreserveHost On - ProxyPass /server-status ! - ProxyPass /robots.txt ! - - RewriteCond %{HTTP_USER_AGENT} Googlebot [OR] - RewriteCond %{HTTP_USER_AGENT} msnbot [OR] - RewriteCond %{HTTP_USER_AGENT} Slurp - RewriteRule ^.* - [F,L] - - ProxyPass / http://localhost:8181/ connectiontimeout=20 timeout=300 ttl=120 - ProxyPassReverse / http://localhost:8181/
