feat: add README

This commit is contained in:
Sun-ZhenXing
2025-09-24 14:16:10 +08:00
parent 232517b58f
commit 70f39867cf
65 changed files with 1695 additions and 103 deletions

View File

@@ -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`).

25
src/redis/README.zh.md Normal file
View File

@@ -0,0 +1,25 @@
# Redis
[English](./README.md) | [中文](./README.zh.md)
此服务用于部署 Redis一个用于缓存和消息队列的内存键值数据库。
## 服务
- `redis`: Redis 服务。
## 环境变量
| 变量名 | 说明 | 默认值 |
| ------------------- | -------------------------------------------- | ------------------ |
| REDIS_VERSION | Redis 镜像版本 | `8.2.1-alpine3.22` |
| SKIP_FIX_PERMS | 跳过权限修复,设置为 1 跳过 | `""` |
| REDIS_PASSWORD | 默认 "default" 用户的密码 | `""` |
| REDIS_PORT_OVERRIDE | 主机端口映射(映射到容器内 Redis 端口 6379 | 6379 |
请根据实际需求修改 `.env` 文件。
## 卷
- `redis_data`: 用于存储 Redis 数据的卷。
- `redis.conf`: 可选的自定义配置文件(挂载到 `/etc/redis/redis.conf`)。