团队文档放别人服务器总不踏实:这套开源 Wiki 自己搭,还能接 Git 管版本

Wiki.js

团队要写文档,第一个问题是「放哪」。用飞书腾讯文档,数据在别人那;自己搭 Git 仓库写 Markdown,非技术同事又进不来。

Wiki.js 走的是中间路线:29,303 颗星,TypeScript 写的,自己部署一套,浏览器打开就能编辑,后台还能直接接 Git 仓库做版本管理。

它解决什么问题

  • 权限细分:按页面、按目录、按用户组控制读写
  • Markdown 编辑:所见即所得和源码模式可切换
  • Git 同步:内容可双向同步到 Git 仓库,改动能追溯
  • 多语言:界面和内容都支持多语言
  • 搜索:内置全文搜索,可接 Elasticsearch
  • 认证集成:LDAP、OAuth、SAML 都支持,能对接公司账号

部署

官方推荐 docker-compose,因为它需要配套一个 PostgreSQL:

# 从官方仓库拿 compose 文件
# https://github.com/requarks/wiki
docker compose up -d

启动后访问 http://你的IP:3000,走一遍安装向导,填数据库信息、建管理员账号即可。

四个实战坑

  1. 必须有 PostgreSQL。虽然早期支持 SQLite,但生产环境用 SQLite 会在并发写入时出问题。
  2. AGPL-3.0 协议。公司内部用没问题,对外提供服务要注意开源义务。
  3. v3 版本变化较大。从 v2 升级要看迁移文档,插件和主题不一定兼容。
  4. 中文全文搜索要配。默认搜索对中文分词支持一般,量大时建议接 Elasticsearch 并装中文分词插件。

适合谁

有内部文档需求、又要控制数据归属的团队。技术团队自己用非常顺手(Markdown + Git);纯业务团队用也 OK,编辑器对非技术人员友好。

如果只是个人写笔记,用不上它;只要有 3 个人以上要协同写文档,它就值得搭一套。

项目地址:github.com/requarks/wiki(AGPL-3.0 / TypeScript)

© 版权声明
THE END
喜欢就支持一下吧
点赞22 分享
评论 抢沙发

请登录后发表评论

    暂无评论内容