https://github.com/arunesh90/http-redis
Small HTTP API server for Redis, with built-in compression. Great for serverless environments
https://github.com/arunesh90/http-redis
api brotli compression docker http keydb redis typescript
Last synced: 12 days ago
JSON representation
Small HTTP API server for Redis, with built-in compression. Great for serverless environments
- Host: GitHub
- URL: https://github.com/arunesh90/http-redis
- Owner: arunesh90
- License: mit
- Created: 2020-01-12T20:21:13.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-27T18:00:45.000Z (almost 5 years ago)
- Last Synced: 2025-10-25T16:39:10.373Z (3 months ago)
- Topics: api, brotli, compression, docker, http, keydb, redis, typescript
- Language: TypeScript
- Homepage:
- Size: 64.5 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
HTTP Redis API
> Simple HTTP API server for a Redis instance, with built-in compression.
## Install & Usage
#### Environment variables:
* `REDIS_PORT` (optional): Port of your Redis instance
* `REDIS_HOST` (optional): Hostname/ip of your Redis instance
* `REDIS_PASS` (optional): Password of your Redis instance
* `APP_PORT` (optional): App port
* `AUTH_KEY` (optional): Requires all requests to have the `AUTH_KEY` value set on the `Authorization` header
```sh
curl -X POST '127.0.0.1:8080/api/set/test' \
--header 'Content-Type: application/json' \
--data '{
"value": "test",
"compression": "brotli"
}'
# OK
curl '127.0.0.1:8080/api/get/test'
# {
# "found": true,
# "compression": "brotli",
# "value": "test"
# }
```
### Docker
```sh
docker pull arunesh90/http-redis
docker create arunesh90/http-redis \
-p 80:80 \
# Optional options
-e REDIS_PORT="6379" \
-e REDIS_HOST="127.0.0.1" \
-e REDIS_PASS="" \
-e APP_PORT="8080"
```
## Author
👤 **Arunesh**
* Twitter: [@arunesh90](https://twitter.com/arunesh90)
* Github: [@arunesh90](https://github.com/arunesh90)
* Discord: Pepe#9999 (97774439319486464)
## Show your support
Give a ⭐️ if this project helped you!
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_