Docker本地部署showdoc

1. 什么是showdoc

showdoc是一个非常适合IT团队的在线API文档、技术文档工具。

接口文档是我们开发中一个很重要的工具，它是团队协作必不可少的一部分。市面上有很多这种工具，我之所以要推荐这款工具是因为它能够在线协作，而且可以本地部署。这样我们团队可以在内部网络使用它，大大提高了安全性。

2. 使用Docker本地部署showdoc服务

2.1 环境准备

在部署之前，我们需要准备以下环境：

• Docker
• 一台服务器（云服务器最好）

我这里使用的是腾讯云的Linux服务器。Docker默认从Docker Hub上面拉取镜像，速度很慢，所以我设置了Docker国内官方镜像加速，这里有一个教程：Docker镜像加速

之后，我们可以进行下面的步骤。

2.2 基础安装

# 原版官方镜像安装命令(中国大陆用户不建议直接使用原版镜像，可以用后面的加速镜像)
docker pull star7th/showdoc 

# 中国大陆镜像安装命令（安装后记得执行docker tag命令以进行重命名）
docker pull registry.cn-shenzhen.aliyuncs.com/star7th/showdoc
docker tag registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest star7th/showdoc:latest 

# 后续命令无论使用官方镜像还是加速镜像都需要执行
# 新建存放showdoc数据的目录
mkdir /showdoc_data
mkdir /showdoc_data/html
chmod  -R 777 /showdoc_data # 授予该目录的访问权限

# 启动showdoc容器
# -d 将容器运行在后台
# --name指定容器名称
# -p 将容器的80端口映射在主机（宿主机）的4999端口
#  -v 将主机（宿主机）下的/showdoc_data/html 目录映射到容器showdoc的 /var/www/html/目录下
docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/ star7th/showdoc

如果大家看起来不是很清晰的话，可以直接去官网：Docker方式安装。然后在终端我们可以看到打印了一串哈希值。

2.3 设置防火墙

接下来我们运行以下命令测试这个容器有没有启动：

docker ps | grep showdoc

如果能正常打印下面这些信息的话说明这个容器已经启动了：

接下来我们需要做一个数据转移（这个在2019年6月的版本更新已经改为了自动转移，只是为了再次演示这个过程，实际上可以不用执行下面的操作）：

 docker exec showdoc \cp -fr /showdoc_data/html/ /var/www

接下来，我们需要设置防火墙允许方行端口：

# 查看将要设置端口是否已经被占用
firewall-cmd --list-all

# 永久添加放行端口
firewall-cmd --add-port=4999/tcp --zone=public --permanent

# 重启防火墙
firewall-cmd --reload

接下来，你可以在宿主机上打开你刚刚部署的showdoc服务了（localhost:4999 或者你的云服务ip+4999）。然后就会出现下面的页面：

点击OK，会有默认的管理员账户和密码：

接下来你就可以愉快地和团队一起协作啦！

4. 参考

【1】ShowDoc