安装

这个文档教您如何安装 openresty-xray-cli

1. 要求

我们需要能够访问以下的网址,如果您的网络有防火墙,请你将下面的地址加入到白名单中。

openresty.com 443
saas.openresty.com 443

2. 安装 XRay 代理

  • 请先登录 OpenResty XRay 控制台网页。
  • 点击添加目标机器。
  • 请按照提示选择安装像 RPM/Deb 包一样的二进制包。

3. 获取 API token

  • 回到 OpenResty XRay 控制台首页。
  • 个人访问 API tokens下面有一个管理按钮, 点击进入。
  • 点击生成新 token,输入名字然后点击生成 token。
  • 请保存好生成的 token,这个 token 只会显示一次。

4. 安装 openresty-xray-cli

如果您的操作系统是 RHEL, CentOS, 使用以下命令。

yum install -y openresty-xray-cli

如果您的操作系统是 Fedora, 使用以下命令。

dnf install -y openresty-xray-cli

如果您的操作系统是 Ubuntu, Debian, 使用以下命令。

apt install -y openresty-xray-cli

5. 设置配置文件

执行下面命令。

$ orxray --help
error: api_token is not found in config file '/root/.orxray/config'.

Goto https://xxx.xx.xx/security/access-tokens for api_token
Please input api_token:

按照提示信息输入上一步骤获取到的 API 令牌。

然后尝试执行以下命令, 如果返回正确说明已经安装成功了。

$ run-y -e '_probe _oneshot { printf("Hello,world\n"); }' -q
Hello,world

配置文件存储在 ~/.orxray/config 中。

您可以打印它的内容。

$ cat ~/.orxray/config
[console]
host=xxx.xxx.xxx
port=443
verify_ssl=true
scheme=https
timeout=10
api_token=xxxxxxxxxxxxxxxxxxxxx
default_agent=53

您可以看到 default_agent 已经被自动设置为本地机器。您可以修改这个默认参数。

很多命令在不指定 agent 的情况下会使用默认 agent 来执行相关命令。