- Home .
- 下载与文档
下载与文档
发布说明
版本 0.3.1
2024年10月17日 (版本说明)
win v0.3.1
lin v0.3.1
mac v0.3.1
许可证密钥与服务
XeroLite 系统要求和兼容性
类别
|
详细信息
|
---|---|
交易工作站
|
eroLite已针对交易工作站(Trader Workstation)版本10.19.1进行了优化,并已测试到10.23版本
重要提示: - 升级到高于10.23的版本可能会出现小问题,尤其是在进行大版本升级时。 - XeroLite将继续提供更新以保持兼容性,因此您可能需要相应地更新XeroLite版本以确保操作顺畅。 |
操作系统(OS)
|
- Windows
- Linux - MacOS |
VPS 规格
|
CPU:2核, 内存:8 GB
|
安装和设置指南
使用Xerolite,您需要具备以下条件:
- VPS(虚拟专用服务器):您必须有一个VPS(推荐规格:2CPU,8GB内存)和一个公共IP。
如果您没有,我们提供VPS订阅服务。请访问我们的VPS商店了解更多信息。 - 盈透账户:您必须有一个有效的盈透账户。
- TradingView账户:您必须有一个TradingView账户。
- 支持的操作系统:Windows、Linux和Mac
重要说明: 费用不包括安装和设置的成本。我们提供额外收费的设置服务。详情请访问我们的 安装和设置服务页面。.
- 设置TWS(IB交易工作站)并登录到将运行XeroLite的同一台设备上。
- 登录后,打开配置页面。进入顶部菜单栏,选择 编辑(Edit) -> 全局配置(Global Configuration)。
- 在 API设置 中:
- 勾选 启用ActiveX和Socket客户端(Enable ActiveX and Socket Clients)。
- 将 Socket端口 设置为 7497。
- 参考以下截图完成设置。
- 在 API -> 预防措施 中 (API – Precautions):
- 按照以下截图的设置,绕过所有预防措施。
按照以下简单步骤,在您的计算机上设置Xerolite:
步骤 1:下载并解压
- 从上述链接下载Xerolite(在本页面顶部的“下载”部分)。
- 将下载的
xerolite-xxxx.zip
文件复制到计算机上的任意磁盘。 - 解压该文件以提取其中的内容。
步骤 2:配置登录凭据
- 打开
config/login-credentials.properties
文件。 - 修改文件中的用户名和密码为您希望使用的值。
步骤 3:启动程序
对于Windows用户
- 打开命令提示符:按 Win + R,输入 cmd,然后按 Enter。
- 导航到Xerolite文件夹:
cd C:\path\to\xerolite
- 运行程序:
win-run.bat
对于Linux用户
- 打开终端:按 Ctrl + Alt + T。
- 导航到Xerolite文件夹:
cd /path/to/xerolite
- 运行程序:
./linux-run.sh
对于Mac用户
- 打开终端:按 Command + Space,输入 Terminal,然后按 Enter。
- 导航到Xerolite文件夹:
cd /path/to/xerolite
- 运行程序:
./mac-run.sh
注意: 如果Mac用户在第一次运行 ./mac-run.sh
时遇到以下错误:
导航到 /jre/bin
文件夹,右键点击 java 文件,然后选择 打开。
在弹出的警告窗口中,点击 打开。
此时会出现一个打印了Java执行警告的终端窗口
关闭该终端。 重新运行 ./mac-run.sh
。
步骤 4:访问登录页面
- 程序成功启动后,打开您的网页浏览器,在地址栏中输入:
localhost
- 您应该可以看到Xerolite登录页面,使用之前设置的用户名和密码登录。
重要提示:确保端口80已打开
Xerolite运行在 端口80 上。为了确保TradingView能够访问它,请确认端口80未被防火墙阻止,包括:
- 云防火墙(如果您使用云服务)。
- 操作系统防火墙(如Windows防火墙)。
测试端口80是否可访问
- 使用其他设备: 在另一台计算机或移动设备上打开网页浏览器(不是安装Xerolite的服务器)。
- 检查访问: 在浏览器地址栏中输入安装Xerolite的服务器IP地址。
- 如果设置正确,您应该可以看到Xerolite登录页面,这表明端口80已打开且可访问。
注意:
- 请勿在服务器本机测试: 确保不在安装Xerolite的服务器上测试此操作,否则无法准确验证外部的访问性。
按照这些步骤,您将成功设置Xerolite,并确保其可用于接收TradingView的提醒!
初次激活
- 登录Xerolite后,找到许可证密钥字段。
- 将您的许可证密钥粘贴到提供的文本框中。
- 点击激活按钮完成激活。
更新许可证
- 在菜单中点击更新许可证密钥。
- 将新的许可证密钥粘贴到许可证密钥文本框中。
- 点击激活按钮以更新您的许可证。
常见问题 (FAQ)
1. 我可以在多台机器上使用同一个许可证密钥吗?
不能,许可证密钥只能在同一时间内激活一台机器。如果尝试在第二台机器上激活许可证,原先机器上的许可证将自动停用。
2. 如果我想将XeroLite迁移到新机器怎么办?
只需在新机器上激活您的许可证密钥,这将自动停用原先机器上的许可证,使您能够在新机器上继续使用XeroLite而不会出现问题。
3. 我可以将我的许可证密钥与他人共享吗?
不可以,许可证密钥不可转让且不能与他人共享。如果许可证在另一台机器上使用,原先机器上的副本将被停用。
4. 购买后如何收到许可证密钥?
完成购买后,许可证密钥将发送至您的注册邮箱。请按照邮件中的说明激活XeroLite。
5. 如果没有收到许可证密钥邮件怎么办?
请先检查您的垃圾邮件或垃圾邮箱。如果仍未找到邮件,请联系支持团队以获得帮助。(support@xeroflex.com)
6. 如果我在激活许可证时遇到问题该怎么办?
如果在激活过程中遇到问题或需要转移许可证,请随时联系支持团队。我们随时准备为您提供技术支持和解答。
重要说明:
激活限制: 一次只能激活一台机器。
停用:如果在另一台机器上使用许可证,原机器将自动停用。
免费试用许可证: 您的许可证有效期为15天,可完全访问所有功能。
终身许可证:您的许可证永久有效,并适用于所有XeroLite v0.3.x版本更新。
第一步:登录TradingView
- 登录您的TradingView账户。
- 点击右上角的“+”图标来创建一个新警报。
第二步:设置警报规则
- 根据您的交易策略选择所需的警报条件。配置警报规则。
第三步:输入警报消息
- 在“消息”字段中输入您的警报请求。
- 请确保严格按照Xerolite指定的格式进行输入。
- 详细信息请参阅用户手册 (User Manual) -> 警报请求格式(Alert Request Format)标签
第四步:输入WebHook URL
- 复制Xerolite提供的WebHook URL,并将其粘贴到TradingView的WebHook URL字段中。
- 详细信息请参阅用户手册 (User Manual )-> WebHook URL标签。
Xerolite 是一个基于网页的应用程序,可以通过任何浏览器访问,因此保护您的登录凭据非常重要。请按照以下步骤更新您的用户名和密码:
找到凭据文件:
- 打开Xerolite配置文件夹中的
config/login-credentials.properties
文件。
- 打开Xerolite配置文件夹中的
修改用户名和密码
- 将用户名和密码更改为您想要的值。
保存并重启:
- 更改后,保存该文件。
- 重启Xerolite应用程序以使更新的登录凭据生效。
什么是 WebHook URL?
WebHook URL 是您需要在 TradingView 中配置的链接,用于发送警报。
- WebHook URL 的格式:
WebHook URL 的格式需要包含您的 API 密钥,例如:https://<your-ip-address>/api/order/place-order?x-api-key=dwLoMoXfMJq77_32fZYP8gQlvUzTzHPJ
- API 密钥的作用:
API 密钥为系统增加了一层额外的安全保护,帮助防止未经授权的请求。 - 重新生成 API 密钥:
如果您怀疑 API 密钥已被暴露,可以选择重新生成新的 API 密钥。这是一个重要的安全措施。 - 定期更新:
建议像更改密码一样,定期重新生成 API 密钥以保持系统安全。 - 更新 TradingView:
重新生成 API 密钥后,请务必在 TradingView 中更新 WebHook URL,确保新 URL 的格式如下:https://<your-ip-address>/api/order/place-order?x-api-key=<new-api-key>
- WebHook URL 的格式:
为了创建与 TradingView 集成的警报请求,请按照以下步骤操作。确保您配置的警报消息完全符合所需的格式。
警报消息格式示例::
字段说明::
- name: 警报名称,用于区分不同的警报。
- sec_type: 证券类型。可能的取值:
- STK: 股票
- CASH: 外汇
- FUT: 期货
- con_id: 来自盈透 Interactive Brokers(IB)的唯一合约 ID。
- exch: 交易所名称(例如,SMART)。.
- action: 指定采取的操作:买“buy”或卖“sell”。
- volume:
- 您要交易的股票数量或合约数量。
生成警报请求的步骤:
- 导航至“Create Your Alert Request”选项卡。
输入以下搜索条件:
- Symbol(例如,AAPL 代表苹果公司)
- Security Type(例如,STK 代表股票)
- Currency(例如,USD 代表美元)
使用这些输入来搜索来自盈透(Interactive Brokers) 的对应合约。
- 复制生成的 JSON:
- 执行搜索后,您会看到每个返回合约的 JSON 格式。
- 点击 Copy 复制 JSON 消息。
- (如有必要)修改 JSON:
- 不建议修改:
con_id
、sec_type
或exch
值。 - 您可以修改以下字段:
- action:选择“buy”或“sell”。
- volume:设置订单的数量。
- name:根据需要更新警报名称。
- 不建议修改:
通过以上步骤,您可以生成精确的 TradingView 警报请求,确保消息配置正确以便执行。
为什么需要白名单?
出于安全考虑,Xerolite 的 Webhook URL 仅接受来自特定批准(白名单)IP 地址的请求。
默认情况下,只有您的服务器(localhost)和 TradingView 的 IP 地址被允许访问。
从其他设备进行测试
如果您希望从其他设备(例如手机或其他计算机)测试 Webhook URL,需要将该设备的 IP 地址添加到白名单。
添加设备 IP 到白名单的步骤:
找到您的设备 IP 地址
- 前往 WhatIsMyIP.com 以轻松找到您的设备 IP 地址。
更新配置文件
打开 Xerolite 的
custom.yml
文件。在标记为
whitelist
的部分中添加您的 IP 地址,格式如下:
注意缩进
添加 IP 地址时,请确保空格(缩进)与示例完全一致,否则可能无法正常工作。重启 Xerolite
新添加的 IP 地址将出现在 “WhiteList IP” 部分中。未授权请求
来自未列入白名单的设备的警报请求将被视为 “未授权”,并不会被处理。
为了确保安全性,请仅将可信设备的 IP 地址加入白名单。
如何验证并测试您的警报请求
在等待 TradingView 触发之前,您可以通过 Xerolite 提供的测试工具验证警报请求是否有效,并确保可以成功通过 Webhook URL 下单。这有助于避免延迟或错误。
验证和测试警报请求的步骤:
为什么需要验证?
提前测试警报请求可以确保其工作正常,避免等待 TradingView 触发时发现问题。使用我们的测试工具
我们提供了一个简单的工具,帮助您验证和测试警报消息。操作步骤:
- 进入 “Place Your Order” 标签页
- Copy your alert request JSON (the one you generated earlier).
- Paste the JSON into the provided text box.
Validate the Alert Request:
- Click the “Validate Message” button to check if the format of your JSON is correct.
- Click the “Validate Message” button to check if the format of your JSON is correct.
Submit the Order (Optional):
If you want to test sending an actual order to Interactive Brokers, click the “Submit” button.Testing from a Different Device:
If you want to use this feature from a device other than from VPS where you install the xerolite (e.g., testing from your phone/ home laptop), you will need to whitelist your phone’s IP address to ensure it is allowed to access the tool.
By following these steps, you’ll be able to validate and test your alert requests in a safe environment before executing them through TradingView or Interactive Brokers.
Here are solutions for resolving common problems encountered while using Xerolite:
1. Unable to Receive Alerts
Ensure Xerolite is Running:
- Verify that the Xerolite application is set up correctly and running in the background.
Check TradingView Webhook Configuration:
- Double-check that the webhook URL is correctly configured in your TradingView alert settings.
Firewall or Port 80 Blockage:
- Ensure port 80 is not blocked by your firewall or being used by another program. Follow the instructions below to resolve this.
2. Port 80 in Use
If port 80 is occupied by another program, you need to free it up for Xerolite.
Windows:
- Identify the Process Using Port 80:
- Open Command Prompt as Administrator.
- Run the following command:netstat -ano | findstr :80
This will show the process using port 80 and its PID (Process ID).
- Kill the Process:
- Run the command:
taskkill /PID <PID> /F
Replace
<PID>
with the process ID found in the previous step.
- Run the command:
- Windows Server 2019:
- Stop the “Web Deployment Agent Service” to free up port 80.
Linux:
- Identify the Process Using Port 80:
- Open Terminal and run:sudo lsof -i :80
This will display the process name and its PID.
- Open Terminal and run:
- Kill the Process:
- Run the command:
sudo kill -9 <PID>Replace<PID>
with the process ID.
- Run the command:
Mac:
- Identify the Process Using Port 80:
- Open Terminal and run:
sudo lsof -i :80
- Open Terminal and run:
- Kill the Process:
- Run:sudo kill -9 <PID>
- Run:
3. TWS (Trader Workstation) Connection Issues
This error indicates that Xerolite has lost connection to the Interactive Brokers Trader Workstation (TWS).
Possible Causes:
- TWS is not open or you’re not logged in.
- Socket Port 7497 is not open
Solutions:
- Restart TWS and log back in.
- Ensure that TWS is running and remains active.
- Make sure socket port has been set to 7497 (Refer to Step 1: Setup TWS)
4. IB Server Connectivity Issues
This reflects the connection status between TWS (Trader Workstation) and the IB Server.
When the Connection is Lost:
- If the connection between TWS and the IB Server is lost, TWS will no longer be able to place or modify orders.
- This can occur due to various reasons, such as:
- IB Server Downtime/IB Server Nightly Reset
- Internet Connectivity Issues
- Competing Sessions — You may have logged into TWS from another session, which can cause disconnection from the current one.
During Disconnection:
- Manual order placement in TWS will also be unavailable.
- To check whether the IB server is down, visit the official system status page: IB System Status
Possible Solutions:
- Restart TWS and log back in to restore the connection.
- Ensure you have a stable internet connection.
- Monitor system resources—high memory or CPU usage may cause disconnections, so ensure your machine is not overloaded.
- Verify that you are not logged into TWS in another session, as competing sessions can lead to connection issues.
General Tips:
- Regularly monitor your system’s resource usage to ensure smooth operation.
- Ensure a stable internet connection to avoid issues between TWS and IB servers.
By following these troubleshooting steps, you can resolve most issues encountered with Xerolite and maintain smooth communication with Interactive Brokers.
免责声明与用户责任
Xerolite作为桥接工具
Xerolite作为桥梁,通过TradingView的Webhook URL接收订单并将其发送到盈透(Interactive Brokers)。它不会为您做出任何交易决策。确保TWS处于激活状态
用户有责任确保在使用Xerolite时,交易工作站(TWS)始终处于运行状态。如果TWS未运行,订单将无法提交,Xerolite不对错过的交易负责。不保证盈利
Xerolite仅协助基于您配置的警报来下单。我们不保证使用此软件可以获利。交易具有固有风险,结果取决于您的交易策略和市场状况。用户生成的请求
所有通过Xerolite下达的订单均由用户定义的警报和策略生成。我们不会影响或修改订单。用户完全负责他们发送的订单请求的准确性和正确性。监控责任
用户必须主动监控他们的账户、订单和系统性能。Xerolite提供自动下单工具,但用户有责任在交易活动中管理风险并采取任何必要的纠正措施。责任限制
我们不对由于技术问题、网络故障或您的警报设置、TradingView或盈透(IB)系统的错误配置而导致的任何损失、延迟或执行失败负责。
版本说明
[版本 0.3.1] – 2024年10月17日
新增
- 在警报弹窗中新增“复制”按钮,方便用户轻松复制警报信息。
更改
- con_id和volume字段现在支持带引号或不带引号的值。
- 将日期筛选从下拉菜单更改为按钮,以提升用户体验。
[版本 0.3.0] – 2024年09月25日
新增
- 支持许可证密钥
- 支持免费试用
- 用户手册
更改
- 将警报日志历史从15天增加到30天。
[版本0.2.1] – 2024年09月01日
新增
- 登录页面
[版本0.2.0] – 2024年06月03日
新增
- IP白名单功能
- 订单警报生成工具:
- 允许用户搜索来自Interactive Brokers(IB)的符号并生成警报JSON。
- 用于测试下单和验证警报消息的工具。
- Webhook URL中的API密钥
[版本 0.1.0] – 2024年01月03日
新增
- 首次发布
- 从TradingView警报日志自动化到Interactive Brokers订单