Apache Unomi 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 Customer Data Platform specification 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).

Quick start with Docker

Docker images are available for Apache Unomi, this section will provide a few quick steps to get your first Unomi environment started, the only requirement being to have a recent version of Docker installed on your machine.

Somewhere on your filesystem, create a file called docker-compose.yml, with the following content:

                    version: '3.8'
                        image: docker.elastic.co/elasticsearch/elasticsearch:7.10.2
                          - discovery.type=single-node
                          - 9200:9200                    
                        # Unomi version can be updated based on your needs
                        image: apache/unomi:1.5.7
                          - UNOMI_ELASTICSEARCH_ADDRESSES=elasticsearch:9200
                          - UNOMI_THIRDPARTY_PROVIDER1_IPADDRESSES=,::1,
                          - 8181:8181
                          - 9443:9443
                          - 8102:8102
                          - elasticsearch
                          - elasticsearch                    

From the same folder, start the environment using docker-compose up and wait for the startup to complete.

Try accessing 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.

Want to start Unomi manually using Java instead ? You can find a quick start guide in our documentation.

Please note that the above configuration is aimed at discovering Apache Unomi quickly, it is not recommended to use this configuration for production environments.