Giter Site home page Giter Site logo

xtgxiso / orange Goto Github PK

View Code? Open in Web Editor NEW

This project forked from orlabs/orange

0.0 2.0 0.0 2.05 MB

OpenResty/Nginx Gateway for API Monitoring and Management.

Home Page: http://orange.sumory.com

License: MIT License

Lua 43.84% Nginx 0.95% CSS 3.88% JavaScript 28.49% HTML 22.77% Shell 0.07%

orange's Introduction

Orange

中文 English

API Gateway based on OpenResty.

Install

Clone the repo to local. Check the sample config file orange.conf first:

{
    "plugins": [ //available plugins. remove one if you do not need it.
        "stat", 
        "monitor", 
        "redirect", 
        "rewrite", 
        "basic_auth",
        "key_auth",
        "waf", 
        "divide"
    ],

    "store": "mysql",//only support `mysql` for now
    "store_mysql": { //config if you choose `mysql` store
        "timeout": 5000,
        "connect_config": {
            "host": "127.0.0.1",
            "port": 3306,
            "database": "orange",
            "user": "root",
            "password": "",
            "max_packet_size": 1048576
        },
        "pool_config": {
            "max_idle_timeout": 10000,
            "pool_size": 3
        },
        "desc": "mysql configuration"
    },

    "dashboard": {//dashboard config. if `store` is `mysql`, this will make sense
        "auth": false, //the dashboard UI should be authorized or not
        "session_secret": "y0ji4pdj61aaf3f11c2e65cd2263d3e7e5", // used to encrypt cookie
        "whitelist": [//url list that needn't be authorized
            "^/auth/login$",
            "^/error/$"
        ]
    },

    "api": {//api server authorization
        "auth_enable": true,//API should be authroized or not
        "credentials": [//HTTP Basic Auth config
            {
                "username":"api_username",
                "password":"api_password"
            }
        ]
    }
}

Import install/orange-${version} to MySQL and modify store_mysql as you want before you start Orange.

Then just type sh start.sh to start Orange. Maybe you should check the start script and customize it for your own need.

Documents

Find all about Orange on Documents Website. There is only a Chinese version for now.

Docker

http://hub.docker.com/r/syhily/orange maintained by @syhily

Contributors

See also

The architecture is highly inspired by Kong.

License

MIT

orange's People

Contributors

sumory avatar

Watchers

James Cloos avatar xtgxiso avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.