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

Install Couchbase Lite for C

      +

      Description — Installing Couchbase Lite for C

      Steps in Getting Started

      Install | Build and Run

      Download

      Couchbase Lite for C 3.1.10 is available for all supported platforms — see: Platform Availability.

      You can obtain the downloads here:

      The binary release download comprises a root directory (libcblite-community), which contains:

      • For Linux, Windows, Android, and Mac OS:

        • lib —  the core library binaries

        • include —  the header files for inclusion

        • bin — the Couchbase Lite for C .dll files (Microsoft  Windows-only) .

      • For iOS, an xcframework.

      Debug Symbols

      Debug symbol versions are available for all desktop variants of C (Windows, macOS, Debian, Ubuntu and Raspbian) - see: downloads table.

      For Android and iOS the symbols are incorporated in the standard release package.
      Installation:

      Install for Linux (APT)  |  Install for Linux (.deb)  |  Install for Windows  |  Install for macOS  |  Install for iOS  |  Install for Android

      Install for Linux

      Using APT

      Using the Advanced Package Tool (apt) is the easiest way to install Couchbase Lite on Ubuntu and Debian platforms. Just download the meta package that apt requires to automatically get and install Couchbase Lite, including any dependencies.

      1. Download the meta package

        • curl

        • wget

        curl -O https://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-noarch.deb
        wget https://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-noarch.deb

      2. Install the meta package

        • apt

        • dpkg

        sudo apt install ./couchbase-release-1.0-noarch.deb
        sudo dpkg -i ./couchbase-release-1.0-noarch.deb

      3. Update the local package database

        sudo apt update

      4. Install the required release package(s)

        • Enterprise

        • Community

        Runtime Only
        sudo apt install libcblite
        Development
        sudo apt install libcblite-dev
        Runtime Only
        sudo apt install libcblite-community
        Development
        sudo apt install libcblite-dev-community

      That’s it. At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C

      Using .deb Package

      Use your package manager to install from a local .deb file.

      1. Just wget the appropriate .deb package  — see downloads table for a package URL.

      2. Install the package and its dependency, using apt install

        • For community version:

          sudo apt install ./libcblite-community

sudo apt install ./libcblite-dev-community

        • For enterprise version:

          sudo apt install ./libcblite

