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.

Edge Server Configuration

    Configure Couchbase Edge Server using a JSON configuration file.

    The configuration file is parsed as JSON5 format.

    Minimal Configuration

    The following is the minimum configuration required to start Couchbase Edge Server with a single local database and enable client sync connections.

    {
  databases: {
    my-database: {
      path: "/var/lib/edge-server/my-database.cblite2",
      create: true,
      enable_client_sync: true
    }
  },
  interface: "0.0.0.0:59840",
  users: "/etc/edge-server/users.json"
}

    For a full reference of all configuration properties and their default values, see Edge Server Configuration Schema.

    Configuration Examples

    The following examples show common Couchbase Edge Server configuration scenarios. All examples use JSON5 format, which permits comments and unquoted keys.

    Continuous Replication to Sync Gateway

    A configuration that replicates a local database to a remote {sync-gateway-name} instance using basic auth, with a continuous bidirectional replication.

    {
  databases: {
    travel-sample: {
      path: "/var/lib/edge-server/travel-sample.cblite2",
      create: true,
      enable_client_sync: "bidirectional"
    }
  },
  interface: "0.0.0.0:59840",
  users: "/etc/edge-server/users.json",
  replications: [
    {
      source: "travel-sample",
      target: "wss://sync-gateway.example.com/travel-sample",
      continuous: true,
      auth: {
        user: "replicator",
        password: "s3cr3t"
      }
    }
  ]
}

    TLS and File Logging

    A production-oriented configuration with TLS enabled and file-based logging.

    {
  databases: {
    my-database: {
      path: "/var/lib/edge-server/my-database.cblite2",
      create: true,
      enable_client_sync: true
    }
  },
  interface: "0.0.0.0:59840",
  users: "/etc/edge-server/users.json",
  https: {
    tls_cert_path: "/etc/edge-server/server.crt",
    tls_key_path: "/etc/edge-server/server.key"
  },
  logging: {
    console: false,
    file: {
      dir: "/var/log/edge-server",
      format: "text",
      maxSize: 5000000,
      rotateCount: 5
    }
  }
}

    See Also