yegle/fava

fava-docker 镜像文档

镜像概述和主要用途

fava-docker 是一个用于运行 beancount-fava 的 Docker 镜像。beancount-fava 是复式记账工具 Beancount 的 Web 界面，提供直观的记账数据管理、报表展示和交易分析功能。本镜像旨在简化 fava 的部署流程，通过容器化方式消除环境依赖，方便用户快速启动和使用 fava。

核心功能和特性

• 容器化部署：无需本地安装 Python 及 fava 依赖，通过 Docker 容器一键运行
• 灵活配置：支持通过环境变量指定 Beancount 记账文件路径
• 即开即用：启动后自动暴露 Web 服务，可通过浏览器直接访问 fava 界面

使用场景和适用范围

• 个人/企业记账管理：使用 Beancount 进行复式记账，需通过 Web 界面查看和管理数据的用户
• 快速环境搭建：避免本地配置 Python 环境及依赖冲突，适合临时或多环境部署
• 轻量级服务部署：个人服务器或开发环境中快速部署 fava 服务

详细使用方法和配置说明

前置条件

• 已安装 Docker 环境
• 准备好 Beancount 记账文件（如 example.bean）

核心配置参数

仅支持通过环境变量配置，具体如下：

Docker 命令部署示例

基础运行命令

将本地 Beancount 文件挂载到容器内，并通过环境变量指定文件路径：

bash
# 假设当前目录下有待加载的 Beancount 文件（如 example.bean）
docker run -v $PWD:/bean -e BEANCOUNT_FILE=/bean/example.bean -p 5000:5000 yegle/fava

参数说明：

• -v $PWD:/bean：将主机当前目录（$PWD）挂载到容器内的 /bean 目录，使容器可访问主机上的 Beancount 文件
• -e BEANCOUNT_FILE=/bean/example.bean：设置环境变量，指定容器内待加载的 Beancount 文件路径（需与挂载路径对应）
• -p 5000:5000：将容器内 fava 默认端口（5000）映射到主机 5000 端口，允许外部访问

Docker Compose 部署示例

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3'
services:
  fava:
    image: yegle/fava
    volumes:
      - ./:/bean  # 挂载主机当前目录到容器内 /bean 目录（替换为实际 Beancount 文件所在路径）
    environment:
      - BEANCOUNT_FILE=/bean/example.bean  # 容器内 Beancount 文件路径（需与挂载路径对应）
    ports:
      - "5000:5000"  # 映射主机端口 5000 到容器端口 5000
    restart: unless-stopped  # 服务异常退出后自动重启

启动命令：

bash
docker-compose up -d  # 后台启动服务

访问方式

服务启动后，通过浏览器访问 http://<主机IP>:5000 即可打开 fava Web 界面（若本地部署，直接访问 http://localhost:5000）。

注意：若未显式映射端口（如未添加 -p 参数），需通过 docker inspect <容器ID> 获取容器 IP，再访问 http://<容器IP>:5000。