Homebox项目配置指南：环境变量与参数详解

项目概述

Homebox是一款面向个人和家庭的资产管理系统，帮助用户高效管理各类物品。本文将全面解析Homebox的配置选项，包括环境变量和命令行参数，帮助用户根据实际需求进行定制化部署。

核心配置参数

基础运行配置

• HBOX_MODE：设置运行模式，可选development开发模式或production生产模式，默认生产模式
• HBOX_WEB_PORT：Web服务端口，默认7745
• HBOX_WEB_HOST：Web服务绑定主机地址

功能开关

• HBOX_OPTIONS_ALLOW_REGISTRATION：是否允许用户自助注册，默认开启
• HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID：资产ID是否自动递增，默认开启
• HBOX_OPTIONS_ALLOW_ANALYTICS：是否允许发送匿名统计信息，默认关闭

存储配置

• HBOX_STORAGE_CONN_STRING：数据存储路径，默认file://./
• HBOX_STORAGE_PREFIX_PATH：存储前缀路径，默认.data

数据库配置

Homebox支持两种数据库类型：

SQLite配置

• HBOX_DATABASE_DRIVER：设为sqlite3
• HBOX_DATABASE_SQLITE_PATH：SQLite数据库文件路径

PostgreSQL配置

• HBOX_DATABASE_HOST：数据库主机地址
• HBOX_DATABASE_PORT：数据库端口
• HBOX_DATABASE_USERNAME：数据库用户名
• HBOX_DATABASE_PASSWORD：数据库密码
• HBOX_DATABASE_DATABASE：数据库名称
• HBOX_DATABASE_SSL_MODE：SSL连接模式

邮件服务

• HBOX_MAILER_HOST：SMTP服务器地址
• HBOX_MAILER_PORT：SMTP端口，默认587
• HBOX_MAILER_USERNAME：SMTP用户名
• HBOX_MAILER_PASSWORD：SMTP密码
• HBOX_MAILER_FROM：发件人地址

标签打印功能

• HBOX_LABEL_MAKER_WIDTH：标签宽度(像素)，默认526
• HBOX_LABEL_MAKER_HEIGHT：标签高度(像素)，默认200
• HBOX_LABEL_MAKER_PRINT_COMMAND：标签打印命令，留空则禁用打印功能
• HBOX_LABEL_MAKER_DYNAMIC_LENGTH：是否启用动态长度标签，默认开启

安全配置建议

PostgreSQL安全实践

1. 避免使用默认的postgres用户和数据库
2. 使用强密码策略
3. 强制启用SSL加密连接
4. 考虑使用连接池工具如pgbouncer

SQLite安全实践

1. 设置严格的数据库文件权限(chmod 600)
2. 将数据库文件存放在安全目录
3. 实施可靠的备份策略
4. 大型部署考虑使用PostgreSQL替代

命令行参数使用

Homebox提供了丰富的命令行参数，与对应的环境变量功能相同。可通过以下命令查看帮助信息：

homebox --help

主要参数包括：

• --mode：设置运行模式
• --web-port：指定Web服务端口
• --database-driver：选择数据库类型
• --database-host：设置数据库主机地址
• --mailer-host：配置邮件服务器

最佳实践建议

1. 生产环境配置：

   • 使用production模式运行
   • 关闭用户自助注册功能
   • 启用数据库SSL加密
   • 设置合理的日志级别(info或warn)

2. 性能调优：

   • 根据硬件配置调整HTTP超时参数
   • 大型部署推荐使用PostgreSQL
   • 监控数据库文件大小

3. 标签打印优化：

   • 根据实际打印机调整标签尺寸参数
   • 测试动态长度标签效果
   • 配置合适的打印命令

通过合理配置这些参数，您可以根据实际需求优化Homebox的性能、安全性和可用性，打造最适合您使用场景的资产管理系统。