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.

Install and Verify

      +
      Install Couchbase Edge Server for use in your applications.

      Installation Process

      You can install Couchbase Edge Server on any of the supported platforms.

      Install for Linux

      Download

      Download the required edition of Couchbase Edge Server from the downloads page.

      Install

      Follow the appropriate install option from the methods shown.

      • Ubuntu

      • Debian

      • Fedora

      Install Couchbase Edge Server with apt:

      apt install couchbase-edge-server_1.0.0_amd64.deb

      Install the debug symbols:

      apt install couchbase-edge-server-dbgsym_1.0.0_amd64.deb

      Install Couchbase Edge Server with the dpkg package manager:

      dpkg install couchbase-edge-server_1.0.0_amd64.deb

      Install the debug symbols:

      dpkg install couchbase-edge-server-dbgsym_1.0.0_amd64.deb

      Install Couchbase Edge Server with the DNF package manager:

      dnf install couchbase-edge-server-1.0.0-x86_64.rpm

      Install the debug symbols:

      dnf install couchbase-edge-server-debuginfo-1.0.0-x86_64.rpm

      Install for macOS

      Download

      Download the required edition of Couchbase Edge Server from the downloads page.

      Install

      Unzip the package into your preferred file location using the following command:

      unzip -d couchbase-edge-server-1.0.0-macos.zip

      Run and Verify Your Installation

      On Linux operating systems, an instance of Couchbase Edge Server starts running automatically post-installation. For macOS, invoke the binary using the path to your configuration file as an argument.

      To start Couchbase Edge Server you invoke the executable with the path to its configuration file.

      You can define a configuration file yourself or use this minimal configuration file as a starting point. Make sure you define the path variable as the file-path to your database file.

      The configuration file is parsed as JSON5 format. 
      {
    "$schema": "https://packages.couchbase.com/couchbase-edge-server/config_schema.json",
    "databases": {
        "db": {
            "path":  "/path/to/db.cblite2",
            "create": true,                     // database file will be created if missing
            "enable_client_writes": true,       // database is writeable by PUT, POST, DELETE
            "enable_client_sync": true          // Clients can push and/or pull
        },
    },
    "enable_anonymous_users": true              // no HTTP auth needed
}
      Couchbase does not recommend setting enable_adhoc_queries to true for production environments.

      After creating your configuration file, you can run Couchbase Edge Server by invoking it at its file location.

      ./couchbase-edge-server /path/to/config.json

      You can verify the installation by following this example to confirm Couchbase Edge Server is listening to a given port:

      Verification Example

      In this example:

      • $BASEURL is the protocol and host for Couchbase Edge Server, for example http://localhost.

      Request
      curl "$BASEURL:59840"

      Running Couchbase Edge Server with Fedora

      When running the Edge Server on Fedora, external connections may be blocked due to firewall settings. If you encounter a connection refused error when accessing the server, ensure that the firewall allows traffic on the configured port.

      Allowing External Connections
      To open the necessary port (e.g., 59840):
      sudo firewall-cmd --zone=FedoraServer --add-port=59840/tcp --permanent sudo firewall-cmd --reload

      If you’re using FedoraWorkstation, make sure to assign your network interface to that zone:

      sudo nmcli connection modify "your-network-interface" connection.zone "FedoraWorkstation"
      sudo systemctl restart NetworkManager

      After updating the firewall settings, restart the server and test connectivity by confirming whether Couchbase Edge Server is listening to a given port:

      In this example:

      • $BASEURL is the protocol and host for Couchbase Edge Server, for example http://localhost.

      Request
      curl "$BASEURL:59840"

      See Also