首次推出xiaozhi-esp32-server-mini、xiaozhi-esp32-server、xiaozhi-esp32-webui;

This commit is contained in:
waxgourd
2025-04-24 20:01:52 +08:00
parent 3d99d2296d
commit 065e754376
26 changed files with 907 additions and 0 deletions

88
redis-server/DOCS.md Normal file
View File

@@ -0,0 +1,88 @@
# Redis 服务器
Redis 是一个开源的内存数据库,可以用作缓存、消息代理和数据存储。此插件为您的 Home Assistant 安装 Redis 服务器。
## 如何使用
安装后Redis 服务器将在默认端口6379上运行并可以通过 Home Assistant 或网络中的其他设备访问。
### 配置
以下选项可在插件配置页面上设置:
```yaml
# 示例配置
port: 6379
databases: 4
password: mypassword # 强烈建议设置密码
appendonly: true
```
#### 选项 `port`
Redis 服务器的监听端口。默认是 6379。
#### 选项 `databases`
Redis 实例中的数据库数量。默认是 4。
#### 选项 `password`
可选的 Redis 认证密码。为了安全起见,强烈建议设置此选项。
#### 选项 `appendonly`
启用/禁用 AOFAppend Only File持久化。此选项默认为启用确保在重启后数据仍然可用。
## 高级配置
本插件支持使用完整的 Redis 配置文件进行高级配置。插件首次启动时,会在`/config/redis/redis.conf`创建一个默认的 Redis 配置文件,并通过软链接连接到`/etc/redis.conf`
您可以通过直接编辑`/config/redis/redis.conf`文件来自定义 Redis 的所有设置。这些更改将在插件下次重启时生效。
### 配置文件路径
- 主配置文件:`/config/redis/redis.conf`
- 软链接位置:`/etc/redis.conf`
### 常用高级配置选项
以下是一些您可能需要在配置文件中调整的常用高级选项:
```
# 内存限制
maxmemory 100mb
maxmemory-policy allkeys-lru
# 快照配置
save 900 1
save 300 10
save 60 10000
# 连接限制
maxclients 1000
# 日志级别
loglevel notice
```
关于所有可用配置选项的详细说明,请参考[Redis 官方文档](https://redis.io/topics/config)。
### 注意事项
- 如果您在配置文件中修改了基本设置(如端口号),请确保同时更新插件的配置选项,以保持一致性。
- 建议在修改配置文件前先创建备份。
- 不当的配置更改可能导致 Redis 服务无法启动。
## 使用案例
Redis 服务器可以用于多种场景:
1. 高速缓存
2. 用于 Home Assistant 自动化规则的消息代理
3. 临时数据存储
4. 跨设备/服务的共享状态存储
## 支持
如有问题或建议,请通过 GitHub 仓库提交问题。

80
redis-server/README.md Normal file
View File

@@ -0,0 +1,80 @@
# 冬瓜甄选addonsHome 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 将使用 AOFAppend 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 实例设置密码以增强安全性。
- 如果您修改了配置文件中的基本设置(如端口),请确保同时更新插件的配置选项,以保持一致性。

29
redis-server/config.yaml Normal file
View File

@@ -0,0 +1,29 @@
name: "Redis Server"
version: "7.2.7"
slug: "redis-server"
description: "Redis数据库服务器插件为您的Home Assistant提供高性能缓存和数据存储服务"
url: "https://github.com/redis/redis"
startup: services
boot: manual
init: false
host_network: false
ingress: false
arch:
- aarch64
- amd64
map:
- config:rw
ports:
6379/tcp: 6379
ports_description:
6379/tcp: "Redis服务器端口"
schema:
port: "int(1025,65535)?"
databases: "int(1,16)?"
password: "str?"
appendonly: "bool?"
options:
port: 6379
databases: 4
appendonly: true
image: "r.hassbus.com/wghaos/redis-server"

BIN
redis-server/icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 482 B

BIN
redis-server/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB