ravendb/ravendb-nightly

RavenDB Docker 镜像技术文档

镜像概述和主要用途

RavenDB Docker 镜像提供两种版本：基于 Ubuntu 的 Linux 容器版本和基于 Windows Nanoserver 的 Windows 容器版本，用于部署 RavenDB 4.0 NoSQL 数据库。镜像支持持久化存储、灵活配置及跨平台部署，适用于开发、测试及生产环境。

核心功能和特性

• 跨平台支持：提供 Linux（Ubuntu 16.04）和 Windows（Nanoserver）容器版本，适配不同操作系统环境。
• 持久化存储：通过 Docker 卷实现配置文件和数据库数据的持久化，确保数据不丢失。
• 多方式配置：支持环境变量、配置文件（settings.json）及命令行参数（CLI）配置，优先级依次为环境变量 > 配置文件 > CLI 参数。
• 安全控制：可通过配置启用/禁用安装向导、设置无安全验证模式（开发环境）及自定义访问权限。
• 日志管理：支持控制台日志输出，可通过环境变量调整日志级别。

使用场景和适用范围

• 本地开发/测试：快速启动无安全验证的 RavenDB 实例，用于功能验证和调试。
• 自动化部署：通过 Docker Compose 或 CI/CD 工具集成，实现标准化部署流程。
• 生产环境：配置持久化存储、自定义安全策略及日志监控，满足生产级稳定性需求。
• 多节点集群：通过 TCP 端口配置，支持跨容器/主机的 RavenDB 集群部署。

使用方法和配置说明

镜像标签说明

注： nightly 构建版本可从 https://hub.docker.com/r/ravendb/ravendb-nightly/ 获取。

基本运行命令

Linux 容器（Ubuntu 基础）

bash
docker run -p 8080:8080 ravendb/ravendb:ubuntu-latest

Windows 容器（Nanoserver 基础）

powershell
docker run -p 8080:8080 ravendb/ravendb:windows-nanoserver-latest

PowerShell 脚本使用（简化配置）

官方提供脚本简化容器配置，支持通过参数调整 RavenDB 运行模式：

• Ubuntu 容器脚本：https://github.com/ravendb/ravendb/blob/v4.0/docker/run-ubuntu1604.ps1
• Windows 容器脚本：https://github.com/ravendb/ravendb/blob/v4.0/docker/run-nanoserver.ps1

脚本参数说明

Docker Compose 示例

以下为 Linux 容器的 docker-compose.yml 示例，配置持久化数据卷及无安全验证模式：

yaml
version: '3'
services:
  ravendb:
    image: ravendb/ravendb:ubuntu-latest
    ports:
      - "8080:8080"   # HTTP 服务端口
      - "38888:38888" # TCP 集群端口
    volumes:
      - ./ravendb-data:/opt/RavenDB/Server/RavenData  # 数据卷（主机目录挂载）
      - ./ravendb-config:/opt/RavenDB/config          # 配置卷（主机目录挂载）
    environment:
      - RAVEN_Setup_Mode='None'                       # 禁用安装向导
      - RAVEN_Security_UnsecuredAccessAllowed='PrivateNetwork'  # 允许私有网络无安全访问
      - RAVEN_Logs_Mode='Information'                 # 日志级别设为 Information
      - RAVEN_ARGS='--log-to-console'                 # 启用控制台日志输出

Docker 卷说明

RavenDB 镜像使用两个专用卷实现持久化，路径因容器类型而异：

1. 配置卷（存储 RavenDB 配置文件）

• Ubuntu 容器：/opt/RavenDB/config
• Windows 容器：C:\RavenDB\Config

2. 数据卷（存储数据库数据）

• Ubuntu 容器：/opt/RavenDB/Server/RavenData
• Windows 容器：C:/RavenDB/Server/RavenData

配置说明

RavenDB 支持三种配置方式，优先级从高到低为：环境变量 > settings.json 配置文件 > CLI 参数。

环境变量配置

所有以 RAVEN_ 为前缀的环境变量会被解析为 RavenDB 配置项，格式为 RAVEN_<Section>_<Key>='Value'。例如：

配置文件（settings.json）

通过挂载配置卷，可将主机的 settings.json 映射到容器配置目录。配置文件示例：

json
{
  "Setup": {
    "Mode": "None"  // 禁用安装向导
  },
  "Security": {
    "UnsecuredAccessAllowed": "PrivateNetwork"  // 允许私有网络无安全访问
  },
  "Logs": {
    "Mode": "Information"  // 日志级别设为 Information
  }
}

注：配置文件路径需通过 --config-path CLI 参数指定（见下文 CLI 参数）。

CLI 参数

通过 RAVEN_ARGS 环境变量传递 CLI 参数，例如：

bash
RAVEN_ARGS='--log-to-console --config-path /opt/RavenDB/config/custom-settings.json'

• --log-to-console：启用控制台日志输出（支持 docker logs 查看）。
• --config-path <PATH>：指定自定义配置文件路径（需通过卷挂载至容器）。

常见问题（FAQ）

1. 如何在自动化部署中禁用安装向导？

设置环境变量 RAVEN_Setup_Mode='None'，或在 settings.json 中配置 "Setup": { "Mode": "None" }。

2. 本地开发如何运行无安全验证的实例？

配置以下环境变量：

bash
RAVEN_Setup_Mode='None'
RAVEN_Security_UnsecuredAccessAllowed='PrivateNetwork'

3. 如何传递 CLI 参数？

通过 RAVEN_ARGS 环境变量指定，例如：

bash
RAVEN_ARGS='--log-to-console --max-server-memory 4096'  # 启用控制台日志并限制内存为 4GB

4. 如何通过 docker logs 查看 RavenDB 日志？

需启用控制台日志输出，设置环境变量：

bash
RAVEN_ARGS='--log-to-console'

日志级别可通过 RAVEN_Logs_Mode 调整（如 RAVEN_Logs_Mode='Debug'）。

5. 如何使用自定义配置文件？

1. 将主机配置文件（如 custom-settings.json）通过卷挂载至容器配置卷；
2. 通过 RAVEN_ARGS 指定配置文件路径：

bash
RAVEN_ARGS='--config-path /opt/RavenDB/config/custom-settings.json'  # Ubuntu 容器示例

参考 Dockerfiles

• https://github.com/ravendb/ravendb/blob/v4.0/docker/ravendb-nanoserver/Dockerfile
• https://github.com/ravendb/ravendb/blob/v4.0/docker/ravendb-ubuntu/Dockerfile
• https://github.com/ravendb/ravendb/blob/v4.1/docker/ravendb-ubuntu/Dockerfile