showdoc是什么呢？

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端，有win客户端、mac客户端、ios、android等，更方便跨平台使用。目前超过100000+

以上是showdoc官方对于showdoc的解释。我们团队在项目中使用它的主要作用也就是来管理api。我本人作为一个前端开发工程师，在来到这里之前的上家也是使用showdoc来管理api的。来到这边之后，发现这边是直接给到前端txt文件来阅读。对于长期维护和后期查看都不是很友好。所以我就在服务器安装了showdoc供组内后端人员维护，当然有时候我也会去维护。

如何安装showdoc呢？

服务器登录之后在终端输入如下命令官方教程

#下载脚本并赋予权限
   wget https://www.showdoc.com.cn/script/showdoc;chmod +x showdoc;
#默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
  ./showdoc

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

如何迁移呢？

这里直接贴官方教程的文字

这里的迁移服务器，指的是：服务器A已经安装好了showdoc， 然后现在要迁移到服务器B去。

• 首先参考教程，在新服务器上全新安装一个showdoc。推荐使用官方自动脚本或者docker方式安装。

• 假如你是官方自动脚本或者docker方式安装，那么数据将放在/showdoc_data/html下。复制旧服务器的Sqlite/showdoc.db.php，以及Public/Uploads/下的所有文件（如没有则可忽略之），覆盖到新showdoc目录的相应文件。覆盖后重新给这些文件可写权限.

• （可选）如果原有文档里已经有上传的图片和附件，换新的域名的时候也许访问不了。可进入数据库把图片附件路径改一下。showdoc使用sqlite数据库。数据库文件是安装目录下的Sqlite/showdoc.db.php。你可以网络搜索如何在命令行中使用 sqlite数据库.或者使用SQLiteStudio等可视化工具。进入数据库后，执行update page set page_content = replace(page_content,’原始host’,’新host’); 和 update upload_file set real_url= replace(real_url,’原始host’,’新host’);

需要注意的点

比如你要从A 服务器迁移到B服务器， 你首先得在B服务器安装showdoc。这里应该安装的是最新的。所以你得在A服务器升级下，为了保证你迁移之后不会有其他麻烦。建议在B服务器执行 ./shodoc update更新至A服务器同样版本。

一定要给复制过来的文件改变权限

chmod -R 777 ./showdoc.db.php
chomd -R 777 ./Uploads

然后就可以直接在B服务器的4999端口访问了。