Vultr WHMCS模块

• 模块信息
• 介绍
• 系统要求
• 先决条件
• 局限性
• 范围
• 模块功能
• 创建一个API密钥
• 安装
• 首次安装
• 模块配置
• 订购流程
• 常问问题

注意：在安装Vultr WHMCS模块之前，请完整阅读本文档。

模块信息

• 版本：2.0.0（更新）
• 发行日期：2019年6月25日
• 变更日志
• 请向官方Vultr WHMCS github存储库提交任何问题/错误报告

介绍

Vultr平台提供了功能强大且功能丰富的API，允许用户控制其帐户的各个方面。Vultr WHMCS模块为托管提供商提供了完全自动化的解决方案，使他们可以在Vultr平台上向客户提供可靠的云服务器。

注意：该模块的当前版本是对原始模块的完整重写，但是与WHMCS中现有的基于Vultr的产品兼容。

系统要求

• WHMCS 7.2.x版或更高版本
• PHP 7.1.x或更高版本
• MySQL  5.6，MariaDB  5.6，MariaDB  10.0或MariaDB  10.1。
• ionCube加载程序。

先决条件

• Vultr API密钥
• 您的WHMCS服务器IP已列入API访问许可白名单

笔记

• 您必须将WHMCS服务器的IPv4和IPv6地址列入白名单以进行API访问
  • 如果您的服务器具有多个IPv4地址，则可以将它们分别白名单或将整个子网白名单。
  • 如果您的服务器具有IPv6地址，则最好将整个/ 64子网列入白名单
• 由于达到使用寿命，因此不支持WHMCS版本6 。
• 由于达到使用寿命，因此不支持PHP 7.0.x版。
• 没有计划支持较旧版本的WHMCS和PHP。
• 您必须使用产品模块所生成的可配置选项。自己创建可能会引起冲突。

局限性

以下是模块设计未包含的选项列表。

1. 添加其他IPv4地址。
2. 部署虚拟机后启用专用网络。
3. 在OS和Apps之间切换。
4. 在Linux和Windows之间切换。

范围

本文档将介绍安装和配置官方Vultr WHMCS模块的过程。Vultr不支持从第三方网站下载的模块。

模块功能

• 一键创建基于Vultr的VPS产品
  • 您将需要手动设置每种产品的价格和可配置选项。
• 部署和升级虚拟机
• 开机/关机/关机功能
• HTML5 VNC控制台
• rDNS控制
• 私人网络
• 启动脚本
• SSH密钥
• 快照控制
• 从预定义的ISO列表部署VM
• 从预定义的快照列表部署VM
• 为VM部署启用/禁用特定的ISO和快照
• 启用/禁用部署位置
• Vultr DNS支持和Vanity DNS（自定义名称服务器）支持

创建一个API密钥

1. 登录到Vultr客户区。
2. 单击帐户。
3. 单击API。
4. 点击启用API。
5. 在访问控制下，将WHMCS服务器的IP地址列入白名单。

安装

第一步是在此处下载Vultr WHMCS模块

新安装

1. 提取ZIP存档。
2. 按照以下定义的目录层次结构将模块文件上传到WHMCS服务器

升级模块的旧版本

1. 备份数据库和文件
2. 完全删除modules/addons/vultr和modules/servers/vultr目录。
3. 提取并上传新模块。

目录层次结构

下载档案

• 模组
  • 插件
    • vultr
  • 伺服器
    • vultr

首次安装

1. 按照上述说明上传模块
2. 登录到WHMCS管理面板，然后浏览至Setup -> Addon Modules。
3. 在旁边Vultr Module，单击Configure按钮。
4. 选中旁边的复选框Hooks Enabled。
5. 在API Key字段中输入您的API密钥。
6. 设置Access Control了Administrator和其他角色要启用它。
7. 请点击 Save Changes
8. 登录到WHMCS管理面板并导航以Addons -> Vultr Module配置本文档下一部分中介绍的模块选项

模块配置

文档的此部分将展示该模块的所有可用配置选项，说明它们的工作方式，并说明如何配置它们。

产品创造者

本部分将允许您在WHMCS中创建基于Vultr的产品。有两种模式，Single Product Creator和Multiple Product Creator。

该Single Product Creator模式将允许您基于可用的Vultr软件包创建产品，选择产品组以及要添加产品的价格。可配置选项（例如快照，Windows，cPanel Apps等）的价格必须手动添加到产品的可配置选项中。

在Multi Product Creator您的WHMCS将批量创建基于Vultr-VPS软件包，但是你必须手动设置定价为每个包，以及定价的配置选项，类似Single Product Creator的模式。

产品展示

本部分将显示WHMCS中所有基于Vultr的产品的完整列表，并使您可以快速导航到Edit，或Configurable Options 每个页面。您也可以从该页面删除产品。当您想在WHMCS管理区域中快速找到Vultr产品以对其进行修改或修改其可配置选项时，此部分非常有用。

