关于 Investbrain

Investbrain 是一个智能的开源投资追踪器，可帮助您管理、追踪您的投资并做出明智的决策。

目录

• 技术栈
• 安装（自托管）
• 与您的持仓对话
• 市场数据提供商
• 导入 / 导出
• 配置
• 更新
• 命令行工具
• 故障排除
• 测试

技术栈

Investbrain 是一个基于 Laravel PHP 的 Web 应用程序，具有可扩展的市场数据提供商接口。开箱即用，我们内置了许多市场数据提供商。但勇敢的开发者可以创建自己的提供商！我们还集成了 OpenAI 和 Ollama，以实现我们的"与您的持仓对话"功能。当然，我们还对国际化 (i18n)、无障碍访问 (a11y) 和深色模式提供了强大的支持。

自托管

为了简化安装，我们强烈建议使用提供的 Docker Compose 文件来安装 Investbrain，该文件使用官方的 Investbrain Docker 镜像，并包含所有必要的依赖项，以无缝构建您快速入门所需的一切！

在开始之前，您的机器上应该已经安装了 Docker Engine。

准备好了吗？让我们开始吧！

1. 下载 Docker Compose 文件副本

使用 wget、curl 或类似工具获取 docker-compose.yml 的副本：

curl -O https://raw.githubusercontent.com/investbrainapp/investbrain/main/docker-compose.yml

2. 设置您的环境变量

根据您的偏好调整 compose 文件中的 environment 属性。

3. 运行 docker compose up

拉取 Docker 镜像可能需要几分钟时间。假设一切按预期进行，您现在应该可以通过访问以下地址在浏览器中使用 Investbrain：

http://localhost:8000/register

恭喜！您刚刚安装了 Investbrain！

与您的持仓对话

Investbrain 提供了一个基于您的投资数据的人工智能聊天助手。这使您可以在做出投资决策时将 AI 作为思考伙伴。

目前支持大多数主流实验室（OpenAI、Anthropic、Gemini、xAI 等）。您需要从您选择的提供商处获取 API 密钥，并使用相应的密钥在您的 .env 文件中进行配置。

Investbrain 也与 Ollama（以及其他 OpenAI 兼容的 API）兼容。如果您自托管了暴露 OpenAI 兼容 API 的大型语言模型（"LLMs"）（例如 Ollama），您需要在您的 .env 文件中配置本地端点。

请参阅下方的可用选项。

请始终牢记 LLMs 的局限性。如有疑问，请咨询持牌投资顾问。

市场数据提供商

Investbrain 包含一个可扩展的市场数据提供商接口，允许您从多个提供商（如 Yahoo Finance、Twelve Data、Finnhub、Alpaca 和 Alpha Vantage）获取股票市场数据。该接口包含内置的回退机制，以确保即使某个提供商失败，也能可靠地访问数据。

市场数据配置

您可以在环境变量中指定要使用的市场数据提供商：

MARKET_DATA_PROVIDER=yahoo

您也可以使用 Investbrain 的内置回退机制来确保可靠的数据访问。如果任何提供商失败，Investbrain 将自动尝试从下一个可用的提供商获取数据，依次遍历您配置的提供商，直到有一个成功返回。

您选择的提供商应在环境变量中列出。每个提供商之间用逗号分隔：

MARKET_DATA_PROVIDER=yahoo,alphavantage

在上面的例子中，将首先尝试 Yahoo Finance。如果 Yahoo Finance 无法获取市场数据，应用程序将自动尝试 Alpha Vantage。

自定义提供商

如果您希望创建自己的市场数据提供商，您可以创建自己的 MarketDataInterface 实现。您可以参考任何现有的市场数据实现作为示例。

创建好您的市场数据实现后，请务必将您的自定义提供商添加到 Investbrain 配置文件的 interfaces 部分：

'interfaces' => [
    //                       *  *  *
    'custom_provider' => \App\Services\CustomProviderMarketData::class,
    //                       *  *  *
],

并将您的自定义提供商添加到您的 .env 文件中：

MARKET_DATA_PROVIDER=yahoo,alphavantage,custom_provider

欢迎为您创建的任何自定义提供商提交 PR。

导入 / 导出

Investbrain 包含一个便捷的功能，允许您保持投资组合和交易数据的可移植性。

导入

导入操作会"更新插入"到数据库中。如果数据库中尚不存在该记录，则会创建该记录。但是，当投资组合或交易已存在时（即记录的 ID 与现有记录匹配），该记录将被更新。这样，您可以同时创建新记录，也可以批量更新记录。

导出

导出您的投资组合和交易记录是备份 Investbrain 数据的便捷方式。这也是保持您数据可移植性的便捷方法。

配置

使用推荐的 Docker 方法 安装时，有几个可选配置可用。这些选项可通过环境文件进行配置。配置可以添加到您的 .env 文件或 docker-compose.yml 文件中的 environment 属性。

