当前指南适用于 2.8.15 及以下版本

概述

  • PearProject 不支持 IE8 及以下版本，建议使用基于Webkit内核的现代浏览器访问

  • PearProject 为前后端分离架构，因此安装分为后端和前端两大部分，需要分别进行部署和运行

    更新日志

    最新版本：2.8.16
    每个版本的更新日志参考 语雀
    查看当前版本

  • 后端：./config/app.php app_version

  • 前端：./src/config/version.js VERSION

    后端安装

    源码地址

    环境要求

  • PHP >= 7.2.0

  • MySQL >= 5.6.0 (需支持innodb引擎)
  • Nginx/Apache
  • PDO PHP Extension
  • Redis(非必须)
  • Composer (非必须)

亦可以使用phpstudy集成环境 下载地址

安装步骤

获取后端文件

你可以通过以下两种方式获取后端文件，并将文件放置（解压）到站点目录下。如果你使用phpstudy安装环境，则默认站点目录为：[你的磁盘]\phpStudy\PHPTutorial\WWW

  1. 直接下载
    image.png

  2. 使用Git: git clone https://github.com/a54552239/pearProjectApi

    安装依赖

    依然有两种方式安装接口运行所需的依赖

  3. Composer 下载地址

    1. 下载并安装Composer
    2. 使用原镜像地址可能会比较缓慢，可以使用 阿里云 composer 镜像官网地址，使用方式参考：https://learnku.com/php/t/30716

进入后端根目录，运行CMD，输入命令 composer install 安装依赖

  1. 下载vendor.zip，直接解压到后端根目录，覆盖原有的vendor文件夹（如果没有则创建）

    MySQL配置

    修改MySQL配置文件my.ini，加入一行 sql_mode=NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES

    *安装Redis

  2. 下载并安装Redis，有两种安装方式

    1. msi安装，地址：https://github.com/MicrosoftArchive/redis/releasesimage.png
    2. tar.gz安装，地址：https://www.redis.net.cn/download/
      image.png
      1. 下载后解压，解压位置可以自己选择
  3. 在解压目录下打开cmd命令窗口，使用命令进行安装
  4. 安装命令 redis-server.exe —service-install redis.windows.conf —loglevel verbose
  5. 启动Redis
    1. 在解压目录下打开cmd命令窗口
    2. 启动服务命令： redis-server.exe —service-start
    3. 关闭服务命令： redis-server.exe —service-stop
  6. 安装PHP Redis扩展，注意选择合适当前php版本的扩展
    1. 下载 php_redis 扩展，地址：php_redis
    2. 下载 php_igbinary，地址：php_igbinary
    3. 下载后，将压缩包中的php_redis.dll和php_igbinary.dll文件放入PHP目录下的ext目录
    4. 编辑php.ini， 最后加入两行

      1. extension=php_igbinary.dll
      2. extension=php_redis.dll

