ketzu/budget

Rough-Budget

镜像概述和主要用途

Rough-Budget 是一个简单的预算管理工具，核心功能是跟踪常规支出，估算每月（或其他时间单位）的可用资金。它支持记录支出和收入，提供消费概览图表及支出类别的平均消费习惯分析。隐私保护是其核心设计理念，无需账户即可使用，不跟踪用户数据；账户功能仅用于多设备共享，所有数据通过密码派生的密钥加密存储，确保数据安全。

核心功能和特性

• 隐私优先：无需账户即可使用，不跟踪用户（除正常Web服务器日志外）。账户功能中，密码会派生两个密钥：加密密钥（用于加密所有发送到服务器的数据）和认证密钥（用于验证数据读写权限），数据库仅存储加密数据和哈希后的认证密钥，即使数据库泄露，***者也无法获取实际数据或访问权限。
• 基础预算跟踪：记录支出和收入，提供消费概览图表及各支出类别的平均消费分析。
• 多设备共享：通过账户功能实现数据在多设备间的安全共享。

使用场景和适用范围

适用于需要简单、隐私优先的预算管理工具的用户，尤其是希望本地部署或通过Docker容器运行，避免将财务数据交给第三方的个人用户。

使用方法和配置说明

Docker镜像信息

• 镜像名称：ketzu/budget
• 镜像来源：https://hub.docker.com/r/ketzu/budget

环境变量要求

运行容器需设置以下4个环境变量（用于连接数据库）：

• DB_SERVER：数据库服务器地址
• DB_NAME：数据库名称
• DB_USER：数据库用户名
• DB_PASSWORD：数据库密码

Docker Compose部署示例

以下是使用Docker Compose的部署配置示例，需配合MySQL容器使用：

yaml
version: '3'
services:
  budget:
    image: ketzu/budget
    restart: always
    hostname: budget.ketzu.net
    env_file:
      - ~/secrets/budget.env  # 包含数据库凭证的环境文件路径
    networks:
      web:
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.budget.rule=Host(`budget.ketzu.net`)"
      - "traefik.http.routers.budget.entryPoints=websecure"
      - "traefik.http.routers.budget.tls=true"
      - "traefik.http.routers.budget.tls.certresolver=le"

networks:
  web:
    external: true  # 外部网络，需预先创建

环境文件配置

环境文件（如示例中的~/secrets/budget.env）需包含数据库访问凭证：

DB_SERVER=mysql  # MySQL容器名称（需与数据库容器名称一致）
DB_NAME=budget   # 数据库名称（需预先在MySQL中创建）
DB_USER=budget   # 数据库用户名
DB_PASSWORD=your_secure_password  # 数据库密码（替换为实际安全密码）

部署说明

1. 需准备一个名为mysql的数据库容器，该容器需：
   • 配置与环境文件中一致的数据库名称（budget）
   • 创建对应用户名（budget）及密码
2. 确保web网络已存在（示例中为外部网络，通过docker network create web创建）

发布信息

Rough-Budget 作为Web项目发布于 [***]

项目开发使用

Rough-Budget 是基于npm的Vue项目，本地开发测试步骤：

1. 安装依赖：npm install
2. 启动热重载开发服务器：npm run serve
3. 构建部署版本：npm run build

许可证

Rough-Budget 采用MIT许可证，详情见 许可证文件。

支持

欢迎通过 *** 支持项目开发。