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 Loader。

前提条件

• Vultr APIキー
• APIアクセス用のホワイトリストに登録されているWHMCSサーバーIP

ノート

• APIアクセス用にWHMCSサーバーのIPv4およびIPv6アドレスをホワイトリストに登録する必要があります
  • サーバーに複数のIPv4アドレスがある場合、個別にホワイトリストに登録するか、サブネット全体をホワイトリストに登録できます。
  • サーバーにIPv6アドレスがある場合は、/ 64サブネット全体をホワイトリストに登録することをお勧めします
• サポート終了に達したため、WHMCSバージョン6はサポートされていません。
• PHPバージョン7.0.xは、サポートが終了したためサポートされていません。
• 古いバージョンのWHMCSおよびPHPをサポートする予定はありません。
• 製品のモジュールによって生成された構成可能オプションを使用する必要があります。独自に作成すると、競合が発生する可能性があります。

制限事項

以下は、モジュールが意図的に含まないオプションのリストです。

1. 追加のIPv4アドレスを追加します。
2. 仮想マシンの展開後にプライベートネットワークを有効にします。
3. OSとアプリの切り替え。
4. LinuxとWindowsの切り替え。

範囲

このドキュメントでは、公式のVultr WHMCSモジュールのインストールと構成のプロセスについて説明します。サードパーティのWebサイトからダウンロードしたモジュールはVultrでサポートされていません。

モジュールの機能

• Vultrに基づくVPS製品のワンクリック作成
  • 各製品と構成可能なオプションの価格を手動で設定する必要があります。
• 仮想マシンの導入とアップグレード
• 電源オン/オフ/サイクル機能
• HTML5 VNCコンソール
• rDNS制御
• プライベートネットワーキング
• 起動スクリプト
• SSHキー
• スナップショットコントロール
• 事前定義されたISOのリストからVMをデプロイする
• 事前定義されたスナップショットのリストからVMをデプロイする
• VMデプロイメントの特定のISOとスナップショットを有効/無効にする
• 展開場所の有効化/無効化
• バニティDNS（カスタムネームサーバー）をサポートするVultr 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. 新しいモジュールを抽出してアップロードします。

ディレクトリ階層

ダウンロードしたアーカイブ

• モジュール
  • アドオン
    • ブルター
  • サーバー
    • ブルター

最初のセットアップ

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ベースの製品を作成できます。との2つのモードがSingle Product CreatorありMultiple Product Creatorます。

このSingle Product Creatorモードでは、利用可能なVultrパッケージに基づいて製品を作成し、製品グループを選択し、追加する製品の価格を設定できます。スナップショット、Windows、cPanelアプリなどの設定可能なオプションの価格は、製品の設定可能なオプションに手動で追加する必要があります。

Multi Product Creator意志のあなたのWHMCSにVultrベースのVPSパッケージを一括で作成していますが、手動でセットアップする各パッケージの価格設定などに似た設定可能なオプションのための価格設定がありますSingle Product Creatorモード。

製品

このセクションでは、WHMCS内のVultrベースのすべての製品の完全なリストを表示し、各製品EditのConfigurable Options ページまたはページにすばやく移動できるようにします。そのページから製品を削除することもできます。このセクションは、WHMCS管理エリアでVultr製品をすばやく見つけて変更したり、構成可能なオプションを変更したりする場合に非常に役立ちます。

DNS

Vultr WHMCSモジュールは、バニティネームサーバー（カスタムns1およびns2.domain.com）をサポートしています。バニティネームサーバを設定すると、ドメインレジストラでカスタムネームサーバを作成して、IPアドレスにそれらを指すようである第一のステップ、必要とns1.vultr.comしてns2.vultr.comに解決されます。完了したら、次の手順に従ってください：

1. WHMCS管理パネルにログインします。
2. 続けてAddons -> Vultr Module。
3. をクリックしDNSます。
4. Nameserver 1およびの値を追加して、Nameserver 2をクリックしますSave Changes。
5. 完了です。

バニティネームサーバーは、新しく追加されたDNSゾーン/ドメインに適用されることに注意してください。既存のものはhttps://my.vultr.comで手動で変更する必要があります。

サーバーの場所

特定のクラウドの場所を有効または無効にするオプションがあるため、顧客は選択した場所にのみ仮想マシンを展開できます。配置時に選択したパッケージが利用可能な場所に応じて場所が動的に読み込まれるため、注文プロセス中にクラウドの場所を選択することはできないことに注意してください。

顧客に対して有効にする場所を選択するには、以下の手順に従ってください：

