feat: add README
This commit is contained in:
@@ -1,12 +1,25 @@
|
||||
# Redis
|
||||
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
This service deploys Redis, an in-memory key-value store for caching and message brokering.
|
||||
|
||||
## Services
|
||||
|
||||
- `redis`: The Redis service.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable Name | Description | Default Value |
|
||||
| ------------------- | -------------------------------------------------------- | -------------------- |
|
||||
| REDIS_VERSION | Redis image version | `"8.2.1-alpine3.22"` |
|
||||
| SKIP_FIX_PERMS | Skip permission fixing, set to 1 to skip | `""` |
|
||||
| REDIS_PASSWORD | Password for the default "default" user | `""` |
|
||||
| REDIS_PORT_OVERRIDE | Host port mapping (maps to Redis port 6379 in container) | 6379 |
|
||||
| Variable Name | Description | Default Value |
|
||||
| ------------------- | -------------------------------------------------------- | ------------------ |
|
||||
| REDIS_VERSION | Redis image version | `8.2.1-alpine3.22` |
|
||||
| SKIP_FIX_PERMS | Skip permission fixing, set to 1 to skip | `""` |
|
||||
| REDIS_PASSWORD | Password for the default "default" user | `""` |
|
||||
| REDIS_PORT_OVERRIDE | Host port mapping (maps to Redis port 6379 in container) | 6379 |
|
||||
|
||||
Please modify the `.env` file as needed for your use case.
|
||||
|
||||
## Volumes
|
||||
|
||||
- `redis_data`: A volume for storing Redis data.
|
||||
- `redis.conf`: Optional custom configuration file (mount to `/etc/redis/redis.conf`).
|
||||
|
||||
Reference in New Issue
Block a user