showdoc 文档管理系统

Posted 2022-05-06 HarryChinese

==========================

showdoc 简介

==========================

在线文档管理系统很多, 比如阿里的语雀、腾讯的 TAPD 平台也包括文档管理功能, 但这些系统需要联网的, 企业内文档协作工具不是很多, 最有名的是收费的 confluence 了, 禅道有文档管理功能, 但功能较弱, 比较适合附件上传管理.

这里介绍 Showdoc 这款开源(免费)文档管理系统, 可以部署企业内部, 后台使用 php + sqlite, 支持 Windows/Linux/Docker 部署形式.

showdoc 的功能:

1. 文档编辑语法采用 markdown, 编辑器做的挺不错.

2. 支持文档版本管理

3. 可以将文档导出为 word 软件格式

4. 权限控制: 可以新建公开项目和私密项目, 可以管理项目成员.

5. 文档搜索功能: 可以在一个项目搜索文档, 支持全文搜索, 但不支持跨项目的搜索.

==========================

安装

==========================

部署手册:https://www.showdoc.cc/help?page_id=13732

我使用的是 docker 安装, 对应的帮助: https://www.showdoc.cc/help?page_id=65610 , 下面代码就是摘自这个帮助文档, 只是将宿主机的 /howdoc_data 修改为 /home/docker/howdoc_data

# 由于国内镜像与官网原镜像同步可能延迟，如果有网络条件，建议使用原镜像。如果网络不好，建议使用国内镜像
# 国内镜像安装命令
docker pull registry.docker-cn.com/star7th/showdoc
#国外官方镜像安装命令
#docker pull star7th/showdoc
#新建存放showdoc数据的目录
mkdir /home/docker/howdoc_data
mkdir /home/docker/showdoc_data/html
chmod 777 -R /home/docker/showdoc_data
#启动showdoc容器。启动完了后别忘记后面还有转移数据的步骤。
docker run -d --name showdoc -p 4999:80 -v /home/docker/showdoc_data/html:/var/www/html/ registry.docker-cn.com/star7th/showdoc
#转移数据。执行这里的时候留意命令行界面有没有权限禁止的错误提示。
#如果有，则检查权限，或者安全限制（比如说可能selinux会禁止docker进程写文件）
docker exec showdoc \\cp -fr /showdoc_data/html/ /var/www/
# 权限
chmod 777 -R /showdoc_data

完成上面步骤后, 使用浏览器访问 http://localhost:4999

缺省管理员账号密码为: showdoc/123456

如果目录不可写等错误信息, 需要进入docker 容器中, 开放几个目录的写权限.

报错信息:

目录 [ ./server/Application/Runtime/ ] 不可写！

开放几个目录的写权限的步骤:

docker exec -i -t showdoc /bin/sh
chmod 777 -R /var/www/html/server/Application
chmod 777 -R /var/www/html/install
chmod 777 -R /var/www/html/Public/Uploads/
chmod 777 -R /var/www/html/Sqlite/