ShowDoc就是一个非常适合IT团队的在线文档分享工具,使用的是一款非常轻量级的关系数据库系统SQLite,支持多数SQL92标准。它可以加快团队之间沟通的效率。
但是把所有的接口文档写在第三方的服务器上面,是不怎么安全的,所以想安装到自己的开发服务器上面,仅供内网访问。
它都有些什么功能?
1)分享与导出
2)权限管理 公开项目与私密项目|项目成员
3)编辑功能 包括markdown编辑|模板插入|历史版本
安装ShowDoc
①、如果你熟悉命令行,则可通过Composer安装。
②、如果采用手动方式安装,则请下载代码:https://github.com/star7th/showdoc点击打开链接
我选择的是手动安装,
1)首先从https://github.com/star7th/showdoc下载压缩包
2) 然后用rz命令上传到服务器上,也可以用上传工具,比如WinSCP等
3)下载的是showdoc-master.zip,是一个用uzip命令解压,你可以改成你想要的文件名
4)配置虚拟主机
我的服务器用的tenginx, 编辑配置文件 vi xx/tenginx/conf/vhosts.conf ,在末尾添加如下:
5)重启tenginx服务
6)在浏览器地址栏 showdoc.wanshifu.com/install 开启安装
可能出现以下提示,说明文件写入权限,按下面提示给文件权限。eg: chomod -R 777 Public/Uploads
然后出现安装页面,按提示安装即可
7) 安装成功后,注册登陆后,建立一个test项目,很方便快捷,也美观
注意事项:
文件夹权限
请确保/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可写权限
如何关闭验证码
/Application/Common/Conf/Config.php 配置项里面增加 ‘CloseVerify’ => true,然后删除/Application/Rumtime下的所有文件(这些都是缓存)