Kresus Docker镜像文档

1. 镜像概述和主要用途

Kresus 是一款开源的个人财务管理解决方案，旨在帮助用户轻松跟踪收支情况，通过直观的数据分析获取资金使用洞察。作为自托管应用，它允许用户完全掌控财务数据，适用于需要本地化数据管理和隐私保护的场景。

2. 核心功能和特性

2.1 核心功能

• 开源与自托管：基于开源协议分发，支持本地部署，数据存储在用户自有服务器，保障隐私安全。
• 收支跟踪：自动或手动记录收入与支出，支持多账户整合管理。
• 分类与标签：自定义收支分类规则，通过标签对交易进行精细化管理。
• 财务报表：生成支出趋势、分类占比等可视化报表，辅助财务决策。

2.2 关键特性

• 轻量部署：基于Docker容器化，部署流程简化，支持跨平台运行。
• 数据本地化：财务数据存储在用户控制的环境中，无需依赖第三方云服务。
• 多语言支持：提供多语言界面，适配不同地区用户需求。

3. 使用场景和适用范围

3.1 适用场景

• 个人财务管理：个人用户跟踪日常收支、制定预算、分析消费***惯。
• 隐私敏感用户：对财务数据隐私有高要求，不愿将数据上传至第三方平台的用户。
• 自托管服务：家庭或小型团队通过私有服务器部署，实现多人财务数据隔离管理。

3.2 适用范围

• 支持Docker环境的个人服务器、NAS设备或云服务器。
• 需要长期存储财务数据并定期备份的场景。

4. 使用方法和配置说明

4.1 基本Docker运行命令

通过以下命令快速启动Kresus容器，默认使用80端口对外提供服务，数据存储在宿主机的/path/to/kresus/data目录：

docker run -d \
  --name kresus \
  -p 80:80 \
  -v /path/to/kresus/data:/data \
  --restart unless-stopped \
  bnjbvr/kresus:latest

说明：-v /path/to/kresus/data:/data 用于持久化存储财务数据，需将/path/to/kresus/data替换为宿主机实际目录。

4.2 Docker Compose配置

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

version: '3'
services:
  kresus:
    image: bnjbvr/kresus:latest
    container_name: kresus
    ports:
      - "80:80"  # 宿主机端口:容器端口
    volumes:
      - ./kresus-data:/data  # 本地数据卷挂载
    restart: unless-stopped
    # 如需自定义环境变量，可添加environment字段
    # environment:
    #   - PORT=8080  # 示例：修改服务端口（具体参数请参考官方文档）

启动服务：

docker-compose up -d

4.3 数据持久化

Kresus的财务数据需持久化存储，避免容器重启后数据丢失。通过-v参数挂载宿主机目录至容器内/data路径（默认数据存储目录，具体以官方文档为准）。

4.4 配置说明

4.4.1 端口映射

默认容器内服务端口为80，可通过-p <宿主机端口>:80修改映射端口（如-p 8080:80将服务暴露在宿主机8080端口）。

4.4.2 环境变量（参考常规配置）

注：具体环境变量及配置项请以官方文档为准。

5. 注意事项

• 版本更新：建议定期查看官方文档，获取最新镜像版本及安全更新。
• 数据备份：定期备份挂载的数据卷目录，防止数据丢失。
• 依赖检查：确保Docker环境版本满足Kresus运行要求（推荐Docker 20.10+）。

如需构建自定义镜像或获取高级配置，请参考Kresus官方Docker安装文档。