| <!-- |
| ~ 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. |
| --> |
| |
| [](https://builds.apache.org/job/unomi-master/) |
| [](https://maven-badges.herokuapp.com/maven-central/org.apache.unomi/unomi-root) |
| |
| |
| Apache Unomi |
| ============ |
| https://unomi.apache.org |
| |
| Apache Unomi stores user profile information and is mostly used to provide a backend server for A/B testing and |
| personalization. To do so it implements the currently under development OASIS Context Server specification. |
| |
| License |
| ------- |
| The source code is available under the Apache License V2 |
| |
| Branches |
| -------- |
| |
| - main (master) branch: is the current development branch and should be considered unstable. At this it might even not |
| compile. It is only recommended for Unomi developers or people looking to contribute on the project. |
| - unomi-X.X.X branches : these are the maintenance branches of the stable releases of Apache Unomi and should always |
| compile and be stable. These are recommended for users that prefer to work from the source code. Otherwise you can find |
| packaged binaries on the [Apache Unomi website](https://unomi.apache.org). |
| |
| |
| Apache Unomi 3.x |
| -------------- |
| Unomi 3.0+ requires **Java 17**, **Karaf 4.4**, and **Elasticsearch 9.x**. Unomi 3.1 adds **multi-tenancy**, **OpenSearch 3** support, a cluster-aware **task scheduler**, and persistence-based clustering. |
| |
| * Build and run: see `manual/src/main/asciidoc/building-and-deploying.adoc` or `manual/src/main/asciidoc/5-min-quickstart.adoc` |
| * Docker: see `docker/README.md` |
| * Multi-tenancy and API keys: see `manual/src/main/asciidoc/multitenancy.adoc` |
| * Migrations: see `manual/src/main/asciidoc/migrations/migrations.adoc` |
| |
| Documentation |
| ------------- |
| You can find all the updated documentation, including building and deployment instructions, on the [Apache Unomi |
| web site](https://unomi.apache.org). |
