budibase/couchdb

CouchDB 3.X (Budibase专用) Docker镜像文档

镜像概述

本镜像基于CouchDB 3.X构建，集成OpenJDK JRE 8运行环境及Clouseau搜索服务（[*] Query Server, SQS，https://neighbourhood.ie/products-and-services/structured-query-server%EF%BC%89%E4%BB%A5%E6%8F%90%E4%BE%9BSQL%E6%9F%A5%E8%AF%A2%E8%83%BD%E5%8A%9B%E3%80%82**%E6%B3%A8%E6%84%8F%EF%BC%9A%E6%9C%AC%E9%95%9C%E5%83%8F%E9%9D%9E%E9%80%9A%E7%94%A8CouchDB%E9%95%9C%E5%83%8F%EF%BC%8C%E4%B8%BB%E8%A6%81%E4%BD%9C%E4%B8%BABudibase%E5%9F%BA%E7%A1%80%E9%95%9C%E5%83%8F%EF%BC%88%E5%A6%82budibase/budibase%EF%BC%8Chttps://hub.docker.com/r/budibase/budibase%EF%BC%89%E4%BD%BF%E7%94%A8%E3%80%82

核心功能与特性

• 基础环境：基于CouchDB 3.X，提供稳定的文档数据库服务。
• 运行时依赖：集成OpenJDK JRE 8，满足Clouseau及SQS的Java运行需求。
• 搜索能力：内置Clouseau服务，支持CouchDB全文搜索功能。
• 预配置优化：默认q值为1（每个数据库仅1个分片），适配大量数据库场景。
• SQL查询支持：集成Structured Query Server (SQS)，提供SQL语法查询数据库的能力。

使用场景与适用范围

适用场景

• Budibase应用的部署环境，作为底层数据库服务。
• Budibase开发或测试环境的数据库依赖。
• 需要CouchDB 3.X基础上集成搜索及SQL查询能力的Budibase相关场景。

不适用范围

• 不建议作为通用CouchDB镜像用于非Budibase场景。
• 对多分片（q>1）或复杂集群配置有需求的场景（需手动调整配置）。

使用方法

基本使用（docker run）

通过docker run命令启动容器，示例如下（基础配置）：

bash
docker run -d \
  --name budibase-couchdb \
  -p 5984:5984 \  # CouchDB默认端口
  -v ./couchdb-data:/opt/couchdb/data \  # 数据持久化
  -e COUCHDB_USER=admin \  # 管理员用户名
  -e COUCHDB_PASSWORD=password \  # 管理员密码
  budibase/couchdb:latest  # 替换为具体版本标签

参数说明

• -p 5984:5984：映射CouchDB HTTP API端口到宿主机。
• -v ./couchdb-data:/opt/couchdb/data：挂载数据目录，避免容器重启后数据丢失。
• 环境变量COUCHDB_USER/COUCHDB_PASSWORD：设置CouchDB管理员账户（若不指定，默认无认证，不建议生产环境使用）。

使用docker-compose部署

在Budibase应用栈中集成时，可通过docker-compose.yml配置（示例片段）：

yaml
version: '3'
services:
  couchdb:
    image: budibase/couchdb:latest  # 替换为具体版本标签
    container_name: budibase-couchdb
    ports:
      - "5984:5984"
    volumes:
      - couchdb-data:/opt/couchdb/data
    environment:
      - COUCHDB_USER=admin
      - COUCHDB_PASSWORD=securepassword
    restart: unless-stopped

volumes:
  couchdb-data:  # 命名卷，持久化数据

配置说明

预配置参数

• 数据库分片配置：默认q=1（每个数据库1个分片），通过CouchDB配置文件/opt/couchdb/etc/couchdb.ini中的[cluster] q = 1定义，无需手动设置。

环境变量

支持CouchDB官方环境变量（具体可参考CouchDB文档），常用变量如下：

• COUCHDB_USER：管理员用户名（必填，生产环境建议设置）。
• COUCHDB_PASSWORD：管理员密码（必填，生产环境建议设置）。
• COUCHDB_SECRET：集群共享密钥（多节点集群时需配置）。
• NODENAME：节点名称（默认couchdb@localhost，集群环境需修改）。

SQS服务配置

SQS服务默认随容器启动，提供SQL查询能力，无需额外配置。若需调整SQS参数，可通过修改容器内/opt/sqs/conf/sqs.ini文件（需通过数据卷挂载或自定义Dockerfile调整）。

许可证信息

本镜像中Structured Query Server (SQS) 的许可证信息详见：https://github.com/Budibase/budibase/blob/master/SQS_LICENSE
CouchDB及其他组件遵循各自开源许可证。