luechtdiode/kutuapp

kutuapp-server Docker镜像文档

镜像概述

本镜像用于在容器环境中部署kutuapp-server，提供了灵活的配置方式，支持数据库连接和邮件发送功能，适用于开发、测试及生产环境的容器化部署需求。

核心功能与特性

• 容器化部署：简化kutuapp-server在容器环境中的部署流程
• 数据库支持：默认支持PostgreSQL和SQLite，可通过配置扩展至其他数据库（遵循Scala Slick 3.1规范）
• 灵活配置：支持通过环境变量或自定义配置文件进行参数配置
• 邮件功能：提供SMTP配置选项，支持密码重置等邮件发送需求
• 数据持久化：默认需挂载可写卷以实现数据持久化

使用场景

• 容器化环境中快速部署kutuapp-server应用
• 需要PostgreSQL数据库连接的生产环境部署
• 本地开发/测试环境（可使用SQLite）
• 需要邮件通知功能（如密码重置、用户注册验证）的应用场景

使用方法与配置说明

基本要求

默认需将可写卷（具备读写权限）挂载至容器内/home/kutuapp路径，用于数据持久化。

环境变量配置

1. 数据库连接配置

默认配置文件（未替换/kutuapp/kutuapp.conf）

当未通过镜像层替换默认配置文件时，支持以下环境变量：

自定义配置文件（替换/kutuapp/kutuapp.conf）

若通过镜像层替换配置文件，需注意：

• 连接配置名称可自定义，但需遵循Scala Slick 3.1连接配置规范
• 如使用HikariCP、PostgreSQL、SQLite以外的数据库驱动，需将对应JAR文件添加至ENTRYPOINT启动命令的类路径中

2. 邮件发送配置

启用邮件功能（如密码重置）需配置以下SMTP相关环境变量：

2. 自定义配置文件规范

若替换/kutuapp/kutuapp.conf，配置文件需遵循Scala Slick 3.1数据库连接规范，格式示例：

hocon
db {
  <配置名称> {
    driver = "slick.jdbc.PostgresProfile$"
    db {
      url = "jdbc:postgresql://${X_POSTGRES_HOST}/kutuapp"
      user = ${X_POSTGRES_USER}
      password = ${X_POSTGRES_PASSWORD}
      driver = org.postgresql.Driver
    }
  }
}

部署示例

Docker Run 命令示例（PostgreSQL配置）

bash
docker run -d \
  --name kutuapp-server \
  -v /宿主机路径/kutuapp-data:/home/kutuapp \
  -e X_DB_CONFIG_NAME=kutudb_pg \
  -e X_POSTGRES_HOST=postgres-host:5432 \
  -e X_POSTGRES_USER=kutuapp_admin \
  -e X_POSTGRES_PASSWORD=SecurePass123! \
  -e X_SMTP_HOST=smtp.example.com \
  -e X_SMTP_PORT=587 \
  -e X_SMTP_USERNAME=notifications@example.com \
  -e X_SMTP_DOMAIN=example.com \
  -e X_SMTP_PASSWORD=SMTPpass456! \
  kutuapp-server:latest

Docker Compose 配置示例

yaml
version: '3.8'

services:
  kutuapp-server:
    image: kutuapp-server:latest
    volumes:
      - kutuapp-data:/home/kutuapp
    environment:
      - X_DB_CONFIG_NAME=kutudb_pg
      - X_POSTGRES_HOST=postgres:5432
      - X_POSTGRES_USER=kutuapp_admin
      - X_POSTGRES_PASSWORD=SecurePass123!
      - X_SMTP_HOST=smtp.example.com
      - X_SMTP_PORT=587
      - X_SMTP_USERNAME=notifications@example.com
      - X_SMTP_DOMAIN=example.com
      - X_SMTP_PASSWORD=SMTPpass456!
    depends_on:
      - postgres

  postgres:
    image: postgres:14
    environment:
      - POSTGRES_DB=kutuapp
      - POSTGRES_USER=kutuapp_admin
      - POSTGRES_PASSWORD=SecurePass123!
    volumes:
      - postgres-data:/var/lib/postgresql/data
    command: postgres -c "search_path=kutu,public"

volumes:
  kutuapp-data:
  postgres-data:

注意事项

• 卷权限：确保挂载至/home/kutuapp的卷具有读写权限，否则可能导致数据持久化失败
• 数据库准备：PostgreSQL环境需预先创建kutu schema，且数据库用户需拥有该schema的表结构修改权限
• 自定义驱动：使用非默认数据库驱动时，需将对应JAR文件添加至容器类路径（可通过修改ENTRYPOINT实现）
• 配置优先级：自定义配置文件优先级高于环境变量，替换kutuapp.conf后需确保配置名称与X_DB_CONFIG_NAME匹配

更多详情请参考https://github.com/luechtdiode/KuTu