Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Couchbase Lite on Java — Prerequisites

    Description — Couchbase Lite on Java — a framework for developing offline-first Java applications for mobile and edge
    Abstract — This content identities the pre-requisites and preparatory steps to be considered before installing Couchbase Lite for java

    Vector Search Prerequisites

    To use Vector Search, you must have Couchbase Lite installed and add the Vector Search extension to your Couchbase Lite application. Vector Search is available only for 64-bit architectures and Intel processors that support the Advanced Vector Extensions 2 (AVX2) instruction set. To verify whether your device supports the AVX2 instructions set, follow these instructions.

    Introduction

    Couchbase Lite enables development and deployment of Couchbase Lite applications to a JVM environment. You can deploy to a desktop or web server (for example, Tomcat), including embedded Tomcat deployments.

    We use Intellij IDEA, gradle, Maven and Tomcat as tools to build and run the examples presented in this content. You are free to use the tools of your choice.

    Install Server Software

    If you want to use Couchbase Lite with Couchbase Server and-or _Sync Gateway you will need to have installed operational instances of these before completing the installation and test build steps.

    So, If you have not already done so, see Prepare Sync Gateway

    • Within Couchbase Server, create a bucket named getting-started.cblite2

    • Create a RBAC user for _Sync Gateway with username = sync-gateway and password = password

    MacOS and Windows

    You may now proceed directly to Couchbase Lite on Java — Installing.

    Additional Steps For Linux

    Before proceeding to Couchbase Lite on Java — Installing, you will need to make the supplied support libraries available to your running application.

    Steps

    1. Download the zip file from here — https://packages.couchbase.com/releases/couchbase-lite-java/3.2.4/couchbase-lite-java-linux-supportlibs-3.2.4.zip .

    2. Unpack the downloaded file to a location accessible to your build and runtime environments, for example your_dir/couchbase-lite-java-3.2.4.

    1. Set up the Native Libraries for Linux. You will need to add the path of the directory containing the unpacked support libraries to the value of the Java system property java.library.path.

      The simplest way to set this is through the shell variable LD_LIBRARY_PATH:

      export LD_LIBRARY_PATH=<your_dir>/couchbase-lite-java-3.2.4/:$LD_LIBRARY_PATH

      Where <your_dir> is the path where you unpacked the support libraries in step 2.

      This environment variable must be set before running your Java application that uses Couchbase Lite.

    • Web Service/Tomcat

    • Desktop

    Add the variables to your $CATALINA_BASE/bin/setenv.sh. (If the setenv.sh file doesn’t exist, you will need to create a new file.)

    LD_LIBRARY_PATH="$LD_LIBRARY_PATH:"

    Export the variable in your .bashrc file:

    export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:"

    Please refer to the Linux Platform Support section for the minimum version requirements of those libraries.

    Related Content

    How to . . .

    .

    Learn more . . .

    .

    Dive Deeper . . .

    Mobile Forum | Blog | Tutorials

    .