mhubig/partkeepr

mhubig/partkeepr Docker镜像文档

镜像概述和主要用途

本仓库是mhubig/partkeepr Docker镜像的可信构建源。PartKeepr是一款零件管理系统，可帮助用户跟踪和管理电子元件、机械零件等库存。该镜像集成预配置的MariaDB数据库容器，简化了PartKeepr的部署流程，无需复杂的手动配置。

最新版本：1.4.0-20

核心功能和特性

• 集成数据库：包含预配置的MariaDB容器，无需单独部署数据库服务
• 环境变量配置：支持通过PARTKEEPR_*前缀的环境变量自定义系统参数
• 快速部署：通过docker-compose实现一键启动，降低部署门槛
• 灵活扩展：支持手动构建镜像和自定义运行参数

使用场景和适用范围

适用于需要管理零件库存的个人用户、电子爱好者、小型企业或实验室，尤其适合希望快速部署零件管理系统而无需深入配置数据库和服务器的场景。

使用方法和配置说明

前提条件

需安装Docker环境。

快速部署步骤

1. 克隆仓库：

   shell
   git clone https://github.com/mhubig/docker-partkeepr.git
   cd docker-partkeepr
   

2. 设置可选环境变量（如Octopart API密钥）：

   shell
   export PARTKEEPR_OCTOPART_APIKEY=0123456  # 可从https://octopart.com获取
   

3. 启动容器：

   shell
   docker-compose up  # 添加-d参数以后台模式运行
   

   此命令将启动PartKeepr应用容器和关联的MariaDB数据库容器。

完成系统设置

1. 访问PartKeepr设置页面（例如：http://localhost:8080/setup），按照页面指引完成配置。

2. 获取自动生成的认证密钥：

   shell
   docker-compose exec partkeepr cat app/authkey.php
   

默认数据库参数

• 数据库主机：mariadb
• 数据库名称：partkeepr
• 数据库用户：partkeepr
• 数据库密码：partkeepr

手动构建和运行镜像

如需自定义构建镜像：

shell
docker build -t mhubig/partkeepr:latest --rm .

运行手动构建的镜像：

shell
docker run -d -p 8080:80 --name partkeepr mhubig/partkeepr

环境变量配置

所有支持的PARTKEEPR_*环境变量可参考https://github.com/mhubig/docker-partkeepr/blob/master/mkparameters#L15%EF%BC%88%E4%BB%8E%E7%AC%AC15%E8%A1%8C%E5%BC%80%E5%A7%8B%EF%BC%89%E3%80%82

版本发布流程

采用https://guides.github.com/introduction/flow/%E5%B7%A5%E4%BD%9C%E6%B5%81%EF%BC%8C%E5%8F%91%E5%B8%83%E6%AD%A5%E9%AA%A4%E5%A6%82%E4%B8%8B%EF%BC%9A

1. 在master分支更新版本号：

   shell
   ./bump-version.sh 1.4.0-20  # 替换为目标版本号
   

2. 推送代码和标签：

   shell
   git push && git push --tags
   

Docker镜像CI/CD管道

本仓库连接至Docker Hub构建管道，每次推送标签时自动构建新镜像。镜像标签包含版本号（如1.4.0-20）和latest。

参考链接：

• https://hub.docker.com/r/mhubig/partkeepr/
• PartKeepr官网
• https://guides.github.com/introduction/flow/