qmkfm/redis

QMK Redis Container

镜像概述

QMK Redis Container 是专为 QMK API 量身定制的 Redis 数据库容器。该镜像包含了运行 QMK Redis 实例所需的 Dockerfile 及相关配置，旨在为 QMK 生态系统提供高性能、低延迟的键值数据存储和缓存服务。

核心功能和特性

• 专为 QMK 优化：针对 QMK API 的数据访问模式与业务需求进行了底层配置优化。
• 自定义配置支持：采用自定义 redis.conf 配置文件加载方式，允许开发者灵活调整 Redis 运行参数。
• 轻量高效：基于精简的 Redis 基础镜像构建，资源占用低，启动速度快。
• 数据持久化：支持 RDB 和 AOF 持久化机制，确保 QMK 配置和状态数据的安全性。

使用场景和适用范围

• 作为 QMK API 的后端缓存层，加速键盘配置、键映射等数据的读取。
• 用于 QMK 编译服务中的任务队列和状态管理。
• 适用于需要与 QMK 官方 API 架构保持一致的本地开发、测试或私有化部署环境。

使用方法和配置说明

自定义配置文件

本镜像支持通过挂载自定义的 redis.conf 文件来覆盖默认配置。请确保您的配置文件中包含适合 QMK API 运行的参数（如内存限制、持久化策略等）。

Docker 部署示例

使用 docker run 部署

bash
docker run -d \
  --name qmk-redis \
  -p 6379:6379 \
  -v /path/to/your/redis.conf:/usr/local/etc/redis/redis.conf \
  -v qmk-redis-data:/data \
  qmkfm/qmk_redis redis-server /usr/local/etc/redis/redis.conf

使用 docker-compose 部署

创建 docker-compose.yml 文件：

yaml
version: '3.8'

services:
  qmk-redis:
    image: qmkfm/qmk_redis:latest
    container_name: qmk-redis
    ports:
      - "6379:6379"
    volumes:
      - ./redis.conf:/usr/local/etc/redis/redis.conf
      - redis-data:/data
    command: redis-server /usr/local/etc/redis/redis.conf
    restart: unless-stopped

volumes:
  redis-data:

环境变量与配置参数

本镜像主要依赖 redis.conf 进行配置，建议在配置文件中调整以下关键参数以适配 QMK 业务：

• maxmemory：限制 Redis 使用的最大内存，防止内存溢出。
• maxmemory-policy：内存淘汰策略（建议 QMK 缓存场景使用 allkeys-lru 或 volatile-lru）。
• appendonly：是否开启 AOF 持久化（生产环境建议设为 yes）。
• requirepass：设置访问密码以增强数据安全性。

注意事项

• 确保挂载的 redis.conf 文件权限正确，容器内的进程能够正常读取该文件。
• 在生产环境中，请务必配置 requirepass 并通过防火墙或 Docker 网络限制 6379 端口的公网访问。