weseek/growi

GROWI 官方 Docker 镜像文档

镜像概述和主要用途

GROWI 是一款团队协作软件，基于 https://github.com/crowi/crowi 分支开发，专注于提供高效的团队协作与知识管理功能。本 Docker 镜像是 GROWI 官方提供的部署方案，便于快速搭建和使用 GROWI 服务，支持团队通过 Markdown 格式进行文档协作、知识共享和项目管理。

支持的标签及对应 Dockerfile 链接

核心功能和特性

• Markdown 支持：使用 Markdown 格式进行文档编辑，满足技术文档编写需求。
• 团队协作：支持多人实时协作编辑、评论和版本管理，提升团队协作效率。
• 数据存储：基于 MongoDB 存储文档数据，确保数据可靠性和可扩展性。
• 全文搜索：可选集成 ElasticSearch，提供高效的全文搜索功能（需安装指定插件）。
• 灵活部署：通过 Docker 镜像简化部署流程，支持单机和集群环境。

使用场景和适用范围

• 团队文档协作：适用于团队内部需求文档、技术文档、会议记录等内容的协作编辑与管理。
• 知识共享平台：作为团队知识库，集中存储和共享各类知识资源，便于新成员上手。
• 项目管理辅助：用于项目计划、进度跟踪、任务分配等文档的实时更新与共享。
• 中小型团队：轻量化部署，适合中小型团队快速搭建协作平台，无需复杂的基础设施。

系统要求

必要依赖

• MongoDB：版本 ≥ 6.0，用于存储 GROWI 的所有数据（文档、用户信息等）。

可选依赖

• ElasticSearch：版本 ≥ 7.17，用于提供全文搜索功能，需安装以下插件：
  • Japanese (kuromoji) Analysis plugin（日语分词插件）
  • ICU Analysis Plugin（国际化分词插件）

使用方法

基础部署（Docker Run）

通过 docker run 命令快速启动 GROWI，需指定 MongoDB 连接地址：

bash
docker run -d \
  -e MONGO_URI=mongodb://<MONGODB_HOST>:<MONGODB_PORT>/growi \
  --name growi \
  growilabs/growi

启动后，访问 http://localhost:3000 即可进入 GROWI 界面。

集成 ElasticSearch 部署

若需启用全文搜索功能，需额外指定 ElasticSearch 连接地址：

bash
docker run -d \
  -e MONGO_URI=mongodb://<MONGODB_HOST>:<MONGODB_PORT>/growi \
  -e ELASTICSEARCH_URI=http://<ELASTICSEARCH_HOST>:<ELASTICSEARCH_PORT>/growi \
  --name growi \
  growilabs/growi

Docker Compose 部署（推荐）

使用 Docker Compose 是快速部署 GROWI 及其依赖服务（MongoDB、ElasticSearch 等）的最便捷方式。官方提供了预配置的 Compose 模板，详情参见：
https://github.com/growilabs/growi-docker-compose

配置说明

环境变量配置

GROWI 支持通过环境变量自定义配置，详细参数可参考官方文档：
GROWI 文档：环境变量

常用环境变量示例：

• MONGO_URI：MongoDB 连接 URI（必填）
• ELASTICSEARCH_URI：ElasticSearch 连接 URI（可选，启用搜索时必填）
• PORT：GROWI 服务端口（默认 3000）
• NODE_ENV：运行环境（默认 production）

管理员指南

更多配置细节（如用户管理、权限设置等），请参考 GROWI 官方管理员指南：
GROWI 文档：管理员指南（英文 / 日文）

问题反馈

如在使用镜像过程中遇到问题或有疑问，请通过 https://github.com/growilabs/growi-docker/issues 反馈。