程序员都很希望别人能写文档,而自己却不愿意写文档。文档的编写和管理影响了团队沟通协作的效率,ShowDoc 是一个非常适合 IT 团队的在线文档分享工具,为提升团队之间的沟通协作效率而生。本实验带您在 centos 系统上搭建基于 Nginx + PHP 的 ShowDoc 文档工具。
文档API:https://www.showdoc.cc/help
示例:https://www.showdoc.cc/demo
任务大纲
1、准备 Nginx + PHP 环境(耗时:10min ~ 20min)
2、创建项目(耗时:10min ~ 20min)
3、准备域名和解析(耗时:15min ~ 30min)
一、准备 Nginx + PHP 环境
准备 Nginx + PHP 环境
1、安装 Nginx
使用 yum 安装 Nginx:
yum install nginx
修改 /etc/nginx/nginx.conf 文件为如下内容:
user nginx;
worker_processes auto;
error_log /var/log/nginx/error.log;
pid /run/nginx.pid;
include /usr/share/nginx/modules/*.conf;
events {
    worker_connections 1024;
}
http {
    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';
                      
    access_log  /var/log/nginx/access.log  main;
    
    sendfile            on;
    tcp_nopush          on;
    tcp_nodelay         on;
    keepalive_timeout   65;
    types_hash_max_size 2048;
    
    include             /etc/nginx/mime.types;
    default_type        application/octet-stream;
    include /etc/nginx/conf.d/*.conf;
    
    server {
        listen       80;
        server_name  127.0.0.1;
        root         /var/www/html;
        index index.php index.html
        error_page  404              /404.html;
        
        location = /40x.html {
        }
        
        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
        }
        
        location ~ .php$ {
            root           /var/www/html;
            fastcgi_pass   127.0.0.1:9000;
            fastcgi_index  index.php;
            fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
            include        fastcgi_params;
        }
        
        location ~ /.ht {
            deny  all;
        }
    }
}启动 Nginx 并设置为开机启动:
service nginx start chkconfig nginx on
日志
[root@VM_117_117_centos ~]# service nginx start Redirecting to /bin/systemctl start nginx.service [root@VM_117_117_centos ~]# chkconfig nginx on Note: Forwarding request to 'systemctl enable nginx.service'. Created symlink from /etc/systemd/system/multi-user.target.wants/nginx.service to /usr/lib/systemd/system/nginx.service.
2、安装 PHP
使用 yum 安装 php-fpm:
yum install php php-gd php-fpm php-mcrypt php-mbstring php-mysql php-pdo
启动 php-fpm 并设置为开机启动:
service php-fpm start chkconfig php-fpm on
日志
[root@VM_117_117_centos ~]# service php-fpm start Redirecting to /bin/systemctl start php-fpm.service [root@VM_117_117_centos ~]# chkconfig php-fpm on Note: Forwarding request to 'systemctl enable php-fpm.service'. Created symlink from /etc/systemd/system/multi-user.target.wants/php-fpm.service to /usr/lib/systemd/system/php-fpm.service. [root@VM_117_117_centos ~]#
二、创建项目
1、下载安装 Composer
Composer 是 PHP 的一个依赖管理工具,推荐使用 Composer 创建 ShowDoc 项目。
执行如下命令安装 Composer:
curl -sS https://getcomposer.org/installer | php mv composer.phar /usr/local/bin/composer
2、设置 Composer 使用国内镜像
执行命令设置 Composer 使用国内镜像:
composer config -g repo.packagist composer https://packagist.phpcomposer.com
使用 Composer 创建项目
3、执行命令创建项目:
cd /var/www/html/ && composer create-project showdoc/showdoc
4、设置 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://119.29.239.104/showdoc/install/ ,进行语言的选择以后即可通过 http://119.29.239.104/showdoc 查看站点效果。
日志
[root@VM_117_117_centos ~]# curl -sS https://getcomposer.org/installer | php All settings correct for using Composer Downloading... Composer (version 1.5.2) successfully installed to: /root/composer.phar Use it: php composer.phar [root@VM_117_117_centos ~]# mv composer.phar /usr/local/bin/composer [root@VM_117_117_centos ~]# composer config -g repo.packagist composer https://packagist.phpcomposer.com [root@VM_117_117_centos ~]# cd /var/www/html/ && composer create-project showdoc/showdoc Installing showdoc/showdoc (v1.8.4) - Installing showdoc/showdoc (v1.8.4): Downloading (100%) Created project in /var/www/html/showdoc Loading composer repositories with package information Updating dependencies (including require-dev) Nothing to install or update Writing lock file Generating autoload files
三、准备域名和解析
1、域名注册
注:如果您不需要通过域名访问您的站点,请通过已完成,下一步跳过域名注册环节
如果您需要使用域名,可以在腾讯云上选购,过程可以参考下面的视频。
已完成,下一步
2、域名解析
注:如果您不需要通过域名访问您的站点,请通过已完成,下一步跳过域名解析环节
域名购买完成后, 需要将域名解析到实验云主机上,实验云主机的 IP 为:119.29.239.104
在腾讯云购买的域名,可以到控制台添加解析记录,过程可参考下面的视频:
域名设置解析后需要过一段时间才会生效,通过 ping 命令检查域名是否生效 ,如:
ping www.yourdomain.com
如果 ping 命令返回的信息中含有你设置的解析的 IP 地址,说明解析成功。
3、大功告成!
恭喜,您的 ShowDoc 站点已经部署完成,您可以通过浏览器访问查看效果。
通过IP地址查看:http://119.29.239.104/showdoc
通过域名查看:http://www.yourdomain.com/showdoc,其中替换 www.yourdomain.com 为之前申请的域名。
本文根据腾讯实验室操作总结
未经允许请勿转载:程序喵 » 基于 CentOS + Nginx + PHP 搭建 ShowDoc 文档工具
 程序喵
程序喵