ShowDoc文档管理工具部署

基础安装

安装前请确保你的环境已经装好了docker 。docker的安装教程在网上比较多,可以搜索了解下。这里重点介绍showdoc.

原版官方镜像安装命令(中国大陆用户不建议直接使用原版镜像,可以用后面的加速镜像)

1
docker pull star7th/showdoc

中国大陆镜像安装命令(安装后记得执行docker tag命令以进行重命名)

1
2
docker pull registry.cn-shenzhen.aliyuncs.com/star7th/showdoc
docker tag registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest star7th/showdoc:latest

后续命令无论使用官方镜像还是加速镜像都需要执行

新建存放showdoc数据的目录

1
2
mkdir -p ~/showdoc_data/html
chmod -R 777 ~/showdoc_data

启动showdoc容器

1
2
docker run -d --name showdoc --user=root --privileged=true -p 4999:80 \
-v /showdoc_data/html:/var/www/html/ star7th/showdoc

1
docker run -d --name showdoc --user=root --privileged=true -p 80:80 -v ~/showdoc/html:/var/www/html/ star7th/showdoc

根据以上命令操作的话,往后showdoc的数据都会存放在 /showdoc_data/html 目录下。

你可以打开 http://localhost:4999 来访问showdoc (localhost可改为你的服务器域名或者IP)。账户密码是showdoc/123456,登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。

对showdoc的问题或建议请至https://github.com/star7th/showdoc 出提issue。若觉得showdoc好用,不妨点个star。

如何升级

这里的升级是针对上面docker安装方式的升级。如果你原来是采用非docker安装方式(如php安装方式)的话,请跳过本部分文字,直接去看下部分。

停止容器

1
docker stop showdoc

下载最新代码包

1
wget https://github.com/star7th/showdoc/archive/master.tar.gz

解压

1
2
tar -zxvf master.tar.gz -C /showdoc_data/
rm -rf /showdoc_data/html_bak

备份。如果可以的话,命令中的html_bak还可以加上日期后缀,以便保留不同日期的多个备份

1
2
mv /showdoc_data/html  /showdoc_data/html_bak
mv /showdoc_data/showdoc-master /showdoc_data/html ##// */

赋予权限

1
chmod -R 777 /showdoc_data/html

启动容器

1
docker start showdoc

执行安装。默认安装中文版。如果想安装英文版,将下面参数中的zh改为en

1
curl http://localhost:4999/install/non_interactive.php?lang=zh

转移旧数据库

1
\cp -f /showdoc_data/html_bak/Sqlite/showdoc.db.php /showdoc_data/html/Sqlite/showdoc.db.php

转移旧附件数据

1
\cp -r -f /showdoc_data/html_bak/Public/Uploads/. /showdoc_data/html/Public/Uploads

如果中途出错,请重命名原来的/showdoc_data/html_bak文件为/showdoc_data/html ,然后重启容器便可恢复。

非docker安装方式如何升级到docker安装方式

先参考前文,用docker方式全新安装一个showdoc,并且做好数据持久化。

接下来,假设你原来安装的旧showdoc已上传到服务器的 /tmp/showdoc 目录,那么

转移旧数据库

1
\cp -r -f /tmp/showdoc/Sqlite/showdoc.db.php /showdoc_data/html/Sqlite/showdoc.db.php

转移旧附件数据

1
\cp -r -f /tmp/showdoc/Public/Uploads/. /showdoc_data/html/Public/Uploads

数据备份

备份/showdoc_data/html 目录即可。比如执行下面命令压缩存放

1
zip -r /showdoc_data/showdoc_bak.zip /showdoc_data/html

其中showdoc_bak.zip可以用日期后缀命名,以便多个备份。你也可以用定时任务来实现定时备份。

其他参考命令

1
2
3
4
5
docker stop showdoc # 停止容器
docker restart showdoc #重启showdoc容器
docker rm showdoc #删除showdoc容器
docker rmi star7th/showdoc #删除showdoc镜像
docker stop $(docker ps -a -q) ;docker rm $(docker ps -a -q) ; #停止并删除所有容器。危险命令,不懂勿用。

其他支持

常见问题:http://www.showdoc.cc/help?page_id=16118

如果你没有自己的服务器,但又想使用ShowDoc作为分档分享工具,你可以使用在线的ShowDoc http://www.showdoc.cc

文章目录
  1. 1. 基础安装
    1. 1.1. 原版官方镜像安装命令(中国大陆用户不建议直接使用原版镜像,可以用后面的加速镜像)
    2. 1.2. 中国大陆镜像安装命令(安装后记得执行docker tag命令以进行重命名)
    3. 1.3. 后续命令无论使用官方镜像还是加速镜像都需要执行
  2. 2. 新建存放showdoc数据的目录
  3. 3. 启动showdoc容器
  4. 4. 如何升级
  5. 5. 停止容器
  6. 6. 下载最新代码包
  7. 7. 解压
  8. 8. 备份。如果可以的话,命令中的html_bak还可以加上日期后缀,以便保留不同日期的多个备份
  9. 9. 赋予权限
  10. 10. 启动容器
  11. 11. 执行安装。默认安装中文版。如果想安装英文版,将下面参数中的zh改为en
  12. 12. 转移旧数据库
  13. 13. 转移旧附件数据
  14. 14. 如果中途出错,请重命名原来的/showdoc_data/html_bak文件为/showdoc_data/html ,然后重启容器便可恢复。
  15. 15. 转移旧数据库
  16. 16. 转移旧附件数据
  17. 17. 数据备份
  18. 18. 其他参考命令
  19. 19. 其他支持