域名解析

Vultr WHMCS模块支持Vanity名称服务器（自定义ns1和ns2.domain.com）。设置Vanity名称服务器需要第一步，这是使用您的域名注册商创建自定义名称服务器，并将其指向IP ns1.vultr.com并ns2.vultr.com解析。完成后，请按照以下步骤操作：

1. 登录到您的WHMCS管理面板。
2. 继续吧Addons -> Vultr Module。
3. 点击DNS。
4. 添加和的值Nameserver 1，Nameserver 2然后单击Save Changes。
5. 你完成了。

请注意，Vanity名称服务器应用于新添加的DNS区域/域。现有的将必须在https://my.vultr.com中手动进行修改。

服务器位置

您可以选择启用和禁用某些Cloud Locations，从而允许客户仅在您选择的位置部署虚拟机。请记住，在订购过程中无法选择Cloud Location，因为根据部署时所选软件包的可用位置来动态加载位置。

为了选择为您的客户启用的位置，请按照以下步骤操作：

1. 登录到您的WHMCS管理面板。
2. 继续吧Addons -> Vultr Module。
3. 点击Server Location。
4. 单击该Enabled按钮可禁用您要禁用的位置（单击该按钮时，Disabled它将重新启用该位置）。
5. 你完成了。

快照

Vultr WHMCS模块允许您在帐户上制作一个或多个快照，Public这意味着您可以允许客户选择从这些快照中部署新的虚拟机。Disabled 默认情况下，模块中您帐户上的所有快照均设置为默认，因此您需要启用它们。

为了选择要向客户公开的快照，请按照以下步骤操作：

1. 登录到您的WHMCS管理面板。
2. 继续吧Addons -> Vultr Module。
3. 点击Snapshots。
4. 单击该Disabled按钮以启用您要公开的快照（单击该按钮时，Enabled将说明将重新启用该快照）。
5. 你完成了。

ISO标准

与快照功能类似，您可以在帐户中创建一个或多个自定义上传的ISO，Public这意味着您可以允许客户选择从这些ISO部署新的虚拟机。Disabled 默认情况下，模块中将您帐户上的所有ISO设置为默认值，您需要启用它们。

为了选择要向客户公开的快照，请按照以下步骤操作：

1. 登录到您的WHMCS管理面板。
2. 继续吧Addons -> Vultr Module。
3. 点击ISO。
4. 单击该Disabled按钮以启用您要公开的ISO（单击该按钮时，它将说Enabled重新启用ISO）。
5. 你完成了。

订购流程

在WHMCS中订购基于Vultr的产品是一个三步过程。

第1步

WHMCS客户区域/购物车中的客户订单：客户将为虚拟机下订单。他们将被要求输入：

• 主机名
• 根密码
• NS1和NS2

这是标准的WHMCS订单，Vultr没有任何控制权。欢迎您更改WHMCS订单表单模板以隐藏任何这些选项。请记住，由于Vultr的API会为每个VM生成一个随机的安全密码，因此不会使用按顺序选择的root密码。此外，如果客户端是从快照部署的，则他们需要事先知道快照的根密码，否则他们将无法登录。

此外，将要求客户端选择是否启用“自动备份”，“快照限制”和“操作系统类型”。

关于操作系统类型，在订购表下方显示的下拉菜单中有4个选项OS Type

1. 所有可用操作系统映像的列表
2. ISO标准
3. 快照
4. 应用

选择Application将启用所有可用的一键式应用Vultr提供的列表。ISO和快照将允许客户选择要从中部署虚拟机的ISO或快照。

第2步

管理员将批准订单并在WHMCS中提供服务（或者您可以选择以与WHMCS中其他任何产品相同的方式在WHMCS中的产品选项中进行该自动化过程。

第三步

客户将必须通过选择服务器的标签/昵称，主机名以及其他选项（例如SSH密钥，IPv6，专用网络或启动脚本）来完成客户区中的订购过程。

常问问题

我收到有关连接失败的错误。

确保您的API密钥没有前缀或后缀任何空格，并且服务器的IPv4和IPv6地址都被列入白名单以进行API访问。您可以在成员区域中验证API规则。

如果密钥和ACL规则正确，则可以通过登录WHMCS服务器并使用cURL运行直接API调用来进一步测试密钥。cURL示例在我们的API示例部分中提供。

如何通过自动设置系统指定标准启动脚本？

如前所述，期望客户根据自己的喜好自定义选项后，才能在客户区域中最终完成虚拟机的部署。请记住，位置列表是动态填充的，具体取决于所选计划在整个Vultr云位置中的可用性-请参阅上面的步骤3。当前没有设置全局启动脚本的功能。

如何在配置选项中更新应用程序？

如果要列出所有可用的应用程序，则可以使用此API命令并将所需的应用程序添加到可配置选项中。自动同步在模块中不存在。