选项	描述	默认值
APP_URL	您的 Investbrain 安装可访问的 URL	http://localhost
APP_PORT	NGINX 容器暴露的 HTTP 端口	8000
APP_KEY	用于各种安全相关功能的加密密钥	安装期间自动设置
MARKET_DATA_PROVIDER	使用的市场数据提供商（可以是 yahoo、twelvedata、alphavantage、alpaca 或 finnhub）	yahoo
ALPHAVANTAGE_API_KEY	如果使用 Alpha Vantage 提供商	null
FINNHUB_API_KEY	如果使用 Finnhub 提供商	null
ALPACA_API_KEY	如果使用 Alpaca 提供商	null
ALPACA_API_SECRET	如果使用 Alpaca 提供商	null
TWELVEDATA_API_SECRET	如果使用 Twelve Data 提供商	null
MARKET_DATA_REFRESH	市场数据刷新频率（分钟）	30
APP_TIMEZONE	应用程序的时区，包括每日涨跌幅捕获	UTC
AI_CHAT_ENABLED	是否启用 AI 聊天功能	false
CHAT_PROVIDER	使用的聊天提供商（openai、anthropic、gemini、azure、groq、xai、deepseek、mistral、ollama 之一）	openai
CHAT_MODEL	用于 AI 聊天选择的 LLM	默认为实验室当前最智能模型
ANTHROPIC_API_KEY	如果使用 Anthropic 进行聊天	null
OPENAI_API_KEY	如果使用 OpenAI 进行聊天	null
OLLAMA_BASE_URL	如果使用 Ollama 进行聊天	http://localhost:11434
OLLAMA_API_KEY	如果使用 Ollama 进行聊天可能需要	null
DAILY_CHANGE_TIME	每日涨跌幅捕获时间	23:00
REGISTRATION_ENABLED	是否启用新用户注册	true

注意：这些选项会影响 docker-compose.yml 文件，并在运行时被缓存。如果更改任何环境配置，您需要重启容器才能使更改生效。

更新

要使用推荐的 Docker 安装 方法更新 Investbrain，您只需停止正在运行的容器：

docker compose stop

然后拉取最新的 Docker 镜像：

docker image pull investbrainapp/investbrain:latest

最后重新启动容器！

docker compose up

就这么简单！

命令行工具

Investbrain 捆绑了几个有用的命令行工具，使管理您的投资组合和持仓更加高效。请注意这些命令功能非常强大，可能会对您的持仓造成不可逆的更改。为了安全起见，我们建议在使用这些命令之前备份您的投资组合。

要运行这些命令，您可以像这样使用 docker exec：

docker exec -it investbrain-app php artisan <替换为您要运行的命令>

如果您需要了解命令的更多详细信息，可以使用 help 选项查看可用选项：

<您要运行的命令> --help

命令	描述
refresh:market-data	使用您配置的市场数据提供商刷新市场数据。
refresh:dividend-data	使用您配置的市场数据提供商刷新股息数据。还会重新计算每个持仓的总股息收益。
refresh:split-data	使用您配置的市场数据提供商刷新拆股数据。还会创建新交易以处理任何拆股。
refresh:currency-data	获取最新的每日货币汇率数据并持久化到数据库。
capture:daily-change	捕获每个投资组合每日表现的快照。
sync:daily-change	同步您投资组合每日表现的每日快照。用于填补投资组合图表中的空白。（注意：这是一个资源消耗极大的查询。）
sync:holdings	同步与相关交易（即股息、已实现收益等）关联的持仓表现。
fix:cost-basis-for-sales	自动重新计算卖出交易成本基础的实用工具。

故障排除

如果您遇到 Investbrain 的问题，监控应用程序的日志可能会很有帮助：

docker exec -it investbrain-app cat storage/logs/laravel.log

或者您可以使用 tail 实时监控日志：

docker exec -it investbrain-app tail -f storage/logs/laravel.log

常见问题

应用程序样式损坏且图片过大

如果您通过 DNS 名称（例如 example.com）提供 Investbrain 服务，很可能您尚未更新 ASSET_URL 环境变量。那里提供的 URL 将用于为应用程序前端的图片、JS 和 CSS 资源生成绝对 URL。

新安装后市场数据无法刷新

如果您无法立即刷新市场数据（即您的市场数据提供商设置为 Yahoo），可能是防火墙或广告拦截器阻止了 Yahoo。已知 Pihole 会阻止 fc.yahoo.com，这是用于查询 Yahoo 的域名。

一旦您在 pihole 中将 fc.yahoo.com 加入白名单，您的市场数据就应该开始填充了！

测试

Investbrain 拥有一个健壮的 PHPUnit 测试套件，它创建一个内存中的 SQLite 数据库，并使用 Laravel 的数组驱动程序同步运行任何排队的作业。您可以通过运行以下命令在 Docker 容器内运行整个 Investbrain 测试套件：

