RuleApi是基于Typecho的一款综合性API程序,专为typecho网站提供完善的API接入体验。具体的介绍已经放在之前的文章了,感兴趣可以直接过去阅读。

本文转载自规则之树 作者不暇
RuleApi一键安装

由于很多人反馈手动安装麻烦,或者不会弄,所以我写了这款安装脚本,可以一键安装环境和程序,而且就算安装失败,强行中断也不会对服务器造成什么不良影响,随便执行都可以。当然,这个脚本的主要目的,还是帮助使用者,更加快捷不费脑的安装RuleApi。

注意,脚本处于测试阶段,使用过程中出现的任何问题都可以加群询问:675025692

教程开始

第一步:前期准备部分

首先,要确定服务器上安装了typecho,因为RuleApi本质上是typecho的扩展,所以连接的也是typecho的数据库。然后,安装一个redis,这个宝塔都是自带的,随便就安装了,不需要我多说。
最后,执行如下指令,安装screen

yum install screen

screen是一款进程保护程序,可以让你就算退出了终端,指令也会继续运行。安装过程会让你输入y什么的,就直接输入y再Enter确定,如果没有也没关系。

第二步:执行安装脚本

首先创建一个进程保护窗口,再进入opt文件夹

screen -S api
cd /opt

然后执行RuleApi一键安装脚本,暂时只兼容Centos6以上版本,最好7(测试阶段)
主节点:

wget https://www.ruletree.club/api/ruleapi.sh && sh ruleapi.sh install

备用节点(由此链接赞助支持:Apple ID 共享、应用市场功能、软件仓库):

wget https://www.ruletree.club/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修改自己的配置文件,再执行脚本重启生效。

更多配置

因为脚本安装只是完成基础的安装,更多的设置需要编辑/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主页面后,请点击 初次安装执行 选项,完成最终的安装。

这里建议安装宝塔免费的nginx防火墙,可以有效防止爆破接口或者刷垃圾数据。已经有用户出现通过快捷登陆接口刷垃圾数据的情况,后续的接口更新我也会做处理。

本地图片上传

RuleAPi集成了oss和cos两种对象存储上传,如果都没有或者不想用的话,就需要配置本地图片上传。其实很简单,直接新增一个网站,目录设置为如下:

/opt/files/static

然后在可视化配置中心,设置访问图片的网址:

最后将请求图片上传的接口修改为本地上传接口/upload/localUpload,以APP的接口为例。

注意:对于老版本用户,也就是2022/03/03之前安装RuleApi的用户,如果使用的是本地上传接口,请将/opt/file:/opt/RuleApi.jar!/BOOT-INF/classes!下的static文件,移动到/opt/file/static中,如果没有就自己创建。

配置邮件和对象存储

访问之前的教程,跳过其它地方,直接看配置邮件和配置对象存储的地方
RuleApi详细安装教程,从环境到部署

如何更新脚本本身?

这个一键脚本我是会一直维护更新的,如果你本地的版本已经落后或者存在问题,可以通过下方的链接下载最新的sh文件,然后上传到服务器的opt目录,这样就可以保持脚本版本的最新

国内版下载

海外版下载

有任何问题都可以加群发言讨论,不要怕进去没人鸟,我会耐心解答(就是因为时差可能延迟)

QQ群号:776176904

如果服务器不是Centos7或者脚本安装没成功,可以手动安装,反正核心就是,只要有了java环境,就一切OK。
RuleApi一键安装–作者不暇