Chinese | |. English Website
A Gateway based on OpenResty(Nginx+lua) for API Monitoring and Management.
Install & Usages
- MySQL v5.5 to be +
- OpenResty V1.9.7.3 + or Nginx+ Lua Module
- install OpenResty with
--with-http_stub_status_moduleoption
- install OpenResty with
- Lor Framework please mind:
- Orange v0.6.1 and versions before v0.6.1 are compatible with lor v0.2.*
- Orange V0.6.2 + is compatible with LOR V0.3.0 +
Import the SQL file(e.g. install/orange-v0.6.3.sql) which is stuck to your orange version into MySQL database named orange.
Install
- script management
use shell scripts (e.g. start.sh) to manage Orange.
- CLI tool
In addition to start.sh script, a new cli tool could be utilized to manage Orange. You should install the cli first:
cd orange
make install
Copy the codethen, the Orange runtime lua module is installed in /usr/local/orange and an executable command named /usr/local/bin/orange is generated.
Before starting Orange, you should ensure that the orange.conf and nginx.conf are redefined to satisfy the demands of your project.
- script management
Just sh start.sh to start Orange. You could rewrite some other shell scripts as you need.
- CLI tool
orange help to check usages:
Usage: orange COMMAND [OPTIONS]
The commands are:
start Start the Orange Gateway
stop Stop current Orange
reload Reload the config of Orange
restart Restart Orange
store Init/Update/Backup Orange store
version Show the version of Orange
help Show help tipsCopy the codeDocuments
Find more about Orange on its website. There is only a Chinese version for now.
Docker
Store.docker.com/community/i… maintained by @syhily
- @syhily
- @lhmwzy
- @spacewander
- @noname007
- @itchenyi
See also
The plugin architecture is highly inspired by Kong.