outlinewiki/outline-enterprise

Outline企业版镜像

镜像概述和主要用途

Outline企业版是基于React和Node.js构建的开源、可扩展团队协作知识库工具。本Docker镜像为其企业版发行版本，需许可证密钥和签署协议方可运行。它提供结构化文档管理、实时协作编辑功能，适用于企业内部知识库搭建与团队文档协作，支持自托管部署以满足数据隐私和定制需求。

核心功能和特性

• 企业级部署：需专用许可证密钥和签署协议，满足企业合规要求
• 技术架构：基于React前端和Node.js后端，现代化Web应用架构
• 多源认证：支持Slack、Google等第三方身份验证集成
• 数据存储：兼容PostgreSQL数据库、Redis缓存及S3兼容对象存储
• 协作功能：实时多人编辑、版本控制、文档组织与搜索
• 可扩展性：开源代码base支持定制开发与功能扩展

使用场景和适用范围

• 企业内部知识库与文档管理系统
• 研发团队技术文档协作平台
• 部门级标准化流程与指南库
• 需要数据本地化存储的组织级协作工具

详细使用方法和配置说明

依赖要求

运行Outline企业版需预先部署以下服务：

• Node.js ≥ 12
• Yarn 包管理器
• PostgreSQL ≥ 9.5 数据库
• Redis ≥ 4 缓存服务
• AWS S3兼容对象存储（用于文件附件）
• Slack或Google开发者应用（用于身份验证）

Docker生产环境部署

部署步骤

1. 准备基础服务
   预先部署并配置PostgreSQL和Redis服务（配置指南参考官方文档）

2. 拉取镜像

   bash
   docker pull outlinewiki/outline
   

3. 配置环境变量
   参考https://github.com/outline/outline/blob/main/.env.sample%E5%88%9B%E5%BB%BA%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%EF%BC%8C%E5%85%B3%E9%94%AE%E5%8F%82%E6%95%B0%E5%8C%85%E6%8B%AC%EF%BC%9A

   • SECRET_KEY：应用加密密钥（生成方法见配置文件注释）
   • DATABASE_URL：PostgreSQL连接字符串
   • REDIS_URL：Redis连接字符串
   • AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY：S3存储凭证
   • SLACK_KEY/SLACK_SECRET：Slack认证应用凭证

4. 数据库初始化

   bash
   # 标准SSL连接迁移
   docker run --rm --env-file=.env outlinewiki/outline yarn db:migrate
   
   # 非SSL本地数据库（仅开发环境）
   docker run --rm --env-file=.env outlinewiki/outline yarn db:migrate --env=production-ssl-disabled
   

5. 启动服务

   bash
   docker run -d --env-file=.env -p 3000:3000 --name outline outlinewiki/outline
   

6. 反向代理配置（可选）
   推荐使用Nginx或Traefik作为反向代理，配置域名、SSL证书及端口转发（默认容器端口3000）

升级指南

Docker部署升级

1. 拉取最新镜像：

   bash
   docker pull outlinewiki/outline:latest
   

2. 执行数据库迁移：

   bash
   docker run --rm --env-file=.env outlinewiki/outline:latest yarn db:migrate
   

3. 重启容器：

   bash
   docker stop outline && docker start outline
   

源码部署升级（适用于克隆仓库部署场景）

bash
yarn run upgrade

本地开发环境配置

如需贡献代码或定制开发，可通过以下步骤搭建本地环境：

1. 安装依赖工具

   • Docker Desktop
   • Node.js（v12 LTS推荐）
   • Yarn包管理器

2. 准备工作

   • 克隆代码仓库：git clone https://github.com/outline/outline.git
   • 在Slack开发者平台创建应用
   • 复制.env.sample为.env并配置关键参数：
     • SECRET_KEY：应用密钥
     • SLACK_KEY：Slack应用Client ID
     • SLACK_SECRET：Slack应用Client Secret

3. 配置Slack应用

   • 添加OAuth重定向URL：https://<ngrok地址>/auth/slack.callback（需使用***等工具实现本地HTTPS）
   • 配置Bot权限范围，至少包含users:read

4. 启动开发环境

   bash
   make up
   

   该命令将自动构建依赖、启动开发容器并初始化测试数据

技术开发指南

架构参考

详细架构说明请参阅https://github.com/outline/outline/blob/main/ARCHITECTURE.md%EF%BC%8C%E5%8C%85%E5%90%AB%E5%89%8D%E5%90%8E%E7%AB%AF%E5%88%86%E7%A6%BB%E8%AE%BE%E8%AE%A1%E3%80%81%E6%95%B0%E6%8D%AE%E6%B5%81%E8%BD%AC%E4%B8%8E%E6%A8%A1%E5%9D%97%E5%88%92%E5%88%86%E3%80%82

调试模式

使用debug模块输出调试信息，支持以下日志类别：

bash
DEBUG=sql,cache,presenters,events,importer,exporter,emails,mailer

测试策略

• 全量测试：make test
• 后端测试（监视模式）：make watch
• 单独测试：

  bash
  # 后端测试
  yarn test:server
  
  # 前端测试
  yarn test:app
  

数据库迁移

使用Sequelize管理数据库版本：

bash
# 生成迁移文件
yarn sequelize migration:generate --name <迁移名称>

# 执行迁移
yarn sequelize db:migrate

# 测试环境迁移
yarn sequelize db:migrate --env test

许可证

本软件采用https://github.com/outline/outline/blob/main/LICENSE%EF%BC%8C%E4%BC%81%E4%B8%9A%E7%89%88%E4%BD%BF%E7%94%A8%E9%9C%80%E9%81%B5%E5%AE%88%E9%A2%9D%E5%A4%96%E8%AE%B8%E5%8F%AF%E5%8D%8F%E8%AE%AE%E3%80%82