convergencelabs/convergence-omnibus

Convergence Omnibus容器

!Convergence Logo

https://github.com/convergencelabs/convergence-omnibus-container/actions/workflows/build.yml/badge.svg](https://github.com/convergencelabs/convergence-omnibus-container/actions/workflows/build.yml)

镜像概述和主要用途

Convergence Omnibus容器是Convergence的一体化版本，主要供开发者在开发基于Convergence的应用程序时使用，同时也适用于不需要高可用性的简单或小型安装场景。该容器集成了Convergence服务器、Convergence管理控制台、Convergence客户端以及OrientDB数据库，提供一站式的Convergence运行环境。

核心功能和特性

• 一体化集成：包含Convergence服务器、管理控制台、客户端和OrientDB数据库，无需额外配置外部组件
• 便捷开发：为Convergence应用开发提供完整的本地运行环境
• 简化部署：适用于简单或小型安装，降低部署复杂度
• 可配置性：通过环境变量自定义管理员账户、默认命名空间等关键参数
• 数据持久化：支持通过Docker卷挂载实现数据持久化存储

使用场景和适用范围

• 开发基于Convergence的实时协作应用程序
• 搭建小型Convergence演示环境
• 部署不需要高可用性的简单Convergence服务
• 学习和评估Convergence平台功能

使用方法和配置说明

基本用法

执行以下命令即可运行容器：

shell
docker run -p "8000:80" convergencelabs/convergence-omnibus

访问地址

容器启动后，可通过 http://localhost:8000/ 访问以下服务（根据实际端口和主机名调整）：

• Convergence管理控制台：http://localhost:8000/
• REST API：http://localhost:8000/rest/
• 实时API：http://localhost:8000/realtime/
• JavaScript API文档：http://localhost:8000/api/
• 客户端构建版本：http://localhost:8000/client/

默认凭据

容器首次启动时会创建默认服务器管理员用户，默认凭据为：

• 用户名：admin
• 密码：password

可通过环境变量修改默认凭据（详见下文）。

环境变量

以下环境变量可用于配置Convergence服务器，所有变量均为可选，已提供合理默认值：

• CONVERGENCE_ADMIN_USERNAME：默认服务器管理员用户名，启动时创建
• CONVERGENCE_ADMIN_PASSWORD：默认服务器管理员密码，启动时创建
• CONVERGENCE_ADMIN_EMAIL：默认服务器管理员***，启动时创建
• CONVERGENCE_ADMIN_DISPLAY_NAME：默认服务器管理员显示名称，启动时创建
• CONVERGENCE_DEFAULT_NAMESPACE：服务器默认命名空间，默认为"convergence"
• CONVERGENCE_DEFAULT_DOMAIN_ID：创建的默认域ID，默认为default
• CONVERGENCE_DEFAULT_DOMAIN_DISPLAY_NAME：创建的默认域显示名称，默认为Default
• EXTERNAL_REMOTING_PORT：容器外部可访问的Akka远程端口，适用于代理环境，默认为25520
• EXTERNAL_REMOTING_HOSTNAME：容器外部可访问的Akka远程主机名，适用于代理环境，默认为localhost
• HTTP_PORT：内置NGINX服务器监听的HTTP端口，默认为80

常用Docker选项

• 后台运行（分离模式）：添加 -d 参数
• 为容器命名：添加 --name convergence 参数，便于执行 docker logs -f convergence 等命令

持久化数据

Convergence数据存储在容器内运行的OrientDB实例中，Docker卷定义在 /orientdb/databases 以持久化数据。可通过命名卷或主机映射卷将数据持久化到容器外部，例如：

shell
docker run \
  -p "8000:80" \
  -v ${PWD}/databases:/orientdb/databases \
  convergencelabs/convergence-omnibus

许可证

Convergence Omnibus容器采用GNU通用公共许可证v3（GPLv3）许可。有关许可证的具体条款和条件，请参阅LICENSE。