README.md

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

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

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
• Github: @arunesh90
• Discord: Pepe#9999 (97774439319486464)

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator