Revendeurs

Provisionner une instance

Provisionner une instance MaxiPBX

En tant que partenaire MaxiNetwork SA, vous gérez vos clients depuis le portail revendeur (ControlPlane). Cette page décrit le parcours complet : créer le client, créer l'instance PBX, déclarer les tenants et leurs licences, puis appliquer votre profil de marque.

Section réservée aux partenaires : l'accès au portail est protégé par authentification. Selon votre rôle, certaines actions peuvent être réservées à l'administrateur de la plateforme.

Concepts et hiérarchie

Le portail manipule quatre objets reliés entre eux :

Objet	Rôle
Partenaire (Partner)	Vous, le revendeur. Porte votre identité, votre e-mail de support et votre profil de marque actif.
Instance PBX (PBX Instance)	Un serveur PBX déployé (un domaine). Rattaché à un partenaire. Peut héberger plusieurs tenants.
Tenant (client final)	Un client/organisation hébergé sur une instance. Porte les licences et les fonctionnalités.
Profil de marque (Branding profile)	Votre charte (nom produit, couleurs, logo, coordonnées). Rattaché au partenaire, ou spécifique à une instance.

Une instance peut contenir plusieurs tenants. Les licences se gèrent au niveau du tenant, pas de l'instance.

Étape 1 — Créer le client (partenaire)

Dans le portail, ouvrez le panneau Clients / Partenaires puis créez un partenaire avec le formulaire dédié :

Champ	Type	Obligatoire	Détails
Nom (`name`)	Texte	Oui	Nom du client/partenaire affiché dans le portail.
Slug (`slug`)	Texte	Oui	Identifiant court technique (sans espaces), utilisé pour le rattachement et l'export de marque.
E-mail de support (`support_email`)	Texte	Non	Adresse de support associée au partenaire.

Validez avec Créer.

Étape 2 — Créer l'instance PBX

Ouvrez le panneau Instances PBX et créez l'instance :

Champ	Type	Obligatoire	Valeur par défaut	Détails
ID de l'instance (`id`)	Texte	Oui	—	Identifiant unique de l'instance.
Domaine (`domain`)	Texte	Oui	—	Nom de domaine du PBX (ex. `entreprise.maxipbx.ch`). C'est l'adresse que saisiront les utilisateurs dans les apps.
Partenaire (`partner_id`)	Liste	Oui	—	Le partenaire propriétaire de l'instance.
Nom (`name`)	Texte	Non	—	Libellé d'affichage de l'instance.
Environnement (`environment`)	Liste	Oui	`prod`	`prod`, `test` ou `dev`.
Canal (`channel`)	Liste	Oui	`stable`	Canal de version : `stable`, `beta` ou `dev`.
Politique de mise à jour (`update_policy`)	Liste	Oui	`notify`	`notify` (notifier), `manual` (manuelle) ou `scheduled` (planifiée).

Validez avec Créer PBX.

Créer l'instance dans le portail l'enregistre mais ne déclenche pas automatiquement le déploiement du serveur (voir l'étape Déploiement).

Étape 3 — Déclarer les tenants et les licences

Ouvrez le panneau Tenants & licences et créez un tenant par client final hébergé sur l'instance :

Champ	Type	Obligatoire	Valeur par défaut	Détails
Instance PBX (`pbx_instance_id`)	Liste	Oui	—	L'instance qui héberge ce tenant.
Nom du tenant (`name`)	Texte	Oui	—	Nom du client final.
UUID MaxiPBX (`wazo_tenant_uuid`)	Texte	Non	—	UUID du tenant côté MaxiPBX, pour la synchronisation.
Licences utilisateurs (`licensed_person_users`)	Nombre	Non	`0`	Nombre d'utilisateurs « personne » autorisés (minimum 0).

Validez avec Créer tenant.

Modèle de licences

Type d'utilisateur	Décompté ?
Personne (`person`)	Oui — compté dans le quota `licensed_person_users`.
Équipement (`equipment`)	Non — utilisateurs « matériel » (chambres d'hôtel, salles de réunion…), non décomptés.

Les compteurs used_person_users (utilisé) et equipment_users sont suivis par le portail. Un tenant peut aussi porter une date d'expiration et des fonctionnalités (entitlements) spécifiques. La mise à jour des compteurs de licence est une opération d'administration.

Étape 4 — Appliquer votre profil de marque

Créez ou sélectionnez un profil de marque rattaché à votre partenaire. Il peut être défini au niveau du partenaire (par défaut) ou spécifique à une instance. Le formulaire est organisé en sections :

Section	Champs principaux
Identité	Nom du produit (`product_name`), nom d'affichage de l'app (`app_display_name`), couleur primaire (`primary_color`), couleur secondaire (`secondary_color`).
Images	Logo, favicon, icône d'app (téléversement de fichier ou URL : `logo_url`, `favicon_url`, `app_icon_url`).
Support	E-mail de support (`support_email`), URL de support (`support_url`).
Identifiants d'app	ID d'app desktop (`desktop_app_id`) et identifiants mobiles.
Légal	URL de confidentialité (`privacy_url`), URL des conditions (`terms_url`), raison sociale, adresse.

Désignez ensuite le profil comme profil actif du partenaire (active_branding_profile_id) : il sert alors de marque par défaut pour les instances qui n'ont pas de profil spécifique.

Votre profil de marque alimente automatiquement l'interface web, les applications (desktop/mobile) et ce wiki. Les modifications (logo, couleurs, coordonnées, nom produit) se propagent sans rebuild.

Comment la marque est résolue

Lors du déploiement, le portail choisit le profil dans cet ordre :

Profil spécifique à l'instance, s'il existe ;
sinon, profil actif du partenaire ;
sinon, le dernier profil créé par le partenaire.

Étape 5 — Déployer l'instance

Le déploiement effectif du serveur PBX se fait via un travail d'installation (PBX install job), déclenché côté plateforme, et non automatiquement à la création de l'instance. Paramètres principaux :

Paramètre	Valeur par défaut	Détails
Domaine (`domain`)	—	Domaine du PBX à installer.
IP publique (`public_ip`)	—	Adresse IP publique du serveur cible.
Partenaire / Instance	—	Rattachement de l'installation.
Utilisateur SSH (`ssh_user`)	`root`	Compte SSH d'installation.
Port SSH (`ssh_port`)	`22`	Port SSH.
Environnement (`environment`)	`test`	`test` ou `prod`.
Canal (`channel`)	`beta`	`dev`, `beta` ou `stable`.

Le travail passe par les étapes : préparation de l'inventaire (avec injection des données de marque), exécution de la playbook Ansible, puis statut final installé ou échec (avec résumé d'erreur). Pendant le déploiement, l'état de santé de l'instance passe à « provisioning ».

Récapitulatif du parcours

Créer le partenaire (client).
Créer l'instance PBX (domaine, environnement, canal).
Déclarer les tenants et leurs licences.
Créer/activer le profil de marque.
Lancer le déploiement (travail d'installation Ansible).

Question sur le provisioning ou le déploiement ? Contactez support@maxipbx.ch.