{"id":13740047,"url":"https://github.com/orlabs/orange","last_synced_at":"2025-05-15T04:04:41.524Z","repository":{"id":45308548,"uuid":"54266969","full_name":"orlabs/orange","owner":"orlabs","description":"OpenResty/Nginx Gateway for API Monitoring and Management.","archived":false,"fork":false,"pushed_at":"2023-08-25T07:34:51.000Z","size":3011,"stargazers_count":2312,"open_issues_count":77,"forks_count":576,"subscribers_count":158,"default_branch":"master","last_synced_at":"2025-04-14T04:59:53.528Z","etag":null,"topics":["api","gateway","lor","monitoring","nginx","ngx-lua","openresty","proxy","resty"],"latest_commit_sha":null,"homepage":"http://orange.sumory.com","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orlabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-03-19T13:19:41.000Z","updated_at":"2025-04-01T15:06:19.000Z","dependencies_parsed_at":"2022-08-28T05:10:32.409Z","dependency_job_id":"9cf9269e-c7f6-4ab8-9c32-490e43c9839b","html_url":"https://github.com/orlabs/orange","commit_stats":null,"previous_names":["sumory/orange"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orlabs%2Forange","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orlabs%2Forange/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orlabs%2Forange/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orlabs%2Forange/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orlabs","download_url":"https://codeload.github.com/orlabs/orange/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254270641,"owners_count":22042858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","gateway","lor","monitoring","nginx","ngx-lua","openresty","proxy","resty"],"created_at":"2024-08-03T04:00:41.781Z","updated_at":"2025-05-15T04:04:41.504Z","avatar_url":"https://github.com/orlabs.png","language":"Lua","funding_links":[],"categories":["Lua","API Gateways \u0026 Proxies"],"sub_categories":[],"readme":"# Orange\n\n [![Build Status](https://travis-ci.org/orlabs/orange.svg?branch=master)](https://travis-ci.org/orlabs/orange) [![license](https://img.shields.io/github/license/orlabs/orange.svg)](https://github.com/orlabs/orange/blob/master/LICENSE)\n\n\u003ca href=\"./README_zh.md\" style=\"font-size:13px\"\u003e中文\u003c/a\u003e | \u003ca href=\"./README.md\" style=\"font-size:13px\"\u003eEnglish\u003c/a\u003e | \u003ca href=\"http://orange.sumory.com\" style=\"font-size:13px\"\u003eWebsite\u003c/a\u003e\n\n\nA Gateway based on OpenResty(Nginx + Lua) for API Monitoring and Management.\n\n\n## Install \u0026 Usages\n\n### Install of Production Environment (Not Support macOS)\n\n#### 1) Install Dependencies\nWe recommend that you use [luarocks](https://luarocks.org/) to install `Orange` to reduce problems caused by dependency extensions in different operating system releases.\n\nSystem dependencies (`openresty`, `resty-cli`, `luarocks`, etc.) necessary to install `Orange` on different operating systems, See: [Install Dependencies](docs/install-dependencies.md) Document.\n\n#### 2) Install Lor Framework\n\nCheck the [official documentation](https://github.com/sumory/lor) for `Lor Framework` or execute the following command.\n\n```bash\ngit clone https://github.com/sumory/lor.git\ncd lor\nsudo make install\n```\n\n#### 3) Install Orange\n\n```bash\ncurl -Lo install.sh https://raw.githubusercontent.com/orlabs/orange/master/install/install-orange.sh\nsudo sh install.sh\n```\n\nAfter the installation process is completed, the output message `orange 0.8-1 is now installed in /usr/local/orange/deps (license: MIT)` indicates that the installation was successful.\n\n#### 4) Import MySQL\n\nRequirements: MySQL Version 5.5+\n\n - Login to the `MySQL` client, create an `orange` database.\n \n - Import the data table (`/usr/local/orange/conf/orange-v0.8.1.sql`).\n \n - Modify the `Orange` configuration file (`/usr/local/orange/conf/orange.conf`) `MySQL` related configuration.\n\n#### 5) Start Orange\n\n```bash\nsudo orange start\n```\n\nAfter the `Orange` launches successfully, the `dashboard` and `API Server` are started:\n\n - Access `Dashboard` via `http://localhost:9999`.\n - Access `API Server` via `http://localhost:7777`.\n\nAt this point, `Orange` has all been installed and configured, please enjoy it.\n\n### Install of Development Environment (Not Support macOS)\n\n#### 1) Dependencies and Lor\n\nPlease use the [Install Dependencies](#1-install-dependencies) and [Install Lor Framework](#2-install-lor-framework) methods in [Install of Production Environment](#install-of-production-environment-not-support-macos) to install.\n\n#### 2) Install Orange\n\n```bash\ngit clone https://github.com/orlabs/orange.git\ncd orange\nsudo make dev\n```\n\nAfter the installation process is completed, the output message `Stopping after installing dependencies for orange-master 1.0-0` indicates that the installation was successful.\n\n#### 3) Import MySQL\n\nPlease use the [Import MySQL](#4-import-mysql) methods in [Install of Production Environment](#install-of-production-environment-not-support-macos) to import.\n\nNote: Install `Orange` in `Development Environment`.\n\n- The `MySQL Data Table` file and the `Orange Config` file are located in the `conf` folder of the current project.\n\n- Import the data table (`/usr/local/orange/conf/orange-master.sql`).\n\n#### 4) Start Orange\n\n```bash\nsudo ./bin/orange start\n```\n\nAccess method after the successful startup of `Orange`, please refer to: [Start Orange](#5-start-orange) in [Install of Production Environment](#install-of-production-environment-not-support-macos).\n\n\n### Usages\n\n#### CLI tools\n\n`orange help` to check usages:\n\n```shell\nUsage: orange COMMAND [OPTIONS]\n\nThe commands are:\n\nstart   Start the Orange Gateway\nstop    Stop current Orange\nreload  Reload the config of Orange\nrestart Restart Orange\nstore   Init/Update/Backup Orange store\nversion Show the version of Orange\nhelp    Show help tips\n```\n\n\n## Documents\n\nFind more about `Orange` on its [website](http://orange.sumory.com/docs). There is only a Chinese version for now.\n\n\n## Docker\n\n[https://store.docker.com/community/images/syhily/orange](https://store.docker.com/community/images/syhily/orange) maintained by [@syhily](https://github.com/syhily)\n\n\n## Contributors\n\n- [@syhily](https://github.com/syhily)\n- [@lhmwzy](https://github.com/lhmwzy)\n- [@spacewander](https://github.com/spacewander)\n- [@noname007](https://github.com/noname007)\n- [@itchenyi](https://github.com/itchenyi)\n- [@Near-Zhang](https://github.com/Near-Zhang)\n- [@khlipeng](https://github.com/khlipeng)\n- [@wujunze](https://github.com/wujunze)\n- [@shuaijinchao](https://github.com/shuaijinchao)\n- [@EasonFeng5870](https://github.com/EasonFeng5870)\n- [@zhjwpku](https://github.com/zhjwpku)\n\n\n## See also\n\nThe plugin architecture is highly inspired by [Kong](https://github.com/Mashape/kong).\n\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forlabs%2Forange","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forlabs%2Forange","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forlabs%2Forange/lists"}