
Outline · 快速、协作的团队知识库与 Wiki 系统 · 中文部署与使用全指南
项目仓库: https://github.com/outline/outline
开源协议:BSL-1.1(以仓库 LICENSE 为准) · 技术栈:React + Node.js /
TypeScript · 镜像:outlinewiki/outline(DockerHub) ·
文档:docs.getoutline.com/s/hosting
1 项目简介
Outline(仓库名
outline/outline)是一个快速、协作的团队知识库,用
React 与 Node.js 构建。官方同时提供托管版
getoutline.com;自托管则用官方容器镜像。
1.1 核心信息一览
| 项目项 | 内容 |
|---|---|
| 项目名称 | Outline |
| 仓库地址 | github.com/outline/outline |
| 项目定位 | 团队知识库 / Wiki |
| 技术栈 | React + Node.js / TypeScript |
| 镜像 | outlinewiki/outline(DockerHub,含 release 与
nightly) |
| 托管版 | getoutline.com |
| 自托管文档 | docs.getoutline.com/s/hosting |
1.2 适用场景
- 团队需要一个文档 / Wiki 知识库。
- 希望自托管或用官方托管版。
1.3 能力边界(官方口径)
- 生产部署请按官方 hosting 文档;调试用
DEBUG=http/DEBUG=database/LOG_LEVEL=debug等环境变量。
2 功能特性
- 协作知识库:实时编辑、搜索、权限。
- 多语言(Crowdin 本地化)。
- 容器镜像:release 与 nightly。
- 调试友好:生产 JSON 日志,DEBUG 环境变量分类开启。
3 官方界面预览
封面为 Outline 官方标识。官方 README 提供产品截图。
4 官方跳转链接汇总
| 类别 | 链接 | 说明 |
|---|---|---|
| 仓库主页 | https://github.com/outline/outline | 源码与 README |
| 托管版 | getoutline.com | 官方 SaaS |
| 文档 | docs.getoutline.com | 使用与自托管 |
| Docker 镜像 | hub.docker.com/r/outlinewiki/outline | 容器镜像 |
5 前置要求
- Docker 与数据库(Postgres,按官方 hosting 文档)。
- 按官方文档准备环境变量(数据库、URL、密钥等)。
6 方式一:自托管容器(官方)
# 拉取镜像
docker pull outlinewiki/outline:latest
# 生产配置请严格按官方 hosting 文档
# https://docs.getoutline.com/s/hosting/7 方式二:用官方托管版(免运维)
# 直接注册 getoutline.com8 方式三:本地开发环境
# 参考 docs.getoutline.com/s/hosting/doc/local-development-5hEhFRXow7
# 测试
make test
make watch
yarn test:server
yarn test:app9 配置项说明
- 环境变量:
DEBUG=http、DEBUG=*、DEBUG=database、LOG_LEVEL=debug、LOG_LEVEL=silly。 - 生产配置以官方 hosting 文档为准(数据库、URL、邮件、SSO 等)。
10 常见故障排查
- 启动报错:按官方 hosting 文档逐项核对环境变量。
- 日志不详细:设
DEBUG=*或LOG_LEVEL=debug。 - HTTP 日志默认关:设
DEBUG=http开启。
11 风险与合规说明
- BSL 许可;自托管前阅读 LICENSE 与官方文档。
- 官方明确不接受 AI 生成的低质量 PR。
- 本文命令、链接来自官方 README 与文档,随版本可能调整,以 docs.getoutline.com 为准。