RuleApi一键安装&更新脚本,傻瓜式配置,超快速运行
由于很多人反馈手动安装麻烦,或者不会弄,所以我写了这款安装脚本,可以一键安装环境和程序,而且就算安装失败,强行中断也不会对服务器造成什么不良影响,随便执行都可以。当然,这个脚本的主要目的,还是帮助使用者,更加快捷不费脑的安装RuleApi。
教程开始
第一步:前期准备部分
服务器配置要求:
最低配置:1核CPU 700M运行内存
推荐配置:2核CPU 2G运行内存
前置要求如下:
Typecho(1.0 or 1.1 or 1.2):可选择不安装。Typecho是一款国内有名的个人博客开源程序,拥有丰富的模板和插件生态。
Redis(5.0-7.0):推荐6.0,Redis是现在最受欢迎的NoSQL数据库之一。
Mysql(5.5-5.7):推荐5.6
准备两个域名,一个用来访问Typecho,一个用来访问RuleApi
最重要的是安装Redis,可以通过宝塔的应用中心直接搜索安装。对于Typecho,如果你需要网页端支持的话,请安装Typecho程序,如果你不需要,可以直接看下面的步骤安装RuleApi,配置完成后将提示你是否选择独立安装,选择是则可以独立安装RuleApi。
最后,执行如下指令,安装screen
yum install screen -y
screen是一款进程保护程序,可以让你就算退出了终端,指令也会继续运行。安装过程会让你输入y什么的,就直接输入y再Enter确定,如果没有也没关系。
千万千万别做如下的操作:
如果在服务器上自己安装Java环境,或者在宝塔软件中心安装Java和tomcat,这将直接导致API安装后无法运行,并且造成后续的一系列问题。
第二步:执行安装脚本
首先创建一个进程保护窗口,再进入opt文件夹
screen -S api
cd /opt
然后执行RuleApi一键安装脚本,暂时只兼容Centos6以上版本,最好7(测试阶段)
主节点:
wget https://www.ruletree.club/api/ruleapi.sh && sh ruleapi.sh install
运行成功效果如下:
安装完成后,将服务器/opt文件夹中的apiResult.php文件,剪切到typecho网站的根目录。
第三步:后续说明
脚本还提供其它管理选项,分别是如下:
注意,项目启动之后,运行日志将输出到/opt目录下out.txt文件,如果启动后出现异常或者无法访问,可以打开这个文件查看具体的原因。/opt/application.properties为主要的配置文件,如果出现安装脚本配置错误,项目无法正常启动,就可以在这个文件进行修改。
启动RuleAPi
sh /opt/ruleapi.sh start
停止RuleAPi
sh /opt/ruleapi.sh stop
重启RuleAPi
sh /opt/ruleapi.sh restart
删除RuleAPi
sh /opt/ruleapi.sh uninstall
查看帮助信息
sh /opt/ruleapi.sh help
RuleApi更新
首先执行更新脚本(如果执行无效,点击下载最新版的sh,丢进/opt再试试执行):
sh /opt/ruleapi.sh update
该脚本会下载当前服务器最新版jar和最新版的脚本文件,并将新版的新版配置文件application.properties下载至/opt/upfile,更新过程并不会重启接口,请自己对照/opt/upfile中的配置文件,查看是否有新增项,然后修改/opt/application.properties,比对无误后,执行重启脚本:
sh /opt/ruleapi.sh restart
有时候更新会失败,比如我的服务器被攻击,或者更新包下载不下来(服务器配置不高,穷)。这个时候,可以去这个文章,直接下载最新版本的压缩包,首先停止接口运行,把jar上传到opt,然后对比最新版的application.properties修改自己的配置文件,再执行脚本重启生效。
更新到内测版
同时,你还可以根据如下指令更新到内测版本。内测版本可能会增加新的功能与支持,但也可能存在未知bug。
sh /opt/ruleapi.sh updateBeta
开机自启和宕机自启
目前脚本已经添加了monitor监听方法,执行后将检测RuleAPI是否正常运行,如果未运行状态则执行启动命令。具体指令如下:
sh /opt/ruleapi.sh monitor
所以,只需要让这个命令几分钟执行一次,监听项目是否运行正常,未运行就开始运行,就可以实现开机自启和宕机自启,以宝塔面板为例,直接在计划任务中增加如下的任务即可,间隔可以3分钟到10分钟,这样开启或者宕机后几分钟内就会自行启动。
更多配置
因为脚本安装只是完成基础的安装,更多的设置需要编辑/opt/application.properties文件,里面就可以配置包括对象存储,数据库前缀,图片key,和其它更加详细的信息等,修改完成后,通过执行重启指令生效。
sh /opt/ruleapi.sh restart
如何访问RuleAPi?
宝塔里额外创建一个网站(二级域名,千万别和其它网站共用),网站类型为静态就好,然后找到伪静态设置,加入如下代码保存。
location ^~ / {
add_header 'Access-Control-Allow-Origin' '*';
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS, PUT, DELETE';
add_header 'Access-Control-Allow-Credentials' 'true';
add_header 'Access-Control-Allow-Headers' 'Authorization,Content-Type,Accept,Origin,User-Agent,DNT,Cache-Control,X-Mx-ReqToken,X-Data-Type,X-Requested-With,X-Data-Type,X-Auth-Token';
if ( $request_method = 'OPTIONS' ) {
return 200;
}
proxy_pass http://127.0.0.1:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header REMOTE-HOST $remote_addr;
}
上述代码的用途是反向代理,并获取真实IP,且开始跨域。宝塔自带的反向代理功能比较复杂,所以省事的话,请采用上述的方法。其中127.0.0.1:8080就是你的内网接口地址,这里只需要改8080这个端口号(如果你定义了其它的话)
整个过程不要开启任何外网端口,切记!!!!
访问RuleApi主页面后,请点击这个选项,完成最终的安装。
付费广告过期监听
付费广告模块在广告到期后,需要将广告变为下架状态,所以我提供了一个监听接口,加入宝塔的计划任务就好了。监听的地址如下:
接口地址/system/taskAds?webkey=接口访问KEY
可参考下图设置,周期小时或者分钟都可以,目的是让过期广告到期。
到这里就基本差不多了