msupplyfoundation/omsupply

Open mSupply Docker镜像文档

镜像概述和主要用途

Open mSupply 是一个开源的药品分销物流管理系统，旨在提供高效的药品分发物流管理功能。该Docker镜像封装了Open mSupply应用，便于快速部署和使用，支持生产环境运行、数据库配置、开发环境搭建等多种场景。

• 官方文档
• mSupply基金会
• https://github.com/msupply-foundation/open-msupply

核心功能和特性

• 多版本支持：提供base（生产环境）和dev（开发环境，含前端依赖）两种镜像版本
• 数据库灵活性：支持初始化数据库、加载参考数据及挂载SQLite文件
• CLI工具：内置命令行工具，支持导出GraphQL schema等操作
• 日期模拟：可刷新日期或设置伪时间，适用于测试和演示
• 配置可定制：通过环境变量覆盖配置文件中的所有设置

使用场景和适用范围

• 药品分销机构的物流管理系统部署
• 开发人员进行Open mSupply二次开发
• 测试环境快速搭建和功能验证
• 演示环境的数据模拟和展示

详细使用方法和配置说明

镜像版本说明

• base版本：基础镜像，适用于生产环境部署，不包含开发依赖
• dev版本：开发镜像，带有-dev前缀，包含前端开发所需依赖，便于前端代码修改和调试

基本部署

bash
docker run -p 9000:8000 msupplyfoundation/omsupply:v2.7.3

注意：

• -p参数第一个值为本地端口，用于访问Open mSupply服务
• M芯片Mac用户首次运行需添加--platform linux/amd64，或使用-arm64标签（若有）

数据库配置

初始化数据库

可通过以下方式初始化数据库：

• 同步到mSupply服务器（本地服务器需使用host.docker.internal而非localhost）
• 加载内置参考数据（默认凭据：Admin/pass）：

bash
docker run -e LOAD_REFERENCE_FILE=reference1 -p 9000:8000 msupplyfoundation/omsupply:v2.7.3

挂载SQLite文件

将本地SQLite数据库文件挂载到容器/database目录（默认数据库名称omsupply-database）：

bash
# 本地mydatabase文件夹包含omsupply-database.sqlite文件
docker run -v "$(pwd)/mydatabase":/database -p 9000:8000 msupplyfoundation/omsupply:v2.7.3

运行CLI命令

通过镜像运行内置CLI命令，例如导出GraphQL schema：

bash
docker run --rm -v "$(pwd)/putschemahere":/schemafolder msupplyfoundation/omsupply:v2.7.3 export-graphql-schema -p /schemafolder/schema.graphql

使用--help查看所有可用命令：

bash
docker run --rm msupplyfoundation/omsupply:v2.7.3 --help

日期模拟配置

刷新日期

基于数据库最新日期向前推进所有日期（适用于测试数据更新）：

bash
docker run -e LOAD_REFERENCE_FILE=reference1 -e SHOULD_REFRESH_DATES=true -p 9000:8000 msupplyfoundation/omsupply:v2.7.3

设置伪时间

将服务器时间固定为特定日期（前端创建的日期可能不受影响）：

bash
docker run -e LOAD_REFERENCE_FILE=reference1 -e FAKETIME="@2023-05-20 11:30:00" -p 9000:8000 msupplyfoundation/omsupply:v2.7.3

开发环境配置

使用dev版本镜像搭建前端开发环境：

1. 复制前端开发文件

bash
docker run --rm -v "$(pwd)/clientdev":/usr/src/omsupply/clientcopy -ti --entrypoint="/bin/bash" -w /usr/src/omsupply/ msupplyfoundation/omsupply:v2.7.3-dev -c "rsync -av --exclude='/node_modules' client/ clientdev/"

2. 启动前端服务

bash
docker run -p 9003:3003 -v "$(pwd)/clientdev":/usr/src/omsupply/client -v /usr/src/omsupply/client/node_modules -ti --entrypoint="/bin/bash" -w /usr/src/omsupply/client msupplyfoundation/omsupply:v2.7.3-dev -c "yarn start --env API_HOST='http://localhost:9000'"

3. 启动后端服务

bash
docker run -p 9000:8000 msupplyfoundation/omsupply:v2.7.3

修改clientdev/client目录下的文件后，刷新页面即可查看更改（热重载可能不稳定）

高级配置

通过环境变量覆盖配置文件中的所有设置（配置文件参见https://github.com/msupply-foundation/open-msupply/blob/main/server/configuration/example.yaml%EF%BC%89%E3%80%82%E4%BE%8B%E5%A6%82%E4%BF%AE%E6%94%B9%E6%95%B0%E6%8D%AE%E5%BA%93%E5%90%8D%E7%A7%B0%EF%BC%9A

bash
docker run -e APP_DATABASE__DATABASE_NAME="/database/custom-name" -p 9000:8000 msupplyfoundation/omsupply:v2.7.3