Vultr WHMCS Module

• Informations sur le module
• introduction
• Configuration requise
• Conditions préalables
• Limites
• Portée
• Caractéristiques du module
• Création d'une clé API
• Installation
• Première configuration
• Configuration du module
• Processus de commande
• FAQ

Remarque : Veuillez lire ce document dans son intégralité avant d'installer le module WHMCS Vultr

Informations sur le module

• Version: 2.0.0 (mise à jour)
• Date de sortie: 25 juin 2019
• Changelog
• Veuillez soumettre tout rapport de problème / bogue au référentiel github Vultr WHMCS officiel

introduction

La plateforme Vultr propose une API puissante et riche en fonctionnalités qui permet aux utilisateurs de contrôler tous les aspects de leur compte. Le module Vultr WHMCS fournit aux hébergeurs une solution entièrement automatisée qui leur permet d'offrir à leurs clients des serveurs cloud fiables sur la plateforme Vultr.

Remarque: La version actuelle du module est une réécriture complète du module d'origine, mais est compatible avec les produits Vultr existants dans WHMCS.

Configuration requise

• WHMCS version 7.2.x ou plus récente
• PHP version 7.1.x ou plus récente
• MySQL  5.6 , MariaDB  5.6 , MariaDB  10.0 ou MariaDB  10.1 .
• ionCube Loader.

Conditions préalables

• Clé API Vultr
• Vos adresses IP de serveur WHMCS sur liste blanche pour l'accès à l'API

Remarques

• Vous devez ajouter à la liste blanche les adresses IPv4 et IPv6 de votre serveur WHMCS pour l'accès à l'API
  • Si votre serveur possède plusieurs adresses IPv4, vous pouvez les mettre en liste blanche individuellement ou mettre en liste blanche l'ensemble du sous-réseau.
  • Si votre serveur a une adresse IPv6, il est préférable de mettre en liste blanche l'ensemble du sous-réseau / 64
• WHMCS version 6 n'est pas pris en charge en raison de la fin de vie.
• PHP version 7.0.x n'est pas pris en charge en raison de la fin de vie.
• Il n'est pas prévu de prendre en charge les anciennes versions de WHMCS et PHP.
• Vous devez utiliser les options configurables générées par le module pour les produits. La création de la vôtre entraînera probablement un conflit.

Limites

Vous trouverez ci-dessous la liste des options que le module n'inclut pas par conception.

1. Ajoutez des adresses IPv4 supplémentaires.
2. Activez la mise en réseau privée après le déploiement d'une machine virtuelle.
3. Basculer entre le système d'exploitation et les applications.
4. Basculer entre Linux et Windows.

Portée

Ce document couvrira le processus d'installation et de configuration du module WHMCS Vultr officiel. Les modules téléchargés à partir de sites Web tiers ne sont pas pris en charge par Vultr.

Caractéristiques du module

• Création en un clic de produits VPS basés sur Vultr
  • Vous devrez définir manuellement le prix de chaque produit et option configurable.
• Déployer et mettre à niveau des machines virtuelles
• Fonction marche / arrêt / cycle
• Console HTML5 VNC
• Contrôle rDNS
• Réseautage privé
• Scripts de démarrage
• Clés SSH
• Contrôle des instantanés
• Déployer des machines virtuelles à partir d'une liste d'ISO prédéfinies
• Déployer des machines virtuelles à partir d'une liste d'instantanés prédéfinis
• Activer / désactiver des ISO et des instantanés spécifiques pour les déploiements de VM
• Activer / désactiver les emplacements de déploiement
• Prise en charge de Vultr DNS avec Vanity DNS (serveur de noms personnalisé)

Création d'une clé API

1. Connectez-vous à la zone client Vultr.
2. Cliquez sur Compte.
3. Cliquez sur API.
4. Cliquez sur Activer l'API.
5. Mettez en liste blanche les adresses IP de votre serveur WHMCS sous contrôle d'accès.

Installation

La première étape consiste à télécharger le module Vultr WHMCS ici

Nouvelle installation

1. Extrayez l'archive ZIP.
2. Téléchargez les fichiers de module sur votre serveur WHMCS en suivant la hiérarchie de répertoires définie ci-dessous

Mettre à niveau une ancienne version du module

1. Sauvegardez votre base de données et vos fichiers
2. Supprimez complètement les répertoires modules/addons/vultret modules/servers/vultr.
3. Extrayez et téléchargez le nouveau module.

Hiérarchie des répertoires

