mirror of
https://gitcode.com/waxgourd/addons
synced 2025-12-06 20:38:28 +08:00
81 lines
2.6 KiB
Markdown
81 lines
2.6 KiB
Markdown
# 冬瓜甄选addons：Home Assistant Redis 服务器插件
|
||
|
||
这个插件为 Home Assistant 提供了一个 Redis 服务器。Redis 是一个开源的内存数据库，可以用作缓存、消息代理和数据存储。
|
||
|
||
## 安装
|
||
|
||
1. 在 Home Assistant 中添加此存储库 URL 到您的插件商店
|
||
2. 安装 Redis 服务器插件
|
||
3. 启动 Redis 服务器插件
|
||
|
||
## 配置选项
|
||
|
||
| 选项 | 描述 |
|
||
| ---------- | ------------------------------ |
|
||
| port | Redis 服务器端口（默认：6379） |
|
||
| databases | Redis 数据库数量（默认：4） |
|
||
| password | Redis 认证密码（可选） |
|
||
| appendonly | 启用持久化存储（默认：开启） |
|
||
|
||
## 配置文件
|
||
|
||
插件第一次启动时会在`/config/redis/redis.conf`创建一个默认的 Redis 配置文件，并通过软链接到`/etc/redis.conf`。您可以直接编辑此配置文件来自定义 Redis 的高级设置。
|
||
|
||
配置文件的更改将在插件下次重启时生效。插件的基本设置（端口、数据库数量、密码和持久化）会在首次创建配置文件时自动应用。
|
||
|
||
## 如何使用
|
||
|
||
安装并启动后，Redis 服务器将在您的 Home Assistant 实例上运行。您可以使用标准的 Redis 客户端连接它：
|
||
|
||
```
|
||
redis-cli -h <YOUR_HOME_ASSISTANT_IP> -p 6379
|
||
```
|
||
|
||
如果您设置了密码，可以通过以下方式连接：
|
||
|
||
```
|
||
redis-cli -h <YOUR_HOME_ASSISTANT_IP> -p 6379 -a <YOUR_PASSWORD>
|
||
```
|
||
|
||
## 数据持久化
|
||
|
||
默认情况下，Redis 数据将保存在`/data`目录中。如果您启用了`appendonly`选项，Redis 将使用 AOF（Append Only File）方式进行持久化。
|
||
|
||
## 开发信息
|
||
|
||
### 自动化构建
|
||
|
||
本项目使用 GitLab CI 进行自动化构建。当代码推送到主分支或创建标签时，CI 流水线会自动构建并推送 Docker 镜像。
|
||
|
||
支持的架构：
|
||
|
||
- aarch64 (ARM 64 位)
|
||
- amd64 (x86_64)
|
||
|
||
### 手动构建
|
||
|
||
如需手动构建，可以使用以下命令：
|
||
|
||
```bash
|
||
# 获取版本号
|
||
VERSION=$(jq -r '.version' config.yaml)
|
||
ARCH="aarch64" # 或 "amd64"
|
||
|
||
# 从build.yaml获取基础镜像
|
||
BUILD_FROM=$(yq eval ".build_from.${ARCH}" build.yaml)
|
||
|
||
# 构建Docker镜像
|
||
docker build \
|
||
--build-arg BUILD_FROM="${BUILD_FROM}" \
|
||
--build-arg BUILD_ARCH="${ARCH}" \
|
||
--build-arg BUILD_VERSION="${VERSION}" \
|
||
-t "registry.wghaos.com/wghaos/redis-server:${ARCH}-${VERSION}" \
|
||
.
|
||
```
|
||
|
||
## 注意事项
|
||
|
||
- 默认情况下，Redis 仅监听本地网络。
|
||
- 建议为您的 Redis 实例设置密码以增强安全性。
|
||
- 如果您修改了配置文件中的基本设置（如端口），请确保同时更新插件的配置选项，以保持一致性。
|