sudo apt install ./libcblite-dev

      3. That’s it.
        You just need to pass the -lcblite command-line flag to the compiler when you build.

      At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C

      Install for Windows

      To install the Couchbase for C libraries on Windows from a downloaded release binary:

      1. Download and extract the release package — see: Mobile & Edge

      2. From within the root directory, libcblite-community, deploy the lib, include and bin libraries to a location accessible to your compiler.

      3. Within Visual Studio:

        1. Create a new C++ project

          Be sure to select x64 for 64-bit builds

        2. Within Project Properties → C++ directories → Library Directories, Add <path-to-deployed-directories>/lib

        3. Within Project Properties → C++ directories → Include Directories, Add <path-to-deployed-directories>/include

        4. Within Project Properties → Linker → Input → Additional Dependencies, Add cblite.lib

      4. Copy <path-to-deployed-directories>/bin/cblite.dll to your build location

        Couchbase Lite for C does not have any preferred installation path for the .dll. It is up to you to determine where best to place it so it is available during execution, though copying to a location on the system path is not recommended on Windows

      Install for macOS

      Install with Homebrew

      Simplified installation using Homebrew

      • brew install libcblite

      • brew install libcblite-community

      To install the Couchbase for C libraries on macOS from a downloaded release package:

      1. Download and extract the release package here — downloads table.

      2. Optionally …​ From within the root directory, libcblite-community, Copy the include and lib directories to /usr/local/

      3. Within Xcode:

        1. Create a new project

        2. Add <path/to>/include to the project’s Header Search Path

        3. Add <path/to>/lib to the project’s Library Search Path

        4. Drag libcblite-community.dylib into your Xcode project. Then, within the dialog:

          1. Select Create Directory References If Needed

          2. Check the correct target is selected

      At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C

      Install for iOS

      To install the Couchbase for C libraries for iOS from a downloaded release package:

      1. Download and extract the release package here — Mobile & Edge

      2. Drag CouchbaseLite.xcframework into your Xcode project, then within the dialog:

        1. Select Create Directory References If Needed

        2. Check the correct target is selected

      At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C

      If you encounter a build error — Include of non-modular header inside framework module — You may need to change the build setting allow non-modular includes in framework module to Yes.

      Install for Android

      This install assumes use of the Android Studio IDE. In addition to the Couchbase Lite for C download you also require the following tool chain dependencies, all installable from within Android Studio if necessary:

      • CMake 3.18.1

      • NDK 21.4.7075529

      • Build tools 30.0.2

      In this instance the release comprises a ready to adapt application project.

      1. Download and Unpack the binary release here — Mobile & Edge

      2. Within Android Studio, select and open the project folder (within the libcblite-community folder)

      3. Tools  SDK Manager  SDK Tools

      4. Check the above dependencies are installed, select any that are not
        OK to Continue

      Once the install is finished, you can build and run this skeleton app.

      At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C

      Platform Availability

      Couchbase Lite for C is available on the platforms shown in the tables below.

      Deprecation Notice

      Support for the following will be deprecated in this release and will be removed in a future release:

      • macOS

        • 11 - Big Sur

      • Apple OS X

        • v10.14 - Mojave

        • v10.15 - Catalina

      • iOS - 10,11

      • CentOS - All versions

      • RedHat - 7/8

      • Ubuntu - 16, 18.04

      • Microsoft Server - 2016,2019

      • Debian - 9

      • Raspbian - 9

      Please plan to migrate your apps to use an appropriate alternative version.

      Android

      API x86 x64 ARM 32 ARM 64

      22+

      yes

      yes

      yes

      yes

      iOS

      Version x86 x64 ARM 32 ARM 64

      10+

      yes

      yes

      yes

      yes

      Mac OS

      Version x64 ARM 64

      OSX 10.14 (Mojave)

      yes

      yes

      Linux

      Distro Version x64 ARM 32 ARM 64

      Debian

      9

      yes

      yes

      yes

      10

      yes

      yes

      yes

      Raspberry Pi OS

      10

      yes

      yes

      Raspbian

      9

      yes

      Ubuntu

      20.04

      yes

      yes

      yes

      Windows

      Version x64

      Desktop

      10+

      yes

      Download Links

      Couchbase Lite for C is available for all Supported Platforms. You can obtain downloads for Linux and macOS from the links here in the downloads table.

      Release 3.1.10

      Available platforms are:

      MacOS | Windows | Debian | Ubuntu |

      MacOS

      Windows

      Debian

      Download link table

      • Enterprise Edition

      • Community Edition

      Platform Download SHA Debug Symbols

      Debian

      couchbase-lite-c-enterprise-3.1.10-linux-arm64.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-arm64.tar.gz.sha256

      couchbase-lite-c-enterprise-3.1.10-linux-arm64-symbols.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-armhf.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-armhf.tar.gz.sha256

      couchbase-lite-c-enterprise-3.1.10-linux-armhf-symbols.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-x86_64.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-x86_64.tar.gz.sha256

      couchbase-lite-c-enterprise-3.1.10-linux-x86_64-symbols.tar.gz

      libcblite-enterprise_3.1.10-debian11_amd64.deb

      libcblite-enterprise_3.1.10-debian11_amd64.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian11_amd64.deb

      libcblite-dev-enterprise_3.1.10-debian11_amd64.deb.sha256

      libcblite-enterprise_3.1.10-debian11_arm64.deb

      libcblite-enterprise_3.1.10-debian11_arm64.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian11_arm64.deb

      libcblite-dev-enterprise_3.1.10-debian11_arm64.deb.sha256

      libcblite-enterprise_3.1.10-debian11_armhf.deb

      libcblite-enterprise_3.1.10-debian11_armhf.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian11_armhf.deb

      libcblite-dev-enterprise_3.1.10-debian11_armhf.deb.sha256

      libcblite-enterprise_3.1.10-debian10_amd64.deb

      libcblite-enterprise_3.1.10-debian10_amd64.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian10_amd64.deb

      libcblite-dev-enterprise_3.1.10-debian10_amd64.deb.sha256

      libcblite-enterprise_3.1.10-debian10_arm64.deb

      libcblite-enterprise_3.1.10-debian10_arm64.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian10_arm64.deb

      libcblite-dev-enterprise_3.1.10-debian10_arm64.deb.sha256

      libcblite-enterprise_3.1.10-debian10_armhf.deb

      libcblite-enterprise_3.1.10-debian10_armhf.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian10_armhf.deb

      libcblite-dev-enterprise_3.1.10-debian10_armhf.deb.sha256

      libcblite-enterprise_3.1.10-debian9_amd64.deb

      libcblite-enterprise_3.1.10-debian9_amd64.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian9_amd64.deb

      libcblite-dev-enterprise_3.1.10-debian9_amd64.deb.sha256

      libcblite-enterprise_3.1.10-debian9_armhf.deb

      libcblite-enterprise_3.1.10-debian9_armhf.deb.sha256

      libcblite-dev-enterprise_3.1.10-debian9_armhf.deb

      libcblite-dev-enterprise_3.1.10-debian9_armhf.deb.sha256
      Platform Download SHA Debug Symbols

      Debian

      couchbase-lite-c-community-3.1.10-linux-arm64.tar.gz

      couchbase-lite-c-community-3.1.10-linux-arm64.tar.gz.sha256

      couchbase-lite-c-community-3.1.10-linux-arm64-symbols.tar.gz

      couchbase-lite-c-community-3.1.10-linux-armhf.tar.gz

      couchbase-lite-c-community-3.1.10-linux-armhf.tar.gz.sha256

      couchbase-lite-c-community-3.1.10-linux-armhf-symbols.tar.gz

      couchbase-lite-c-community-3.1.10-linux-x86_64.tar.gz

      couchbase-lite-c-community-3.1.10-linux-x86_64.tar.gz.sha256

      couchbase-lite-c-community-3.1.10-linux-x86_64-symbols.tar.gz

      libcblite-community_3.1.10-debian11_amd64.deb

      libcblite-community_3.1.10-debian11_amd64.deb.sha256

      libcblite-dev-community_3.1.10-debian11_amd64.deb

      libcblite-dev-community_3.1.10-debian11_amd64.deb.sha256

      libcblite-community_3.1.10-debian11_arm64.deb

      libcblite-community_3.1.10-debian11_arm64.deb.sha256

      libcblite-dev-community_3.1.10-debian11_arm64.deb

      libcblite-dev-community_3.1.10-debian11_arm64.deb.sha256

      libcblite-community_3.1.10-debian11_armhf.deb

      libcblite-community_3.1.10-debian11_armhf.deb.sha256

      libcblite-dev-community_3.1.10-debian11_armhf.deb

      libcblite-dev-community_3.1.10-debian11_armhf.deb.sha256

      libcblite-community_3.1.10-debian10_amd64.deb

      libcblite-community_3.1.10-debian10_amd64.deb.sha256

      libcblite-dev-community_3.1.10-debian10_amd64.deb

      libcblite-dev-community_3.1.10-debian10_amd64.deb.sha256

      libcblite-community_3.1.10-debian10_arm64.deb

      libcblite-community_3.1.10-debian10_arm64.deb.sha256

      libcblite-dev-community_3.1.10-debian10_arm64.deb

      libcblite-dev-community_3.1.10-debian10_arm64.deb.sha256

      libcblite-community_3.1.10-debian10_armhf.deb

      libcblite-community_3.1.10-debian10_armhf.deb.sha256

      libcblite-dev-community_3.1.10-debian10_armhf.deb

      libcblite-dev-community_3.1.10-debian10_armhf.deb.sha256

      libcblite-community_3.1.10-debian9_amd64.deb

      libcblite-community_3.1.10-debian9_amd64.deb.sha256

      libcblite-dev-community_3.1.10-debian9_amd64.deb

      libcblite-dev-community_3.1.10-debian9_amd64.deb.sha256

      libcblite-community_3.1.10-debian9_armhf.deb

      libcblite-community_3.1.10-debian9_armhf.deb.sha256

      libcblite-dev-community_3.1.10-debian9_armhf.deb

      libcblite-dev-community_3.1.10-debian9_armhf.deb.sha256

      Ubuntu

      Download link table

      • Enterprise Edition

      • Community Edition

      Platform Download SHA Debug Symbols

      Ubuntu

      couchbase-lite-c-enterprise-3.1.10-linux-arm64.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-arm64.tar.gz.sha256

      couchbase-lite-c-enterprise-3.1.10-linux-arm64-symbols.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-armhf.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-armhf.tar.gz.sha256

      couchbase-lite-c-enterprise-3.1.10-linux-armhf-symbols.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-x86_64.tar.gz

      couchbase-lite-c-enterprise-3.1.10-linux-x86_64.tar.gz.sha256

      couchbase-lite-c-enterprise-3.1.10-linux-x86_64-symbols.tar.gz

      libcblite-enterprise_3.1.10-ubuntu22.04_amd64.deb

      libcblite-enterprise_3.1.10-ubuntu22.04_amd64.deb.sha256

      libcblite-dev-enterprise_3.1.10-ubuntu22.04_amd64.deb

      libcblite-dev-enterprise_3.1.10-ubuntu22.04_amd64.deb.sha256

      libcblite-enterprise_3.1.10-ubuntu22.04_arm64.deb

      libcblite-enterprise_3.1.10-ubuntu22.04_arm64.deb.sha256

      libcblite-dev-enterprise_3.1.10-ubuntu22.04_arm64.deb

      libcblite-dev-enterprise_3.1.10-ubuntu22.04_arm64.deb.sha256

      libcblite-enterprise_3.1.10-ubuntu22.04_armhf.deb

      libcblite-enterprise_3.1.10-ubuntu22.04_armhf.deb.sha256

      libcblite-dev-enterprise_3.1.10-ubuntu22.04_armhf.deb

      libcblite-dev-enterprise_3.1.10-ubuntu22.04_armhf.deb.sha256

      libcblite-enterprise_3.1.10-ubuntu20.04_amd64.deb

      libcblite-enterprise_3.1.10-ubuntu20.04_amd64.deb.sha256

      libcblite-dev-enterprise_3.1.10-ubuntu20.04_amd64.deb

      libcblite-dev-enterprise_3.1.10-ubuntu20.04_amd64.deb.sha256

      libcblite-enterprise_3.1.10-ubuntu20.04_arm64.deb

      libcblite-enterprise_3.1.10-ubuntu20.04_arm64.deb.sha256

      libcblite-dev-enterprise_3.1.10-ubuntu20.04_arm64.deb

      libcblite-dev-enterprise_3.1.10-ubuntu20.04_arm64.deb.sha256

      libcblite-enterprise_3.1.10-ubuntu20.04_armhf.deb

      libcblite-enterprise_3.1.10-ubuntu20.04_armhf.deb.sha256

      libcblite-dev-enterprise_3.1.10-ubuntu20.04_armhf.deb

      libcblite-dev-enterprise_3.1.10-ubuntu20.04_armhf.deb.sha256
      Platform Download SHA Debug Symbols

      Ubuntu

      couchbase-lite-c-community-3.1.10-linux-arm64.tar.gz

      couchbase-lite-c-community-3.1.10-linux-arm64.tar.gz.sha256

      couchbase-lite-c-community-3.1.10-linux-arm64-symbols.tar.gz

      couchbase-lite-c-community-3.1.10-linux-armhf.tar.gz

      couchbase-lite-c-community-3.1.10-linux-armhf.tar.gz.sha256

      couchbase-lite-c-community-3.1.10-linux-armhf-symbols.tar.gz

      couchbase-lite-c-community-3.1.10-linux-x86_64.tar.gz

      couchbase-lite-c-community-3.1.10-linux-x86_64.tar.gz.sha256

      couchbase-lite-c-community-3.1.10-linux-x86_64-symbols.tar.gz

      libcblite-community_3.1.10-ubuntu22.04_amd64.deb

      libcblite-community_3.1.10-ubuntu22.04_amd64.deb.sha256

      libcblite-dev-community_3.1.10-ubuntu22.04_amd64.deb

      libcblite-dev-community_3.1.10-ubuntu22.04_amd64.deb.sha256

      libcblite-community_3.1.10-ubuntu22.04_arm64.deb

      libcblite-community_3.1.10-ubuntu22.04_arm64.deb.sha256

      libcblite-dev-community_3.1.10-ubuntu22.04_arm64.deb

      libcblite-dev-community_3.1.10-ubuntu22.04_arm64.deb.sha256

      libcblite-community_3.1.10-ubuntu22.04_armhf.deb

      libcblite-community_3.1.10-ubuntu22.04_armhf.deb.sha256

      libcblite-dev-community_3.1.10-ubuntu22.04_armhf.deb

      libcblite-dev-community_3.1.10-ubuntu22.04_armhf.deb.sha256

      libcblite-community_3.1.10-ubuntu20.04_amd64.deb

      libcblite-community_3.1.10-ubuntu20.04_amd64.deb.sha256

      libcblite-dev-community_3.1.10-ubuntu20.04_amd64.deb

      libcblite-dev-community_3.1.10-ubuntu20.04_amd64.deb.sha256

      libcblite-community_3.1.10-ubuntu20.04_arm64.deb

      libcblite-community_3.1.10-ubuntu20.04_arm64.deb.sha256

      libcblite-dev-community_3.1.10-ubuntu20.04_arm64.deb

      libcblite-dev-community_3.1.10-ubuntu20.04_arm64.deb.sha256

      libcblite-community_3.1.10-ubuntu20.04_armhf.deb

      libcblite-community_3.1.10-ubuntu20.04_armhf.deb.sha256

      libcblite-dev-community_3.1.10-ubuntu20.04_armhf.deb

      libcblite-dev-community_3.1.10-ubuntu20.04_armhf.deb.sha256

      Raspbian

      Please use the Debian .deb download choosing the appropriate version (debian9 or debian10) and architecture.

      Related Content

      How to . . .
      Learn more . . .
      Dive Deeper . . .

      Mobile Forum | Blog | Tutorials