Linux服务器部署在线文档工具（ShowDoc）

简介

   一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册等。

特点

• 开源 
• 轻量
• 部署简单，方便公司内部使用

部署

  ‌Docker 部署‌

  拉取镜像：

docker pull star7th/showdoc:latest  # 中国大陆用户可用阿里云镜像加速‌

  创建数据目录： 

mkdir -p /showdoc_data/html && chmod -R 777 /showdoc_data  # 确保读写权限‌

  启动容器：

docker run -d --name showdoc -p 8080:80 \
-v /showdoc_data/html:/var/www/html/ star7th/showdoc:latest‌:ml-citation{ref="4,6" data="citationList"}

访问地址：浏览器输入 http://宿主机IP:8080，默认账号密码为 showdoc/123456

自动脚本（博主使用）

使用方法

  # 选择下载目录(自定义即可)
  cd /u01/showdoc
  #下载脚本并赋予权限
  curl -O  https://www.showdoc.com.cn/script/showdoc;sudo chmod +x showdoc;
  #默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
  ./showdoc

安装后说明

安装好后，showdoc的数据都会存放在 /showdoc_data/html 目录下。

访问地址：浏览器输入 http://宿主机IP:4999，默认账号密码为 showdoc/123456

使用

  常用命令

 #下面附上脚本其他命令，以便管理showdoc时可以用得上。
 进入下载目录 (根据自己服务器进入)
 cd /u01/showdoc/

 #停止
 ./showdoc stop 

 #重启
 ./showdoc restart

 #升级showdoc到最新版
 ./showdoc update

 #卸载showdoc
 ./showdoc uninstall

 #日志
 docker logs showdoc 查看日志‌

 #升级
 chmod 777 -R /showdoc_data/html
 ./showdoc update 
 #注意：升级会把原来showdoc目录的Sqlite/showdoc.db.php覆 
 # 盖/showdoc_data/html/Sqlite/showdoc.db.php 
 # ，Public/Uploads覆盖 /showdoc_data/html/Public/Uploads
  

 重置密码

docker exec showdoc bash -c  "cd /var/www/html/ && php ./index.php home/common/repasswd"

初始化配置

• 首次登录 使用默认账号 showdoc/123456 登录后，建议立即修改密码‌。
• 语言设置 初始化界面支持中英文切换，按需选择‌。
• 管理后台 点击右上角齿轮图标进入后台，可配置站点名称、注册限制等基础设置‌。

结语

  更多功能可参考官网文档，目前还行不少问题，比如说文档导出图片和视频会开不见。不能上传部分文件（比如说exe文件）需要开源通过修改源码调整。