若不使用Redis驱动，按以下方式进行修改

  1. 修改./config/config/cache.php 为
    1. return [
    2.  // 驱动方式
    3.  'type'   => 'File',
    4.  // 缓存保存目录
    5.  'path'   => '',
    6.  // 缓存前缀
    7.  'prefix' => '',
    8.  // 缓存有效期 0表示永久缓存
    9.  'expire' => 0,
    10. ];
    2.修改./config/config/session.php，注释掉第10行。最终代码为 ```php <?php / 定义Session会话字段名 / $sessionname = ‘s’ . substr(md5(_DIR), -8); $session_path = env(‘runtime_path’) . ‘sess’ . DIRECTORY_SEPARATOR; file_exists($session_path) || mkdir($session_path, 0755, true);

/ 定义Session会话参数 / return [ ‘id’ => ‘’, // ‘type’ => ‘redis’, ‘prefix’ => ‘ta’, ‘expire’ => 3600 * 24, ‘auto_start’ => true, ‘path’ => $session_path, ‘name’ => $session_name, ‘var_session_id’ => $session_name,

// ‘use_trans_sid’ => 0, // ‘httponly’ => true, // ‘secure’ => true,

  1. // redis主机
  2. 'host'       => '127.0.0.1',
  3. // redis端口
  4. 'port'       => 6379,
  5. // 密码
  6. 'password'   => '',

];

  2. <a name="3UivO"></a>
  3. ### 运行
  5. 1. 打开浏览器
  6. 1. 输入：[http://127.0.0.1/pearProjectApi](http://127.0.0.1/pearProjectApi) [这里的地址为实际的站点目录]，查看是否安装成功
  7. 1. 输入[http://127.0.0.1/pearProjectApi/index.html](http://127.0.0.1/pearProjectApi/index.html) [这里的地址为实际的站点目录]
  8. 1. 开始使用
  12. 如需进一步了解，请继续往下阅读
  13. <a name="aYJj5"></a>
  14. # 前端安装
  15. [源码地址](https://github.com/a54552239/pearProject)
  16. <a name="0QYaI"></a>
  17. ## 环境要求
  19. - Node.js >= 10.0.0
  20. <a name="OrYmB"></a>
  21. ## 安装步骤
  22. <a name="9QRG9"></a>
  23. ### 获取前端文件
  24. 你可以通过以下两种方式获取前端文件，文件可以放在任意目录
  26. 1. 直接下载<br />![image.png](https://cdn.nlark.com/yuque/0/2019/png/196196/1562561156330-8d0b8c6e-0c4e-4576-b371-1d6dffedc20c.png#align=left&display=inline&height=686&margin=%5Bobject%20Object%5D&name=image.png&originHeight=686&originWidth=1112&size=105110&status=done&style=none&width=1112)
  27. 1. 使用Git: git clone [https://github.com/a54552239/pearProject](https://github.com/a54552239/pearProject)
  28. <a name="Nn1fa"></a>
  29. ### 安装Node.js
  30. [下载地址](https://nodejs.org/dist/v10.16.0/node-v10.16.0-x64.msi)
  32. 1. 安装node.js
  33. 1. 安装npm淘宝镜像
  34.    1. 运行cmd
  35.    1. 输入： npm install -g cnpm --registry=https://registry.npm.taobao.org 
  36. <a name="VmSJU"></a>
  37. ### 安装依赖
  39. 1. 进入前端项目目录，运行cmd命令行
  40. 1. 命令行输入  cnpm install  或  npm install 
  41. 1. 修改./vue.config.js，将  DEV_URL  的值改为接口地址，如：[http://127.0.0.1:8010/pearProjectApi](http://127.0.0.1:8010/pearProjectApi)
  42. <a name="BSFDU"></a>
  43. ### 启动项目
  45. 1. 在cmd命令行下输入  npm run serve 
  46. 1. 根据提示输入网址访问<br />![image.png](https://cdn.nlark.com/yuque/0/2019/png/196196/1562564137830-a9ed5ea3-3831-4e6a-a95d-c802e3070d2d.png#align=left&display=inline&height=502&margin=%5Bobject%20Object%5D&name=image.png&originHeight=502&originWidth=957&size=16482&status=done&style=none&width=957)
  47. 1. 如果上述步骤都实践成功，页面会自动跳转至安装界面，请根据提示填写数据库信息进行安装 。phpstudy集成环境下，数据库密码为root或空。<br />![image.png](https://cdn.nlark.com/yuque/0/2019/png/196196/1562564241816-c4b3215f-c3ab-4161-b09e-2010e365f1f3.png#align=left&display=inline&height=930&margin=%5Bobject%20Object%5D&name=image.png&originHeight=930&originWidth=1912&size=92826&status=done&style=none&width=1912)
  48. 1. 若你需要重新执行安装流程，请将后端 data 目录下的 **install.lock** 文件删除
  49. 1. 若你希望手动导入数据，请将后端 data 目录下的 **pearproject.sql** 导入到数据库中，并在该目录下创建** install.lock** 文件
  50. <a name="zmAf6"></a>
  51. ## 打包部署
  52. 如果需要在生产环境下运行PearProject，必须先将前端文件打包后上传至服务器（不需要在服务器上打包）
  53. <a name="Vl4ha"></a>
  54. ### 修改配置
  56. 1. 修改./src/config/config.js，将  PRO_URL  的值修改为正式接口地址，如：[http://example.com/index.php](http://example.com/index.php)
  57. 1. 修改./vue.config.js，将  publicPath  值改为  ./ 。这个值的为打包后的index.html所引用的静态资源相对路径，请根据实际的文件位置进行调整。若你有CDN，此处可以修改为CDN地址，然后将打包的文件上传至CDN服务器。
  58. <a name="H64Z9"></a>
  59. ### 打包命令
  61. 1. 在前端文件跟目录下运行cmd，输入  npm run build  执行打包操作。
  62. 1. 将dist目录下的文件上传至服务器
  63. <a name="1BXbp"></a>
  64. ### 访问项目
  65. <a name="75g50"></a>
  66. ## 跨域支持
  67. 如果你的接口地址和项目访问域名不相同，需开启跨域支持。
  68. <a name="tZhek"></a>
  69. ### 修改配置
  71. 1. 修改./src/config/config.js，将crossDomain 值改为  true 
  72. 1. 修改./src/config/config.js，将  PRO_URL  的值修改为实际接口地址
  73. <a name="veOpC"></a>
  74. ### 重启项目
  76. 1. 本地开发模式：在cmd命令行下按下  ctrl+c  终止，然后输入  npm run serve 重启
  77. 1. 打包部署：  在cmd命令行下输入  npm run build  重新进行打包操作，将dist目录下的文件上传至服务器
  78. <a name="uvvQd"></a>
  79. # 其他
  80. <a name="sLUAs"></a>
  81. ## 消息推送
  82. <a name="7OYlp"></a>
  83. ### 桌面推送
  84. 如需开启消息推送功能，需要执行以下几步操作。
  85. <a name="0BBng"></a>
  86. #### 后端
  88. 1. 进入./application/common/Plugins/GateWayWorker
  89. 1. 修改config.php，将 SERVER_ADDRESS 的值为内网IP地址，如  192.168.0.110  。端口号根据情况需改，注意服务器要放行对应的端口
  91. 如果是HTTPS协议，需要开启SSL支持。将 USE_SSL 的值修改为  true  ，修改根目录下  server.key  和  server.pem 文件，填入证书信息。
  93. 3. Windows环境下，直接运行start_for_win.bat文件
  94. 3. Linux环境下，运行 bash start.sh 启动服务，运行 bash stop.sh 终止服务
  95. 3. 进入./config/config.php 修改 notice_push 的值为  true 
  96. <a name="Ge24N"></a>
  97. #### 前端
  99. 1. 进入 ./src/config/config.js
  100. 1. 将 WS_URI 的值修改为相应的ip地址，如  ws://192.168.0.110  。如果使用https，此处不能填写ip地址，需要写实际的域名，如： wss://example.com:2345 
  101. <a name="MMqMW"></a>
  102. ### 钉钉推送
  103. 支持将消息实时推送至企业钉钉。**开启前需要先到企业钉钉添加应用以获取配置所需的信息。**
  104. <a name="J5bhY"></a>
  105. #### 后端
  107. 1. 进入./config/config.php 修改 dingtalk_push 的值为  true 
  108. 1. 进入./config/dingtalk.php 修改 agent_id 的值为 对应的应用id
  110. 支持通过钉钉登录和钉钉内免密登录<br />![image.png](https://cdn.nlark.com/yuque/0/2019/png/196196/1562566554835-2bb65f35-ecea-40a7-82e2-da5ea17669f8.png#align=left&display=inline&height=930&margin=%5Bobject%20Object%5D&name=image.png&originHeight=930&originWidth=1911&size=92934&status=done&style=none&width=1911)
  111. <a name="pF6K6"></a>
  112. ### 修改配置
  114. 1. 进入./config/dingtalk.php 填写好对应的配置信息，其中 oauth->redirect 的值为 https://你的域名/index.php/index/oauth/dingTalkOauthCallback
  115. <a name="HOrj4"></a>
  116. ## 任务燃尽图
  117. <a name="gdtC9"></a>
  118. ### 修改后端配置
  120. 1. 进入./application/common/Plugins/GateWayWorker
  121. 1. 修改config.php，将 SITE_URL 的后端接口地址，如 [https://beta.vilson.xyz](https://beta.vilson.xyz)
  122. 1. Windows环境下，直接运行crontab.bat文件
  123. 1. Linux环境下，运行 bash crontab.sh 启动服务，运行 bash crontab_stop.sh 终止服务
  124. 1. 系统会在每日23:55自动统计当日的任务情况
  125. <a name="bzRz6"></a>
  126. ## 短信
  127. <a name="VzATr"></a>
  128. ### 修改配置
  130. 1. 进入 ./config/sms.php 填写对应的配置信息， debug  的值设置为  false 
  131. <a name="NPgHk"></a>
  132. ### 参考资料 
  133. [https://github.com/overtrue/easy-sms](https://github.com/overtrue/easy-sms)
  134. <a name="PmpHT"></a>
  135. ## 邮件
  136. <a name="gZX0R"></a>
  137. ### 修改配置
  139. 1. 进入 ./config/mail.php 填写对应的配置信息， open  的值设置为  true 
  140. <a name="sXHzB"></a>
  141. ### 参考资料 
  142. [https://github.com/PHPMailer/PHPMailer](https://github.com/PHPMailer/PHPMailer/)
  143. <a name="tHokK"></a>
  144. ## 第三方存储
  145. <a name="4qGaY"></a>
  146. ### 修改配置
  148. 1. 进入 ./config/storage.php 填写对应的配置信息，修改  stoage_type  为对应的值，目前支持上传至七牛云和阿里云OSS
  149. <a name="7TD2P"></a>
  150. ### 参考资料 
  151. [https://developer.qiniu.com/](https://developer.qiniu.com/)<br />[https://help.aliyun.com/product/31815.html](https://help.aliyun.com/product/31815.html)
  152. <a name="rolGJ"></a>
  153. ## 系统升级
  154. <a name="hN5XK"></a>
  155. ### Git
  156. 通过git clone方式部署的用户，可以根据以下方式进行升级
  158. 1. 通过  git pull  命令拉取代码
  159. 1. 若前端代码有更新，则需要重新启动项目
  160. 1. 若后端 ./data 目录下有新的版本文件夹，说明数据库结构有所改动，需要手动执行对应的版本升级sql文件
  161. <a name="DWutn"></a>
  162. ## 常见问题
  163. <a name="XbXA0"></a>
  164. ### 访问接口404
  166. 1. 检查前端接口地址是否配置正确
  167. 1. 修改nginx配置文件，增加以下配置开启pathinfo路由模式

location / { try_files $uri $uri/ /index.php$uri; if ( -f $request_filename) {
break;
}
if ( !-e $request_filename) {
rewrite ^(.)$ /index.php/$1 last;
break;
}
} location ~ .php(.)$ { fastcgi_pass 127.0.0.1:9000; fastcgi_index index.php; fastcgi_split_path_info ^((?U).+.php)(/?.+)$; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info; include fastcgi_params; } ```

初次运行无法跳转至安装页面

  1. 检查接口是否运行正常
  2. 检查是否成功安装redis扩展

    无法下载模板/文件

    需要开启php_fileinfo扩展