Archive téléchargée

• Modules
  • extensions
    • vultr
  • les serveurs
    • vultr

Première configuration

1. Téléchargez le module comme indiqué ci-dessus
2. Connectez-vous à votre panneau d'administration WHMCS et accédez à Setup -> Addon Modules.
3. À côté de Vultr Module, cliquez sur le Configurebouton.
4. Cochez la case à côté de Hooks Enabled.
5. Saisissez votre clé API dans le API Keychamp.
6. Configuration Access Controlpour Administratoret autres rôles pour lesquels vous souhaitez l'activer.
7. Cliquez sur Save Changes
8. Connectez-vous à votre panneau d'administration WHMCS et accédez à Addons -> Vultr Modulepour configurer les options de votre module présentées dans la section suivante de ce document

Configuration du module

Cette section de la documentation présentera toutes les options de configuration disponibles pour le module, expliquera comment elles fonctionnent et comment les configurer.

Créateur de produit

Cette section vous permettra de créer un produit basé sur Vultr dans WHMCS. Il existe deux modes, Single Product Creatoret Multiple Product Creator.

Le Single Product Creatormode vous permettra de créer un produit basé sur les packages Vultr disponibles, de sélectionner un groupe de produits et la tarification du produit que vous ajoutez. Le prix des options configurables telles que les instantanés, Windows, les applications cPanel, etc. doit être ajouté manuellement aux options configurables du produit.

Le Multi Product Creatorva créer en masse des packages VPS basés sur Vultr dans votre WHMCS, mais vous devrez configurer manuellement la tarification de chaque package ainsi que la tarification des options configurables, similaire au Single Product Creatormode.

Des produits

Cette section affichera une liste complète de tous vos produits basés sur Vultr dans WHMCS et vous permettra de naviguer rapidement vers le Editou la Configurable Options page de chacun. Vous pouvez également supprimer un produit de cette page. Cette section est très utile lorsque vous souhaitez trouver rapidement un produit Vultr dans votre zone d'administration WHMCS pour le modifier ou modifier les options configurables pour celui-ci.

DNS

Le module WHMCS Vultr prend en charge les serveurs de noms personnalisés (ns1 et ns2.domain.com personnalisés). La configuration de Vanity Nameservers nécessite une première étape, qui consiste à créer les serveurs de noms personnalisés avec votre registraire de domaine et à les pointer vers les adresses IP ns1.vultr.comet à les ns2.vultr.comrésoudre. Une fois terminé, veuillez suivre les étapes ci-dessous:

1. Connectez-vous à votre panneau d'administration WHMCS.
2. Continuez Addons -> Vultr Module.
3. Cliquez sur DNS.
4. Ajoutez les valeurs pour Nameserver 1et Nameserver 2et cliquez sur Save Changes.
5. Vous avez terminé.

Veuillez noter que les serveurs de noms Vanity sont appliqués aux zones / domaines DNS nouvellement ajoutés. Les versions existantes devront être modifiées manuellement sur https://my.vultr.com.

Emplacement du serveur

Vous avez la possibilité d'activer et de désactiver certains emplacements cloud, permettant ainsi à vos clients de déployer des machines virtuelles uniquement dans les emplacements que vous choisissez. Veuillez garder à l'esprit que la sélection de l'emplacement du cloud pendant le processus de commande n'est pas possible car les emplacements sont chargés dynamiquement en fonction de l'endroit où le package sélectionné est disponible au moment du déploiement.

Afin de sélectionner les emplacements à activer pour vos clients, veuillez suivre les étapes ci-dessous:

1. Connectez-vous à votre panneau d'administration WHMCS.
2. Continuez Addons -> Vultr Module.
3. Cliquez sur Server Location.
4. Cliquez sur le Enabledbouton pour désactiver les emplacements que vous souhaitez désactiver (en cliquant sur le bouton quand il est dit Disabledréactiver l'emplacement).
5. Vous avez terminé.

Instantanés

Le module Vultr WHMCS vous permet de créer un ou plusieurs instantanés sur votre compte Public, ce qui signifie que vous autoriseriez vos clients à déployer de nouvelles machines virtuelles à partir de ces instantanés s’ils le souhaitent. Tous les instantanés de votre compte sont définis Disabled par défaut dans le module et vous devez les activer.

Afin de sélectionner les instantanés à rendre publics pour vos clients, veuillez suivre les étapes ci-dessous:

1. Connectez-vous à votre panneau d'administration WHMCS.
2. Continuez Addons -> Vultr Module.
3. Cliquez sur Snapshots.
4. Cliquez sur le Disabledbouton pour Enabledactiver les instantanés que vous souhaitez rendre publics (en cliquant sur le bouton quand il est dit, cela réactivera l'instantané).
5. Vous avez terminé.

ISO

Semblable à la fonction d'instantané, vous pouvez créer un ou plusieurs ISO téléchargés personnalisés sur votre compte Public, ce qui signifie que vous autoriseriez vos clients à déployer de nouvelles machines virtuelles à partir de ces ISO s'ils le souhaitent. Tous les ISO de votre compte sont définis Disabled par défaut dans le module et vous devez les activer.

Afin de sélectionner les instantanés à rendre publics pour vos clients, veuillez suivre les étapes ci-dessous:

1. Connectez-vous à votre panneau d'administration WHMCS.
2. Continuez Addons -> Vultr Module.
3. Cliquez sur ISO.
4. Cliquez sur le Disabledbouton pour Enabledactiver les ISO que vous souhaitez rendre publics (en cliquant sur le bouton quand il est dit , réactiver l'ISO).
5. Vous avez terminé.

Processus de commande

La commande de produits basés sur Vultr dans WHMCS est un processus en trois étapes.

Étape 1

Commandes client dans la zone client / panier WHMCS: Le client passera une commande pour une machine virtuelle. Il leur sera demandé de saisir:

• Nom d'hôte
• Mot de passe root
• NS1 & NS2

Il s'agit du bon de commande WHMCS standard et Vultr n'a aucun contrôle sur. Vous êtes invités à modifier votre modèle de formulaire de commande WHMCS pour masquer l'une de ces options. Veuillez garder à l'esprit que le mot de passe root sélectionné dans la commande pour ne sera pas utilisé car l'API de Vultr générera un mot de passe sécurisé aléatoire pour chaque machine virtuelle. De plus, si un client se déploie à partir d'un instantané, il devra connaître le mot de passe racine pour l'instantané au préalable, sinon il ne pourra pas se connecter.

De plus, le client sera invité à choisir d'activer ou non les sauvegardes automatiques, la limite d'instantané et le type de système d'exploitation.

En ce qui concerne le type de système d'exploitation, il y a 4 options dans le menu déroulant affiché sous OS Typedans le formulaire de commande

1. Une liste de toutes les images de système d'exploitation disponibles
2. ISO
3. Instantané
4. Application

La sélection Applicationactivera une liste de toutes les offres Vultr disponibles pour One-Click Apps. L'ISO et l'instantané permettront au client de sélectionner l'ISO ou l'instantané à partir duquel déployer la machine virtuelle.

Étape 2

L'administrateur approuverait la commande et fournirait le service dans WHMCS (ou vous pouvez choisir d'en faire un processus automatisé dans l'option de produit dans WHMCS de la même manière que tout autre produit dans WHMCS.

Étape 3

Le client devrait finaliser le processus de commande dans la zone client en choisissant un Lable / Pseudo pour son serveur, un nom d'hôte et d'autres options telles que la clé SSH, IPv6, le réseau privé ou le script de démarrage.

FAQ

J'ai reçu une erreur concernant l'échec de la connexion.

Assurez-vous que votre clé API n'est pas préfixée ou suffixée avec un espace blanc et que les adresses IPv4 et IPv6 de votre serveur sont toutes deux sur liste blanche pour l'accès API. Vous pouvez vérifier vos règles API dans la zone membres .

Si les règles de clé et d'ACL sont correctes, vous pouvez tester davantage votre clé en vous connectant à votre serveur WHMCS et en exécutant des appels d'API directs à l'aide de cURL. Des exemples cURL sont fournis dans notre section d'exemples d'API .

Comment spécifier un script de démarrage standard via le système de configuration automatique?

Comme indiqué, le client devrait finaliser le déploiement de la machine virtuelle dans la zone client après avoir personnalisé ses options à son goût. Veuillez garder à l'esprit que la liste des emplacements est remplie dynamiquement en fonction de la disponibilité du plan sélectionné sur les emplacements cloud de Vultr - voir l'étape 3 ci-dessus. Il n'existe actuellement aucune fonction pour configurer un script de démarrage global.

Comment mettre à jour les applications dans les options de configuration?

Si vous souhaitez répertorier toutes les applications disponibles, vous pouvez utiliser cette commande API et ajouter les applications souhaitées dans les options configurables. La synchronisation automatique n'existe pas dans le module.