docker exec -it investbrain-app php artisan test

贡献

我们感谢对 Investbrain 的任何贡献！请在我们的 Github 仓库 上提交拉取请求。以下是一些适合首次贡献者的想法：

• 改进我们的文档
• 创建新的市场数据提供商
• 增强用户界面
• 额外的翻译
• 修复错误

当您提交贡献时，请不要忘记在您的 PR 中包含通过的测试！

行为准则

我们要求您在与 Investbrain 社区互动时保持友善和礼貌。

安全漏洞

如果您在 Investbrain 中发现安全漏洞，请通过 GitHub 提交报告。所有安全漏洞都将得到及时处理。我们要求您在漏洞得到妥善解决之前，对任何疑似漏洞保持私密和保密。

许可证

Investbrain 是开源软件，采用 CC-BY-NC 4.0 许可证授权。

Investbrain 快速上手指南

Investbrain 是一款智能开源投资追踪器，帮助您管理、追踪投资组合并做出明智决策。

环境准备

系统要求

• 操作系统：Linux、macOS 或 Windows（WSL2）
• Docker Engine：最新稳定版本
• Docker Compose：v2.0+
• 内存：建议至少 2GB RAM
• 磁盘空间：至少 1GB 可用空间

前置依赖

确保已安装以下软件：

• Docker Engine
• Docker Compose

安装步骤

1. 下载 Docker Compose 配置文件

使用 curl 或 wget 下载配置文件：

curl -O https://raw.githubusercontent.com/investbrainapp/investbrain/main/docker-compose.yml

2. 配置环境变量

编辑 docker-compose.yml 文件，根据需要调整环境变量：

environment:
  - APP_URL=http://localhost:8000
  - APP_PORT=8000
  # 其他配置项...

3. 启动 Investbrain

运行以下命令启动服务：

docker compose up -d

首次运行需要下载 Docker 镜像，可能需要几分钟时间。

4. 访问应用

在浏览器中打开：

http://localhost:8000/register

基本使用

1. 注册账户

首次访问时，点击注册按钮创建新账户。

2. 添加投资组合

• 点击“新建投资组合”
• 输入组合名称（如“我的股票投资”）
• 设置基础货币（支持 USD、CNY 等）

3. 添加持仓

在投资组合中：

• 点击“添加持仓”
• 输入股票代码（如：AAPL、00700.HK）
• 输入持股数量和买入价格
• Investbrain 会自动获取实时市场数据

4. 查看投资表现

• 仪表板：查看总体投资表现
• 持仓列表：查看单个股票表现
• 图表：查看历史收益曲线
• AI 聊天助手：与您的持仓对话获取投资见解（需配置 API 密钥）

5. 配置市场数据源

在 .env 文件中配置首选数据提供商：

# 支持的数据提供商：yahoo, twelvedata, finnhub, alpaca, alphavantage
MARKET_DATA_PROVIDER=yahoo

# 如需备用数据源（当首选提供商失败时自动切换）
MARKET_DATA_PROVIDER=yahoo,alphavantage

6. 启用 AI 聊天功能（可选）

如需使用 AI 投资助手功能：

AI_CHAT_ENABLED=true
CHAT_PROVIDER=openai  # 或 anthropic、gemini、ollama 等
OPENAI_API_KEY=sk-your-api-key-here

常用命令

更新 Investbrain

# 停止当前服务
docker compose stop

# 拉取最新镜像
docker pull investbrainapp/investbrain:latest

# 重新启动
docker compose up -d

查看日志

# 查看应用日志
docker logs investbrain-app

# 实时监控日志
docker logs -f investbrain-app

数据维护命令

通过 Docker 执行 Investbrain 命令：

# 刷新市场数据
docker exec investbrain-app php artisan refresh:market-data

# 刷新股息数据
docker exec investbrain-app php artisan refresh:dividend-data

# 捕获每日变化
docker exec investbrain-app php artisan capture:daily-change

配置说明

重要环境变量

变量名	说明	默认值
APP_URL	应用访问地址	http://localhost
MARKET_DATA_PROVIDER	市场数据提供商	yahoo
AI_CHAT_ENABLED	启用 AI 聊天	false
REGISTRATION_ENABLED	允许用户注册	true
APP_TIMEZONE	应用时区	UTC

中国市场数据注意事项

• Yahoo Finance：可直接使用，无需 API 密钥
• Alpha Vantage：需要免费 API 密钥（每日有限额）
• 国内股票：使用 .SS（上海）和 .SZ（深圳）后缀，如：000001.SZ

下一步

• 导入现有投资组合（支持 CSV 格式）
• 配置自动数据刷新
• 设置投资目标追踪
• 探索高级分析功能

现在您可以开始使用 Investbrain 管理您的投资了！如需更多帮助，请参考项目文档或社区讨论。