---
title: Documentation
layout: default
---

    <div class="container mb-5 pt-5">
      <h2 class="pb-2 mb-2 border-bottom">Documentation</h2>

      <h4 class="pt-4 mt-2 text-dark">Latest versions</h4>

      <div class="row mb-2">
        <div class="col-md-4">
          <div class="card flex-md-row mb-4 box-shadow h-md-250">
            <div class="card-body d-flex flex-column align-items-start">
              <strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i> Stable</strong>
              <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.5.6</span></h3>
              <div class="mb-1 text-muted">Last update: May 10th, 2021</div>
              <p class="card-text">
                <a href="manual/1_5_x/index.html">online</a><br>
                <a target="_blank" href="https://dist.apache.org/repos/dist/release/unomi/1.5.4/unomi-manual-1_5_x.zip">html (zipped)</a>
                [ <a target="_blank" href="https://dist.apache.org/repos/dist/release/unomi/1.5.4/unomi-manual-1_5_x.zip.asc">PGP</a> |
                <a target="_blank" href="https://dist.apache.org/repos/dist/release/unomi/1.5.4/unomi-manual-1_5_x.zip.sha512">SHA512</a> ]<br>
                <a target="_blank" href="https://dist.apache.org/repos/dist/release/unomi/1.5.4/unomi-manual-1_5_x.pdf">pdf</a>
                [ <a target="_blank" href="https://dist.apache.org/repos/dist/release/unomi/1.5.4/unomi-manual-1_5_x.pdf.asc">PGP</a> |
                <a target="_blank" href="https://dist.apache.org/repos/dist/release/unomi/1.5.4/unomi-manual-1_5_x.pdf.sha512">SHA512</a> ]
                -->
              </p>
            </div>
          </div>
        </div>
        <div class="col-md-4">
          <div class="card flex-md-row mb-4 box-shadow h-md-250">
            <div class="card-body d-flex flex-column align-items-start">
              <strong class="d-inline-block mb-2 text-warning"><i class="fas fa-circle"></i> Unstable</strong>
              <h3 class="mb-0 text-dark">Unomi <span class="text-muted">${latest.development.version}</span></h3>
              <div class="mb-1 text-muted">In development</div>
              <p class="card-text">
                <a href="manual/latest/index.html">online</a><br>
              </p>
            </div>
          </div>
        </div>
      </div>

      <h4 class="pt-4 mt-2 text-dark">Archives</h4>

      <div class="row mb-2">
        <div class="col-md-4">
          <div class="card flex-md-row mb-4 box-shadow h-md-250">
            <div class="card-body d-flex flex-column align-items-start">
              <strong class="d-inline-block mb-2 text-info"><i class="fas fa-circle"></i> Archive</strong>
              <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.5.0</span></h3>
              <div class="mb-1 text-muted">Last update: May 9th, 2020</div>
              <p class="card-text">
                <a href="manual/1_5_x/index.html">online</a><br>
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.5.0/unomi-manual-1_5_x.zip">html (zipped)</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/unomi/1.5.0/unomi-manual-1_5_x.zip.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.5.0/unomi-manual-1_5_x.zip.sha512">SHA512</a> ]<br>
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.5.0/unomi-manual-1_5_x.pdf">pdf</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/unomi/1.5.0/unomi-manual-1_5_x.pdf.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.5.0/unomi-manual-1_5_x.pdf.sha512">SHA512</a> ]
              </p>
            </div>
          </div>
        </div>
        <div class="col-md-4">
          <div class="card flex-md-row mb-4 box-shadow h-md-250">
            <div class="card-body d-flex flex-column align-items-start">
              <strong class="d-inline-block mb-2 text-info"><i class="fas fa-circle"></i> Archive</strong>
              <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.4.0</span></h3>
              <div class="mb-1 text-muted">Last update: May 24th, 2019</div>
              <p class="card-text">
                <a href="manual/1_4_x/index.html">online</a><br>
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.4.0/unomi-manual-1_4_x.zip">html (zipped)</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/unomi/1.4.0/unomi-manual-1_4_x.zip.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.4.0/unomi-manual-1_4_x.zip.sha512">SHA512</a> ]<br>
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.4.0/unomi-manual-1_4_x.pdf">pdf</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/unomi/1.4.0/unomi-manual-1_4_x.pdf.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/unomi/1.4.0/unomi-manual-1_4_x.pdf.sha512">SHA512</a> ]
              </p>
            </div>
          </div>
        </div>
        <div class="col-md-4">
          <div class="card flex-md-row mb-4 box-shadow h-md-250">
            <div class="card-body d-flex flex-column align-items-start">
              <strong class="d-inline-block mb-2 text-info"><i class="fas fa-circle"></i> Archive</strong>
              <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.3.0-incubating</span></h3>
              <div class="mb-1 text-muted">Last update: September 10, 2018</div>
              <p class="card-text">
                <a href="manual/1_3_x/index.html">online</a><br>
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.zip">html (zipped)</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.zip.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.zip.sha512">SHA512</a> ]<br>
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.pdf">pdf</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.pdf.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.pdf.sha512">SHA512</a> ]
              </p>
            </div>
          </div>
        </div>
        <div class="col-md-4">
          <div class="card flex-md-row mb-4 box-shadow h-md-250">
            <div class="card-body d-flex flex-column align-items-start">
              <strong class="d-inline-block mb-2 text-info"><i class="fas fa-circle"></i> Archive</strong>
              <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.2.0-incubating</span></h3>
              <div class="mb-1 text-muted">Last update: September 28, 2017</div>
              <p class="card-text">
                <a href="manual/1_2_x/index.html">online</a><br>
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.zip">html (zipped)</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.zip.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.zip.sha512">SHA512</a> ]<br>
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.pdf">pdf</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.pdf.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.pdf.sha512">SHA512</a> ]
              </p>
            </div>
          </div>
        </div>
        <div class="col-md-4">
          <div class="card flex-md-row mb-4 box-shadow h-md-250">
            <div class="card-body d-flex flex-column align-items-start">
              <strong class="d-inline-block mb-2 text-info"><i class="fas fa-circle"></i> Archive</strong>
              <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.1.0-incubating</span></h3>
              <div class="mb-1 text-muted">Last update: October 23, 2017</div>
              <p class="card-text">
                <a href="manual/1_1_x/index.html">online</a><br>
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.zip">html (zipped)</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.zip.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.zip.sha512">SHA512</a> ]<br>
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.pdf">pdf</a>
                [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.pdf.asc">PGP</a> |
                <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.pdf.sha512">SHA512</a> ]
              </p>
            </div>
          </div>
      </div>
      </div>
    </div>

      <!-- Marketing messaging and featurettes
      ================================================== -->
      <!-- Wrap the rest of the page in another container to center all the content. -->
      <div class="container">

        <!-- Migrating ES -->
        <div class="row mb-5 mt-5">
          <div class="col">
            <h2 class="pb-3 border-bottom">API Documentation</h2>
            <h3 class="pt-3 pb-2 text-dark">Javadoc</h3>
            <p>Click <a class="btn-link" target="_blank"
                        href="https://unomi.incubator.apache.org/unomi-api/apidocs/index.html">here</a> to view the Javadoc documentation</p>

            <h4 class="pt-4 pb-2 text-dark">REST</h4>

            <table class="table table-striped table-sm">
              <thead class="thead-dark">
                <th>Name</th>
                <th>Description</th>
                <th>REST API Documentation</th>
                <th>Since version</th>
                <th class="text-center">Status</th>
              </thead>
              <tbody>
                <tr>
                  <td><strong>userList</strong></td>
                  <td>Manage user</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/index.html#568140055" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>campaigns</strong></td>
                  <td>Manage campaign</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-241880339" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>cluster</strong></td>
                  <td>Manage cluster</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1007094421" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>definitions</strong></td>
                  <td>Manage definitions</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1834364863" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>goals</strong></td>
                  <td>Manage goal</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-379780403" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>profile</strong></td>
                  <td>Manage profile</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-1907885015" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>query</strong></td>
                  <td>Manage query</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#371361199" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>rules</strong></td>
                  <td>Manage rule</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-1505954579" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>scoring</strong></td>
                  <td>Manage scoring</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-1379828888" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>segments</strong></td>
                  <td>Manage segment</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1558745832" target="_blank">view</a></td>
                  <td>1.3.0-incubating</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>patches</strong></td>
                  <td>Manage patch</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#943335618" target="_blank">view</a></td>
                  <td>1.4.0</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
                <tr>
                  <td><strong>events</strong></td>
                  <td>Manage event</td>
                  <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1768188821" target="_blank">view</a></td>
                  <td>1.4.0</td>
                  <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong>
                </tr>
              </tbody>
            </table>
          </div><!-- /.blog-main -->
        </div>

        <!-- Migrating ES -->
        <div class="row mb-5 mt-5">
          <div class="col">
            <h2 class="pb-3 mb-3 border-bottom">Migrating ElasticSearch</h2>
            <h3 class="mb-3 text-dark">Introduction</h3>
            <p>
              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.
            </p>

            <h3 class="pt-3 mb-3 text-dark">General steps and notions</h3>
            <p>
              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.
            </p>
            <h4 class="mb-2">Standalone (one node migration)</h4>
            <p>
              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 <code>config/elasticsearch.yml</code> file over to the new version.
            </p>
            <h4 class="mb-2">Cluster migration</h4>
            <p>
              Here we recommend you read the <a target="_blank" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html">official upgrading documentation</a>.
            </p>

            <h3 class="pt-3 mb-3 text-dark">Migrating between versions used by Apache Unomi.</h3>
            <h4 class="mb-2">Cluster migration</h4>
            <p>
              Steps:
            </p>
            <ol>
              <li>Depending on your install, perform either the standalone or cluster migration</li>
              <li>That's it !</li>
            </ol>
          </div><!-- /.blog-main -->
        </div>

        <div class="row mb-5 mt-5">
          <div class="col">
            <h2 class="pb-3 mb-3 border-bottom">Security Advisories</h2>
            <p>
              <a href="security/cve-2020-11975.txt">CVE-2020-11975</a> : Remote Code Execution in Apache Unomi
            </p>
            <p>
              <a href="security/cve-2020-13942.txt">CVE-2020-13942</a> : Remote Code Execution in Apache Unomi
            </p>
            <p>
              <a href="security/cve-2021-31164.txt">CVE-2021-31164</a> : CRLF Log injection in Apache Unomi
            </p>
          </div>
        </div>


      </div><!-- /.container -->