dandevaud/menuplanner

MenuPlanner 应用 Docker 镜像

概述

MenuPlanner 应用 Docker 镜像是用于部署菜单规划工具的容器化解决方案，需通过配置文件设置数据库连接参数以实现数据存储和认证功能。

核心功能与特性

• 支持多种数据库类型：MariaDB、MySQL（未测试）和 SQLite
• 通过配置文件分离数据存储和认证相关的数据库连接配置
• 支持环境特定配置（通过settings.$ENVIRONMENT.json文件）

使用场景与适用范围

适用于需要快速部署菜单规划工具的个人或小型团队，通过容器化部署简化环境配置，支持不同数据库环境需求。

使用方法与配置说明

配置文件要求

1. 创建配置文件，支持两种命名格式：

   • settings.json（默认通用配置）
   • settings.$ENVIRONMENT.json（环境特定配置，其中$ENVIRONMENT为环境标识）

2. 配置文件需放置在容器内/app/config/目录下，结构示例：

   json
   {
     "Data": {
       "Type": "MariaDB",  // 数据库类型（支持MariaDB/MySQL/SQLite）
       "ServerVersion": "10.5",  // 数据库服务器版本
       "Server": "192.168.1.100",  // 数据库服务器IP地址
       "Database": "menuplanner_data",  // 数据库名称
       "Port": 3306,  // 数据库端口
       "User": "dbuser",  // 数据库用户名
       "Password": "dbpass"  // 数据库密码
     },
     "Auth": {
       "Type": "MariaDB",  // 认证数据库类型
       "ServerVersion": "10.5",  // 认证数据库服务器版本
       "Server": "192.168.1.100",  // 认证数据库服务器IP地址
       "Database": "menuplanner_auth",  // 认证数据库名称
       "Port": 3306,  // 认证数据库端口
       "User": "authuser",  // 认证数据库用户名
       "Password": "authpass"  // 认证数据库密码
     }
   }
   

配置参数说明

Data 节点（数据存储配置）

Auth 节点（认证配置）

同Data节点参数说明，用于配置认证相关的数据库连接。

部署示例

基础部署（使用默认配置文件）

bash
docker run -d \
  -v /本地配置目录:/app/config \
  --name menuplanner \
  menuplanner-image:latest

注：/本地配置目录需包含settings.json文件

环境特定部署

bash
docker run -d \
  -v /本地配置目录:/app/config \
  -e ENVIRONMENT=prod \
  --name menuplanner \
  menuplanner-image:latest

此时容器将读取/app/config/settings.prod.json作为配置文件

数据库类型支持说明

• 已支持：MariaDB、SQLite
• 未测试：MySQL（可能存在兼容性问题）