项目介绍
HomeLedger 将家庭账户、收支和票据集中保存,AI 识别用于辅助录入,最终账目仍应人工确认。没有模型服务时,可先建立手工记账流程。
它面向家庭共同记账,把日常交易、不同账户、票据与订阅扣费放在同一套记录里。账目可以从手工录入开始,逐步加入截图识别或外部接口,避免一开始就依赖模型生成所有记录。
家庭账本需要先统一统计口径:转账与消费不同,资产变动也不一定属于收入。先建立账户与分类,再测试导入、识别和报表,能减少月底看到重复支出或金额对不上的情况。
核心功能
| 功能 | 作用与使用方式 |
|---|---|
| 账户与收支 | 按现金、银行卡等账户记录交易,核对收入和支出。 |
| 票据关联 | 把原始截图或单据与记录放在一起,便于复查。 |
| AI 辅助录入 | 从文字或图片提取候选字段,入账前确认金额与分类。 |
| 订阅管理 | 整理周期扣费、到期提醒和暂停状态。 |
| 家庭协作 | 按账本与成员权限共同记录,并分别查看统计。 |
功能示意

图 1:自制功能示意图,概括本文的使用要点。
项目信息
| 项目 | 说明 |
|---|---|
| 类型 | 项目指南 |
| 分类 | 知识与效率 |
| 项目仓库 | sucraft-hub/homeledger |
| 整理日期 | 2026-11-14 |
群晖 Compose 安装
1. 创建项目目录
群晖先安装并启动 Container Manager。通过 SSH 登录后执行下列命令,只为本项目准备目录:
sudo -i
mkdir -p /volume1/docker/homeledger /volume1/docker/homeledger/data
cd /volume1/docker/homeledger
if [ ! -s .env ]; then
umask 077
{
printf 'SESSION_SECRET=%s\n' "$(openssl rand -hex 32)"
printf 'ADMIN_PASSWORD=%s\n' "$(openssl rand -hex 24)"
} > .env.initializing
mv .env.initializing .env
fi
chmod 600 .env
cat .env
.env 中的密码和密钥由命令随机生成,已有文件不会覆盖。可以在自己的终端用 cat .env 查看初始密码,但不要将输出公开。将其保存在自己的密码管理器中;更新时继续使用原值,不要重新生成导致旧数据无法解密。
2. 保存完整 Compose
在 /volume1/docker/homeledger/compose.yaml 保存下面的配置。在 Container Manager 中新建项目时,项目路径选择 /volume1/docker/homeledger 并导入该文件;有 .env 的项目要保留它与 Compose 在同一目录。
services:
homeledger:
image: ghcr.io/sucraft-hub/homeledger:latest
container_name: homeledger
restart: unless-stopped
ports:
- 5111:5111
volumes:
- /volume1/docker/homeledger/data:/data
environment:
TZ: Asia/Shanghai
ADMIN_USER: admin
ALLOW_REGISTER: 'false'
SESSION_SECRET: ${SESSION_SECRET}
ADMIN_PASSWORD: ${ADMIN_PASSWORD}
挂载参数冒号左侧是群晖的实际目录,右侧是应用内目录。以上只挂载本项目所需的数据;若已有同类数据,请先备份再调整路径。端口冲突时只改宿主机一侧,应用内端口保持不变。
3. 检查、拉取与启动
cd /volume1/docker/homeledger
docker compose config --quiet
docker compose pull
docker compose up -d
docker compose ps
docker compose logs --tail=100
浏览器访问 http://群晖IP:5111。群晖IP 替换为自己的 NAS 局域网地址;首次启动时先等待初始化,再检查日志。若群晖仍使用旧 Docker 套件且只有 docker-compose,将命令中的 docker compose 替换为对应命令。
首次使用与验证
用账号 admin 与生成的管理员密码登录,创建家庭账本、收支分类和成员。先记一笔测试支出并上传一张虚拟票据,再检查统计日期与时区。AI/OCR 服务地址和密钥可在网页设置中单独配置。
先保存一条测试数据或完成一次最小任务,再执行 docker compose restart,确认设置及应该持久化的数据仍在。无服务端持久化目录的纯前端工具,应通过自身导出功能保存工作结果。
常见问题
- 页面打不开:运行
docker compose ps检查状态;查看日志里的初始化错误,核对端口冲突和 DSM 防火墙。不要把容器的 IP 当作固定访问地址。 - 数据目录为空:应用内应填写 Compose 冒号右侧的目录;核对宿主机文件是否已放到对应左侧目录。
- 目录无法写入:先查看日志和目录权限,仅为对应数据目录授予镜像实际运行用户需要的权限,不对整个
/volume1设置 777。 - 拉取镜像失败:先排查 Container Manager 的仓库网络;应用自己的 HTTP 代理设置与 Docker 守护进程拉取镜像的代理设置是两件事。
更新、备份与停止
更新前保存 compose.yaml、.env,并备份上面映射的项目数据。数据库服务应先使用自身的数据库备份,或停止整个项目后复制完整数据目录,不能只复制运行中的单个数据库文件。
cd /volume1/docker/homeledger
docker compose pull
docker compose up -d
docker compose logs --tail=100
临时停止使用 docker compose stop,重新启动使用 docker compose start。卸载容器用 docker compose down,不要附加 -v,也不要直接删除宿主机数据目录。涉及数据库迁移的升级,先保留原镜像版本和完整备份,再安排维护窗口。