karaokestu/openkj

OpenKJ独立请求服务器

镜像概述和主要用途

该镜像为OpenKJ提供独立的基础单场地请求服务器实现，用于处理Karaoke场地的请求管理功能，是OpenKJ系统的配套服务组件。

核心功能和特性

• 端口配置：默认运行在80端口，需通过Docker暴露或使用前端代理（如Traefik、Caddy、nginx）
• API密钥处理：忽略OpenKJ中指定的任何API密钥配置
• URL配置：需在OpenKJ中设置服务器URL为https://your.web.server/api.php（替换为实际服务器地址）
• 数据持久化：通过卷挂载/var/www目录实现数据库持久化存储

使用场景和适用范围

适用于单一Karaoke场地环境，配合OpenKJ系统使用，提供基础的请求管理功能，适合小型场地或个人使用场景。

使用方法和配置说明

基本部署（Docker Run）

bash
docker run -d \
  -p 80:80 \
  -v /path/to/local/data:/var/www \
  --name openkj-request-server \
  docker.xuanyuan.run/openkj/standalone-request-server

配置参数说明

• 端口映射：-p 80:80 将容器80端口映射到主机80端口，如需使用其他端口可修改主机端口部分（如-p 8080:80）
• 卷挂载：-v /path/to/local/data:/var/www 挂载主机目录到容器/var/www，用于持久化数据库文件，确保数据不丢失
• 容器命名：--name openkj-request-server 指定容器名称，便于管理

OpenKJ配置步骤

1. 启动容器并确保服务可访问
2. 打开OpenKJ应用程序
3. 进入系统设置，找到"请求服务器"配置项
4. 设置服务器URL为 https://your.web.server/api.php（替换your.web.server为实际服务器域名或IP）
5. 保存配置并测试连接

反向代理配置（推荐）

为确保HTTPS访问（URL要求），建议使用反向代理，以下是nginx配置示例：

nginx
server {
    listen 443 ssl;
    server_name your.web.server;

    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;

    location /api.php {
        proxy_pass http://localhost:80;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

注意事项

• 必须挂载/var/www卷以防止容器重启后数据丢失
• 服务器URL必须使用HTTPS协议，需配置SSL证书（可通过反向代理实现）
• 无需在OpenKJ中配置API密钥，服务器将忽略该设置