{"id":15567572,"url":"https://github.com/wgrape/ngxway","last_synced_at":"2025-04-15T11:07:24.733Z","repository":{"id":65685894,"uuid":"556660425","full_name":"WGrape/ngxway","owner":"WGrape","description":"A high-performance and lightweight Nginx gateway service / 高性能轻量级的Nginx网关服务","archived":false,"fork":false,"pushed_at":"2024-06-16T11:34:44.000Z","size":3508,"stargazers_count":27,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T11:07:03.312Z","etag":null,"topics":["api-gateway","gateway","lua","nginx","openresty"],"latest_commit_sha":null,"homepage":"https://wgrape.github.io/ngxway/","language":"Shell","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/WGrape.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-24T09:12:28.000Z","updated_at":"2024-06-16T11:34:47.000Z","dependencies_parsed_at":"2024-10-02T17:11:57.797Z","dependency_job_id":"84bddd63-8c75-4fd8-96d7-50523174027b","html_url":"https://github.com/WGrape/ngxway","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fngxway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fngxway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fngxway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fngxway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WGrape","download_url":"https://codeload.github.com/WGrape/ngxway/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249058370,"owners_count":21205910,"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","gateway","lua","nginx","openresty"],"created_at":"2024-10-02T17:11:49.830Z","updated_at":"2025-04-15T11:07:24.686Z","avatar_url":"https://github.com/WGrape.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg width=\"250\" src=\"https://user-images.githubusercontent.com/35942268/212838933-38bec2ca-c156-4c63-8563-c645bd476cb3.png\"\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003c!-- oscs: https://www.oscs1024.com/cd/1543980900807675904?sign=a3d02348 --\u003e\n    \u003c!-- https://www.murphysec.com/ --\u003e\n    \u003ca href=\"https://www.oscs1024.com/project/oscs/WGrape/ngxway?ref=badge_small\" alt=\"OSCS Status\"\u003e\u003cimg src=\"https://www.oscs1024.com/platform/badge/WGrape/ngxway.svg?size=small\"/\u003e\u003c/a\u003e\n    \u003c!-- \u003cimg src=\"https://github.com/wgrape/ngxway/actions/workflows/build.yml/badge.svg\"\u003e --\u003e\n    \u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/wgrape/ngxway\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Document-中文/English-orange.svg\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-MIT-green.svg\"\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003cp\u003eA high-performance and lightweight Nginx gateway service.\u003c/p\u003e\n    \u003cp\u003eDocument ：\u003ca href=\"/README.zh-CN.md\"\u003e中文\u003c/a\u003e / \u003ca href=\"/README.md\"\u003eEnglish\u003c/a\u003e \u0026nbsp; Wiki ：\u003ca href=\"/README.zh-CN.md\"\u003eEnglish\u003c/a\u003e \u003c/p\u003e\n\u003c/div\u003e\n\n## 1. Introduction\nngxway is a high-performance, containerized and lightweight nginx gateway.\n\n## 2. Features\n\n### (1) High-performance\nThis gateway service is mainly implemented in Lua and, with built-in Nginx configuration and Linux parameter optimizations, it can achieve an average QPS of ```50,000``` even without any tuning, on an ```8c16G``` machine.\n\nFor more information on performance, you can refer to the detailed [performance report](https://wgrape.github.io/ngxway/html/benchmark.html). How was it generated? Please refer to the [benchmark document](./doc/benchmark.md) if necessary.\n\n\u003cimg width=\"900\" alt=\"image\" src=\"https://user-images.githubusercontent.com/35942268/224526169-3ca6cd09-380d-4acf-b184-b972db85685b.png\"\u003e\n\n### (2) Containerized\n\nBuilt on Docker and decoupled from the underlying Nginx configuration, this gateway eliminates 90% of the setup process. With just one command, you can automatically set up your own Nginx gateway.\n\n\u003c!-- image --\u003e\n\n### (3) Lightweight\n\nCompared to complex gateway implementations, this project is much lighter. You can freely modify various configurations of the project, as well as modify and add various Lua scripts to improve the overall performance of ngxway for your business.\n\n\u003c!-- image --\u003e\n\n## 3. Installation\n\nTo reduce installation costs and facilitate quick setup, simply execute the following command.\n\n```bash\n# install\ngit clone https://github.com/WGrape/ngxway.git \u0026\u0026 cd ngxway \u0026\u0026 bash install.sh\n\n# uninstall\ncd ngxway \u0026\u0026 bash uninstall.sh\n```\n\n## 4、Usage\n\n### (1) Start the server\nExecute the following command to start the ngxway server. If you can successfully open the ```127.0.0.1:8090``` page, it means that the server has started successfully.\n\n```bash\nbash bin/ngxway start\n```\n\n### (2) Stop server\nExecute the following command to stop the ngxway server.\n\n```bash\nbash bin/ngxway stop\n```\n\n### (3) Restart server\nExecute the following command to restart the ngxway server.\n\n```bash\nbash bin/ngxway restart\n```\n\n### (4) Server log\nThe logs of ngxway will be recorded in the ```local_volume_logs_dir``` log directory defined in the [./ngxway.conf](./ngxway.conf) file, the default is ```/tmp /logs``` directory.\n\n### (5) To Integrate\nCongratulations on successfully installing and starting the ngxway server! However, before you make any modifications to the project, it is not yet ready to provide gateway services for you. If you need to integrate, please refer to the [Wiki](https://github.com/WGrape/ngxway/wiki/).\n\n## 6. Contribution\nIn the process of using this project, if you encounter any problems, please refer to [Q\u0026A](https://github.com/WGrape/ngxway/wiki/Q\u0026A) document.\n\nWelcome your [Issues](https://github.com/WGrape/ngxway/issues/new) and [Pull Requests](https://github.com/WGrape/ngxway/pulls).\n\n\u003cimg src=\"https://contrib.rocks/image?repo=wgrape/ngxway\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwgrape%2Fngxway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwgrape%2Fngxway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwgrape%2Fngxway/lists"}