服务器部署showDoc

# 前言

有朋友展示过showDoc (opens new window)的使用，它是为IT团队量身定做的技术文档工具，有如下特点：

编辑方便，所见即所得
快速编写API文档和说明文档
展示数据字典
根据代码注释自动生成文档
开源，可以部署到自己的服务器

既然自己有服务器，不妨一试。

# 安装

见安装手册 (opens new window)，推荐自动脚本安装，需要预先安装docker (opens new window)

下面是参考官网的自动脚本下载及安装。

  #下载脚本并赋予权限
   wget https://www.showdoc.com.cn/script/showdoc;chmod +x showdoc;

1
2

  #安装showdoc 默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
  ./showdoc

1
2

# 安装后说明

安装好后，showdoc的数据都会存放在 /showdoc_data/html 目录下。./showdoc 脚本可放置在任何目录，方便以后使用。也可以重新从官方地址下载。

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

# 其他命令

 #下面附上脚本其他命令，以便管理showdoc时可以用得上。

 #停止
 ./showdoc stop 

 #重启
 ./showdoc restart

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

 #卸载showdoc
 ./showdoc uninstall

1
2
3
4
5
6
7
8
9
10
11
12
13

# 问题

# 无法访问公网IP

根据自动脚本安装步骤，安装脚本后会显示如下信息：

  安装成功，访问地址：http://localhost:4999 (你也可以用局域网或者公网IP/域名访问)   

  账户密码是showdoc/123456，登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。    

  对showdoc的问题或建议请至https://github.com/star7th/showdoc 提issue    

  若觉得showdoc好用，不妨到github点个star。良好的关注度和参与度有助于开源项目的长远发展

1
2
3
4
5
6
7

然后访问页面ip:4999，结果没有反应。

突然想到是端口未开放的问题，于是在服务器新增安全组规则。