1. WHMCS管理パネルにログインします。
2. 続けてAddons -> Vultr Module。
3. をクリックしServer Locationます。
4. Enabledボタンをクリックして、無効にする場所を無効にします（場所をDisabled再度有効にするというボタンをクリックすると、無効になります）。
5. 完了です。

スナップショット

Vultr WHMCSモジュールを使用すると、アカウントで1つ以上のスナップショットを作成できます。Publicつまり、顧客がそうしたい場合は、これらのスナップショットから新しい仮想マシンを展開できます。アカウントのすべてのスナップショットは、Disabled デフォルトでモジュールに設定されており、有効にする必要があります。

顧客に公開するスナップショットを選択するには、以下の手順に従ってください：

1. WHMCS管理パネルにログインします。
2. 続けてAddons -> Vultr Module。
3. をクリックしSnapshotsます。
4. Disabledボタンをクリックして、公開するスナップショットを有効にします（Enabledスナップショットが再度有効になると表示されているときにボタンをクリックします）。
5. 完了です。

ISO

スナップショット機能と同様に、アカウントに1つ以上のカスタムアップロードISOを作成Publicできます。つまり、顧客が選択した場合、これらのISOから新しい仮想マシンを展開できるようになります。アカウントのすべてのISOは、Disabled デフォルトでモジュールに設定されており、有効にする必要があります。

顧客に公開するスナップショットを選択するには、以下の手順に従ってください：

1. WHMCS管理パネルにログインします。
2. 続けてAddons -> Vultr Module。
3. をクリックしISOます。
4. Disabledボタンをクリックして、公開するISOを有効にします（EnabledISOが再度有効になると表示されているときにボタンをクリックします）。
5. 完了です。

注文プロセス

WHMCSでのVultrベースの製品の注文は、3ステップのプロセスです。

ステップ1

WHMCSクライアントエリア/カートでのクライアント注文：クライアントが仮想マシンを注文します。彼らは入力するように求められます：

• ホスト名
• ルートパスワード
• NS1＆NS2

これは標準のWHMCS注文フォームであり、Vultrが管理することはありません。WHMCS Order Formテンプレートを変更して、これらのオプションを非表示にすることもできます。VultrのAPIはVMごとにランダムで安全なパスワードを生成するため、注文で選択したルートパスワードは使用されないことに注意してください。さらに、クライアントがスナップショットから展開する場合、事前にスナップショットのrootパスワードを知っている必要があります。そうしないと、ログインできなくなります。

さらに、クライアントは、自動バックアップ、スナップショット制限、およびOSタイプを有効にするかどうかを選択するように求められます。

OSタイプに関しては、注文フォームの下に表示されるドロップダウンメニューに4つのオプションがありOS Typeます。

1. 利用可能なすべてのOSイメージのリスト
2. ISO
3. スナップショット
4. 応用

選択するApplicationと、利用可能なすべてのワンクリックアプリVultrオファーのリストが有効になります。ISOとスナップショットを使用すると、仮想マシンの展開元のISOまたはスナップショットを選択できます。

ステップ2

管理者は注文を承認し、サービスをWHMCSでプロビジョニングします（または、HMMCSの他の製品と同じ方法で、WHMCSの製品オプションで自動プロセスを選択することができます。

ステップ3

お客様は、サーバーのラベル/ニックネーム、ホスト名、およびSSHキー、IPv6、プライベートネットワーク、起動スクリプトなどの他のオプションを選択して、クライアント領域で注文プロセスを完了する必要があります。

よくある質問

接続の失敗に関するエラーを受け取りました。

APIキーの前または後にスペースが付いていないこと、およびサーバーのIPv4アドレスとIPv6アドレスの両方がAPIアクセス用にホワイトリストに登録されていることを確認してください。メンバーエリアで APIルールを確認できます。

キーとACLルールが正しい場合は、WHMCSサーバーにログインし、cURLを使用して直接API呼び出しを実行することにより、キーをさらにテストできます。cURLの例は、APIの例のセクションに記載されています。

自動セットアップシステムを介して標準の起動スクリプトを指定するにはどうすればよいですか？

前述のように、お客様は、オプションを好みに合わせてカスタマイズした後、クライアント領域での仮想マシンの展開を完了する必要があります。ロケーションのリストは、Vultrのクラウドロケーション全体で選択したプランの可用性に応じて動的に入力されることに注意してください-上記のステップ3を参照してください。現在、グローバル起動スクリプトを設定する機能はありません。

構成オプションでアプリケーションを更新するにはどうすればよいですか？

使用可能なすべてのアプリケーションを一覧表示する場合は、このAPIコマンドを使用して、構成可能なオプションに必要なアプリケーションを追加できます。モジュールには自動同期はありません。