docs: update features
This commit is contained in:
37
README.md
37
README.md
@@ -1,4 +1,4 @@
|
|||||||
# Goma Gateway - simple lightweight API Gateway and Reverse Proxy.
|
# Goma Gateway - simple lightweight API Gateway.
|
||||||
|
|
||||||
```
|
```
|
||||||
_____
|
_____
|
||||||
@@ -9,7 +9,7 @@
|
|||||||
\_____|\___/|_| |_| |_|\__,_|
|
\_____|\___/|_| |_| |_|\__,_|
|
||||||
|
|
||||||
```
|
```
|
||||||
Goma Gateway is a lightweight API Gateway and Reverse Proxy.
|
Goma Gateway is a lightweight API Gateway.
|
||||||
|
|
||||||
Simple, easy to use, and configure.
|
Simple, easy to use, and configure.
|
||||||
|
|
||||||
@@ -23,24 +23,25 @@ Simple, easy to use, and configure.
|
|||||||
- [Docker Hub](https://hub.docker.com/r/jkaninda/goma-gateway)
|
- [Docker Hub](https://hub.docker.com/r/jkaninda/goma-gateway)
|
||||||
- [Github](https://github.com/jkaninda/goma-gateway)
|
- [Github](https://github.com/jkaninda/goma-gateway)
|
||||||
|
|
||||||
## Documentation is found at <https://jkaninda.github.io/goma-gateway>
|
|
||||||
|
|
||||||
### Feature
|
### Features
|
||||||
|
|
||||||
- [x] Reverse proxy
|
It comes with a lot of integrated features, such as:
|
||||||
- [x] API Gateway
|
|
||||||
- [x] Domain/host based request routing
|
- Reverse proxy
|
||||||
- [x] Multi domain request routing
|
- RESTFull API Gateway management
|
||||||
- [x] Cross-Origin Resource Sharing (CORS)
|
- Domain/host based request routing
|
||||||
- [ ] Support TLS
|
- Multi domain request routing
|
||||||
- [x] Backend errors interceptor
|
- Cross-Origin Resource Sharing (CORS)
|
||||||
- [x] Authentication middleware
|
- Backend errors interceptor
|
||||||
- [x] JWT ` client authorization based on the result of a request`
|
- Authentication middleware
|
||||||
- [x] Basic-Auth
|
- JWT `client authorization based on the result of a request`
|
||||||
- [ ] OAuth
|
- Basic-Auth
|
||||||
- [x] Implement rate limiting
|
- Rate limiting
|
||||||
- [x] In-Memory Token Bucket based
|
- In-Memory Token Bucket based
|
||||||
- [x] In-Memory client IP based
|
- In-Memory client IP based
|
||||||
|
|
||||||
|
### Todo:
|
||||||
- [ ] Distributed Rate Limiting for Token based across multiple instances using Redis
|
- [ ] Distributed Rate Limiting for Token based across multiple instances using Redis
|
||||||
- [ ] Distributed Rate Limiting for In-Memory client IP based across multiple instances using Redis
|
- [ ] Distributed Rate Limiting for In-Memory client IP based across multiple instances using Redis
|
||||||
|
|
||||||
|
|||||||
@@ -6,12 +6,12 @@ nav_order: 1
|
|||||||
|
|
||||||
# About Goma Gateway
|
# About Goma Gateway
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
Goma Gateway is a lightweight API Gateway and Reverse Proxy.
|
Goma Gateway is a lightweight API Gateway.
|
||||||
|
|
||||||
It comes with a lot of integrated features, such as:
|
It comes with a lot of integrated features, such as:
|
||||||
|
|
||||||
- Reverse proxy
|
- Reverse proxy
|
||||||
- RESTfull API Gateway management
|
- RESTFull API Gateway management
|
||||||
- Domain/host based request routing
|
- Domain/host based request routing
|
||||||
- Multi domain request routing
|
- Multi domain request routing
|
||||||
- Cross-Origin Resource Sharing (CORS)
|
- Cross-Origin Resource Sharing (CORS)
|
||||||
|
|||||||
Reference in New Issue
Block a user