跳至内容

FreqUI

Freqtrade 提供了一个内置的 Web 服务器,可用于提供 FreqUI(freqtrade 的前端)。

默认情况下,UI 会作为安装过程(脚本或 Docker)的一部分自动安装。你也可以通过使用 freqtrade install-ui 命令手动安装 freqUI。相同的命令还可用于将 freqUI 更新到新版本。

当机器人以实盘/模拟运行模式启动(使用 freqtrade trade)后,UI 将在配置的 API 端口下可用(默认为 http://127.0.0.1:8080)。

想要为 freqUI 贡献代码吗?

开发者不应使用此方法,而应克隆对应的仓库,并使用freqUI 仓库中描述的方法获取 freqUI 的源代码。构建前端需要安装可用的 Node.js 环境。

运行 freqtrade 不需要 freqUI

freqUI 是 freqtrade 的一个可选组件,运行机器人并非必需。它是一个可用于监控和与机器人交互的前端——但 freqtrade 本身在没有它的情况下也能正常运行。

配置

freqUI 没有独立的配置文件——它依赖于已正确配置的 REST API。请参考相应的文档页面以了解如何设置 freqUI。

用户界面

FreqUI 是一个现代、响应式的网页应用,可用于监控和与你的机器人进行交互。

FreqUI 提供浅色和深色两种主题,可通过页面顶部的显著按钮轻松切换。本页截图的主题将随文档主题自动适配,因此若要查看深色(或浅色)版本,请先切换文档的主题。

登录

下图显示了 freqUI 的登录界面。

FreqUI - login FreqUI - login

跨域资源共享 (CORS)

此截图中显示的 Cors 错误是由于 UI 运行的端口与 API 不同,且尚未正确配置CORS所致。

交易视图

交易视图允许你可视化机器人正在进行的交易,并与其进行交互。在此页面上,你还可以通过启动或停止机器人来控制其运行,并在配置允许的情况下强制开仓或平仓。

FreqUI - trade view FreqUI - trade view

图表配置器

FreqUI 图表可以通过策略中的 plot_config 配置对象(可通过“从策略加载”按钮导入)或通过 UI 进行配置。你可以创建并随意切换多个图表配置,从而灵活地查看不同的图表视图。

可在交易视图右上角点击“图表配置器”(齿轮图标)按钮访问图表配置功能。

FreqUI - plot configuration FreqUI - plot configuration

设置

可通过访问设置页面更改多个与 UI 相关的设置。

你可以更改的内容包括(但不限于):

  • UI 的时区
  • 在收藏夹图标(浏览器标签页)中可视化显示未平仓交易
  • 蜡烛图颜色(上涨/下跌 → 红色/绿色)
  • 启用/禁用应用内通知类型

FreqUI - Settings view FreqUI - Settings view

Web 服务器模式

当以web 服务器模式启动 freqtrade(使用freqtrade webserver命令启动)时,web 服务器将进入一种特殊模式,支持更多功能,例如:

  • 下载数据
  • 测试交易对列表
  • 回测策略
  • ……待扩展

回测

当以web 服务器模式启动 freqtrade(使用freqtrade webserver命令启动)时,将启用回测界面。该界面允许你回测策略并可视化结果。

你还可以加载并可视化之前的回测结果,并相互比较这些结果。

FreqUI - Backtesting FreqUI - Backtesting

CORS

本节内容仅在跨域场景下有必要(例如你在 localhost:8081localhost:8082 等不同端口上运行多个机器人 API),并希望将它们整合到一个 FreqUI 实例中。

技术说明

所有基于网页的前端都受CORS(跨域资源共享)限制。由于大多数对 Freqtrade API 的请求必须经过身份验证,因此合理的 CORS 策略对于避免安全问题至关重要。此外,标准不允许对带凭据的请求使用 * 通配符 CORS 策略,因此必须正确设置此项。

用户可以通过 CORS_origins 配置项,允许不同源 URL 访问机器人 API。该配置包含一个允许访问机器人 API 资源的 URL 列表。

假设您的应用部署在 https://frequi.freqtrade.io/home/,则需要进行如下配置:

{
    //...
    "jwt_secret_key": "somethingrandom",
    "CORS_origins": ["https://frequi.freqtrade.io"],
    //...
}

在以下这个相当常见的情况中,FreqUI 可通过 http://localhost:8080/trade 访问(即您在导航至 FreqUI 时浏览器地址栏显示的内容)。freqUI url

此情况下的正确配置为 http://localhost:8080 —— 即包含端口的 URL 主体部分。

{
    //...
    "jwt_secret_key": "somethingrandom",
    "CORS_origins": ["http://localhost:8080"],
    //...
}

尾部斜杠

CORS_origins 配置中不允许使用尾部斜杠(例如 "http://localhost:8080/")。此类配置将不会生效,且 CORS 错误仍会存在。

注意

我们强烈建议您将 jwt_secret_key 设置为只有您自己知道的随机字符串,以防止他人未经授权访问您的机器人。