==========================
showdoc 简介
==========================
在线文档管理系统很多, 比如阿里的语雀、腾讯的 TAPD 平台也包括文档管理功能, 但这些系统需要联网的, 企业内文档协作工具不是很多, 最有名的是收费的 confluence 了, 禅道有文档管理功能, 但功能较弱, 比较适合附件上传管理.
这里介绍 Showdoc 这款开源(免费)文档管理系统, 可以部署企业内部, 后台使用 php + sqlite, 支持 Windows/Linux/Docker 部署形式.
showdoc 的功能:
1. 文档编辑语法采用 markdown, 编辑器做的挺不错.
2. 支持文档版本管理
3. 可以将文档导出为 word 软件格式
4. 权限控制: 可以新建公开项目和私密项目, 可以管理项目成员.
5. 文档搜索功能: 可以在一个项目搜索文档, 支持全文搜索, 但不支持跨项目的搜索.
==========================
简要说明:
==========================
自动脚本脚本利用docker来安装运行环境,适用于linux服务器。如果你的服务器没有docker服务,脚本会尝试安装之。安装docker的过程可能有些慢。如果你已经安装过docker,脚本会省略部分步骤,从而加快showdoc安装进度。
当脚本安装docker失败时,你可以手动安装好docker后再执行脚本 。若装好了docker后还是再失败,则可根据此教程一步步地安装和调试: https://www.showdoc.cc/help?page_id=65610
如果服务器系统本身不支持docker,则只能通过手动安装PHP环境的方式来运行showdoc:https://www.showdoc.cc/help?page_id=13732
==========================
安装方法:
==========================
#下载脚本并赋予权限
wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;
#默认安装中文版。如果想安装英文版,请加上en参数,如 ./showdoc en
./showdoc
==========================
安装后说明:
==========================
#创建本地项目目录
mkdir -p /showdoc_data/html #启动showdoc容器。启动完了后别忘记后面还有转移数据的步骤。
docker run -d --name showdoc -p : -v /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 -R /showdoc_data
安装好后,showdoc的数据都会存放在 /showdoc_data/html 目录下。./showdoc 脚本可放置在任何目录,方便以后使用。也可以重新从官方地址下载。
你可以打开 http://xxx.com:4999 来访问showdoc (xxx.com为你的服务器域名或者IP)。账户密码是showdoc/123456,登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。