Skip to content

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 环境。

运行 Freqtrade 并不需要 FreqUI

FreqUI 是 Freqtrade 的可选组件,并非运行机器人所必需。 它是一个可用于监控机器人并与之交互的前端界面,但 Freqtrade 本身在没有它的情况下也能完美运行。

配置

FreqUI 没有自己的配置文件,但需要确保 REST API 已正确设置并可用。 请参考相应的文档页面来配置 FreqUI。

用户界面

FreqUI 是一款现代化的响应式 Web 应用程序,可用于监控您的交易机器人并与之交互。

FreqUI 提供浅色和深色两种主题。 可通过页面顶部的显眼按钮轻松切换主题。 本页截图的主题将适配文档所选主题,因此如需查看深色(或浅色)版本,请切换文档主题。

登录界面

下图展示了 FreqUI 的登录界面。

FreqUI - login FreqUI - login

CORS

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

交易视图

交易视图可让您可视化机器人的交易动态并与之交互。 在此页面,您还可以通过启动/停止机器人来与之交互,若已配置,还可强制执行交易入场和出场。

FreqUI - trade view FreqUI - trade view

图表配置器

FreqUI 绘图功能可通过策略中的 plot_config 配置对象(可通过"从策略加载"按钮载入)或直接通过界面进行配置。 您可以创建多个绘图配置并随意切换,从而灵活地以不同视角查看图表。

绘图配置可通过交易视图右上角的"绘图配置器"(齿轮图标)按钮进行访问。

FreqUI - 绘图配置 FreqUI - 绘图配置

设置

通过访问设置页面可修改多项界面相关设置。

可调整项目包括(但不限于):

  • 界面时区设置
  • 在网站图标(浏览器标签页)中显示未平仓交易
  • K线颜色配置(上涨/下跌 → 红/绿)
  • 启用/禁用应用内通知类型

FreqUI - 设置界面 FreqUI - 设置界面

网页服务器模式

当 freqtrade 以网页服务器模式启动(使用 freqtrade webserver 命令)时,服务器将启动特殊模式以支持额外功能,例如:

  • 数据下载
  • 交易对列表测试
  • 策略回测
  • ... 功能将持续扩展

回测

当 freqtrade 以 webserver 模式 启动时(使用 freqtrade webserver 命令启动),回测视图将变为可用。 该视图允许您对策略进行回测并可视化结果。

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

FreqUI - 回测界面 FreqUI - 回测界面

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"],
    //...
}

trailing Slash

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

Note

我们强烈建议同时将 jwt_secret_key 设置为一个随机且仅您自己知晓的值,以避免未经授权访问您的机器人。