Documentation
Latest versions
Archives
API Documentation
Javadoc
Click here to view the Javadoc documentation
REST
Starting with version 1.6, the REST API is no longer updated here since it is embedded directly in the server as OpenAPI documentation. You can find it here: http://localhost:8181/cxs/api-docs?url=openapi.json once the server was started.
Name | Description | REST API Documentation | Since version | Status |
---|---|---|---|---|
userList | Manage user | view | 1.3.0-incubating | |
campaigns | Manage campaign | view | 1.3.0-incubating | |
cluster | Manage cluster | view | 1.3.0-incubating | |
definitions | Manage definitions | view | 1.3.0-incubating | |
goals | Manage goal | view | 1.3.0-incubating | |
profile | Manage profile | view | 1.3.0-incubating | |
query | Manage query | view | 1.3.0-incubating | |
rules | Manage rule | view | 1.3.0-incubating | |
scoring | Manage scoring | view | 1.3.0-incubating | |
segments | Manage segment | view | 1.3.0-incubating | |
patches | Manage patch | view | 1.4.0 | |
events | Manage event | view | 1.4.0 |
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.
Migrating between versions used by Apache Unomi.
Cluster migration
Steps:
- Depending on your install, perform either the standalone or cluster migration
- That's it !
Security Advisories
CVE-2020-11975 : Remote Code Execution in Apache Unomi
CVE-2020-13942 : Remote Code Execution in Apache Unomi
CVE-2021-31164 : CRLF Log injection in Apache Unomi