Linux安装showdoc详解

准备 Nginx + PHP 环境

安装 Nginx

使用&＃160;yum&＃160;安装 Nginx：

yum -y install epel-release yum -y install nginx

修改&＃160;/etc/nginx/nginx.conf&＃160;文件：

... ...
http
{&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;... ...&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;server {&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;... ...&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;root&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; /var/www/html;&＃160; # 网站根目录&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;index index.php index.html;&＃160;&＃160; # 默认索引项&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;error_page&＃160; 404&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; /404.html;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;location = /40x.html {&＃160; &＃160;

&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;}&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;error_page&＃160;&＃160; 500 502 503 504&＃160; /50x.html;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;location = /50x.html {

&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;}&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;location ~ .php$ {&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;root&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; /var/www/html;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;fastcgi_pass&＃160;&＃160; 127.0.0.1:9000;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;fastcgi_index&＃160; index.php;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;fastcgi_param&＃160; SCRIPT_FILENAME&＃160; $document_root$fastcgi_script_name;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;include&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; fastcgi_params;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;}&＃160;&＃160;&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;location ~ /.ht {&＃160;&＃160;&＃160;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;deny&＃160; all;&＃160;&＃160; &＃160;
&＃160;&＃160; &＃160;&＃160;&＃160; &＃160;}
&＃160;&＃160; &＃160;}
}

启动 Nginx 并设置为开机启动：

systemctl start nginx systemctl enable nginx

安装 PHP

使用&＃160;yum&＃160;安装 php-fpm：

yum -y install php php-gd php-fpm php-mcrypt php-mbstring php-mysql php-pdo

启动 php-fpm 并设置为开机启动：

systemctl start php-fpm systemctl enable php-fpm

创建项目

下载安装 Composer

Composer 是 PHP 的一个依赖管理工具，推荐使用 Composer 创建 ShowDoc 项目。

执行如下命令安装 Composer：

curl -sS https://getcomposer.org/installer | phpmv composer.phar /usr/local/bin/composer

安装过程可能需要耗费几分钟

设置 Composer 使用国内镜像

执行命令设置 Composer 使用国内镜像：

composer config -g repo.packagist composer https://packagist.phpcomposer.com

为了避免访问国外网络导致的延迟，推荐使用国内镜像源

使用 Composer 创建项目

执行命令创建项目：

cd /var/www/html && composer create-project showdoc/showdoc

设置 showdoc 目录写权限

执行命令赋予 showdoc 下部分目录的写权限

chmod a+w showdoc/install

chmod a+w showdoc/Sqlite

chmod a+w showdoc/Sqlite/showdoc.db.php

chmod a+w showdoc/Public/Uploads/

chmod a+w showdoc/Application/Runtime

chmod a+w showdoc/server/Application/Runtime

chmod a+w showdoc/Application/Common/Conf/config.php

chmod a+w showdoc/Application/Home/Conf/config.php

创建完毕，您现在可以通过浏览器访问 http://<您的 CVM IP 地址>/showdoc/install/ ，进行语言的选择以后即可通过 http://<您的 CVM IP 地址>/showdoc 查看站点效果。

关闭SELinux

1、临时关闭

setenforce 0

2、永久关闭

vim /etc/selinux/config

?修改为以下内容

SELINUX=enforcing

&＃160;

自动生成数据字典

介绍

好的数据字典文档能够清晰地反映出数据库的结构以及相关释义，方便技术人员查阅。我们很容易使用showdoc来生成展示数据库结构的字典文档，并且能根据数据库结构的变动来自动修改文档，省去人工编辑的麻烦。

这一切的自动化依赖于我们的上报脚本。你需要下载我们的脚本到你的服务器上执行，上传数据库结构信息到showdoc。上报脚本的源码完全公开，你可以阅读之以确认安全。我们确保它只会上传基本数据库结构信息，不会上传数据库密码配置、业务数据等敏感信息。

目前只支持linux下的mysql数据库，更多类型未来再考虑。

操作步骤

l&＃160; 执行下载脚本的命令

a)&＃160;&＃160;&＃160;&＃160; wget https://www.showdoc.cc/script/showdoc_db.sh

l&＃160; 打开此文件

b)&＃160;&＃160;&＃160;&＃160; vi showdoc_db.sh

l&＃160; 修改配置信息

打开文件后，在文件的前面能看到几项配置。其中，像数据库配置、api_key等信息是需要你填写的，填写完毕后保存即可。下面用表格的形式列举出各个配置项代表的意思。

l&＃160; 执行

c)&＃160;&＃160;&＃160;&＃160; chmod +x showdoc_db.sh

d)&＃160;&＃160;&＃160;&＃160; ./showdoc_db.sh

看到成功字样便ok。你可以打开showdoc项目看看是否真的生成了。

l&＃160; 定时自动更新

如果想定时自动更新，则需要为系统增加一个定时任务。下面给一个例子，表示每10分钟同步一次

e)&＃160;&＃160;&＃160;&＃160; /10 * * * *&＃160; /root/showdoc_db.sh

其中，showdoc_db.sh脚本在定时任务里需要写绝对路径。

注意事项

如果你设置了脚本的自动执行，那么请不要再手动登录showdoc修改文档。因为你的修改都会被自动脚本重新覆盖。

因为会覆盖你的修改，所以如果你想为某个字段设置中文注释，请修改mysql字段注释，而不是在showdoc上手动编辑文档。

自动执行的情况下，只会自动新增和修改文档，不会自动删除文档（主要出于数据安全考虑）。所以，如果你删除了一张表，文档里是不会删除那个页面的。需要手动登录showdoc来删除。一般来讲，这种情况不会很多。