xdbin/beancount-gs

beancount-gs

!license

演示地址 使用文档

镜像概述

https://github.com/beancount/ 是一款优秀的开源复式记账工具，因其基于文本记录的特性，难以拓展至移动端。本镜像旨在通过Golang将常见的记账行为封装为RESTful API，利用bean-query获取并解析内容，以JSON格式返回结果，并内置适配移动端的前端页面。

核心功能与特性

• 私有部署
• 多账本管理
• 账户及资产管理
• 统计图表展示
• 多币种支持
• 标签管理
• ***管理（FIFO模式）
• 第三方账单导入（***、微信、工商银行、农业银行）
• 分期记账功能
• 事件管理（待实现）

使用场景

适用于需要私有部署个人/家庭记账系统、希望通过移动端访问beancount账本、需管理多账本和多币种资产、需要导入第三方支付/银行账单、进行***管理及分期记账的用户。

使用方法与配置说明

本地打包运行

1. 克隆项目至本地
2. 在根目录执行 go build 编译
3. 运行可执行文件 ./beancount-gs（-p 参数指定端口号，-secret 参数指定配置密钥）

基于Release包运行

1. 下载并解压项目的Release包
2. 执行根目录下的 ./beancount-gs.exe（Windows系统）或 ./beancount-gs（Linux/Mac系统）

Docker部署

shell
docker run --name beancount-gs -dp 10000:80 \
-w /app \
-v "/data/beancount:/data/beancount" \
-v "/data/beancount/icons:/app/public/icons" \
-v "/data/beancount/config:/app/config" \
-v "/data/beancount/bak:/app/bak" \
xdbin/beancount-gs:latest

参数说明：

• -d：后台运行容器
• -p 10000:80：将容器内80端口映射至主机***端口
• -w /app：设置工作目录为/app
• -v：挂载目录，分别对应：
  • 账本数据目录：/data/beancount
  • 图标目录：/data/beancount/icons
  • 配置目录：/data/beancount/config
  • 备份目录：/data/beancount/bak

Docker Compose部署

1. 在指定目录创建 docker-compose.yml 文件，内容如下：

yaml
version: "3.9"
services:
  app:
    container_name: beancount-gs
    image: xdbin/beancount-gs:${tag:-latest}
    ports:
      - "10000:80"
    # 挂载目录后重新拷贝默认图标
    command: >
      sh -c "cp -rn /app/public/default_icons/* /app/public/icons && ./beancount-gs -p 80"
    volumes:
      - "${dataPath:-/data/beancount}:/data/beancount"
      - "${dataPath:-/data/beancount}/icons:/app/public/icons"
      - "${dataPath:-/data/beancount}/config:/app/config"
      - "${dataPath:-/data/beancount}/bak:/app/bak"
      - "${dataPath:-/data/beancount}/logs:/app/logs"

2. （可选）创建 var.env 文件自定义路径和版本：

properties
tag=latest  # 指定镜像版本，默认为latest
dataPath=/自定义目录  # 指定数据存储路径，默认为/data/beancount

3. 执行部署命令：
   • 默认配置：docker-compose up -d
   • 使用自定义配置：docker-compose --env-file ./var.env up -d

项目负责人

https://github.com/BaoXuebin

开源协议

https://github.com/BaoXuebin/beancount-gs/blob/main/License @BaoXuebin

感谢

感谢JetBrains提供的开源开发许可证支持。