Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
medcl committed Nov 12, 2024
1 parent 8c89437 commit 70e17d8
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

![](https://raw.githubusercontent.com/infinilabs/gateway/refs/heads/main/docs/static/img/logo-en.svg)

🎉🎉🎉🎉 Congratulations! You’ve found the ultimate gateway solution for Elasticsearch and OpenSearch! 🔥🔥🔥🔥
🎉🎉🎉🎉 Congratulations! You’ve found the ultimate gateway solution for Elasticsearch or OpenSearch! 🔥🔥🔥🔥


INFINI Gateway is a high performance gateway for Elasticsearch or OpenSearch. It offers a broad range of features and is easy to use. INFINI Gateway works in the same way as a common reverse proxy. It is usually deployed in front of clusters. All requests are sent to the gateway instead of server, and then the gateway forwards the requests to the back-end clusters. The gateway is deployed between the client and Elasticsearch or OpenSearch. Therefore, the gateway can be configured to perform index-level traffic control and throttling, cache acceleration for common queries, query request audit, and dynamic modification of query results.

## Report Bug and Issues

Head straight to https://github.com/infinilabs/gateway/issues for a list of all issues or click `Issues` in the navigation bar on the almost-top.
Expand All @@ -15,7 +17,7 @@ Use [Github's reactions feature](https://github.com/blog/2119-add-reactions-to-p

* **This tracker is for issues with the INFINI Gateway only.**

* Search for the issue [here](https://github.com/infinilabs/gateway/search?q=&type=Issues) or the disucssions [here](https://github.com/infinilabs/gateway/discussions) to check if it was already reported. You may use labels for filtering the [issue list](https://github.com/infinilabs/gateway/issues) by clicking any of these related to the problem you want to report or request.
* Search for the issue [here](https://github.com/infinilabs/gateway/search?q=&type=Issues) to check if it was already reported. You may use labels for filtering the [issue list](https://github.com/infinilabs/gateway/issues) by clicking any of these related to the problem you want to report or request.

## Filing a bug

Expand Down Expand Up @@ -43,6 +45,10 @@ If you want to be really good at reporting bugs, you can also read [these guidel

Note: "enhancements" are modifications to existing behavior as opposed to something entirely new.

---
To learn more about INFINI Gateway, please visit: http://docs.infinilabs.com/gateway/

# Community

Fell free to join the Discord server to discuss anything around this project:

Thanks for using INFINI Gateway.
[https://discord.gg/4tKTMkkvVX](https://discord.gg/4tKTMkkvVX)

0 comments on commit 70e17d8

Please sign in to comment.