Plugin Pterodactyl - Documentation BETA

Ce plugin permet de faire la liaison entre votre panel Pterodactyl et Jeedom que vous soyez un simple utilisateur ou un administrateur.

Pterodactyl est un manager de serveurs de jeux supportant actuellement:

• Minecraft — including Spigot, Sponge, Bungeecord, Waterfall, and more
• Rust
• Terraria
• Teamspeak
• Mumble
• Team Fortress 2
• Counter Strike: Global Offensive
• Garry’s Mod
• ARK: Survival Evolved

Comment ça marche

Nous utilisons l’API de Pterodactyl afin de récupérer les informations.
Jeedom va faire une demande pour lister la totalité des serveurs auxquels vous avez accès.
Ensuite une création automatique des équipements aura lieu sur la page des équipements.

Les informations requises

Pour faire cela nous aurons besoin de deux informations.

1 - La clef API a récupérer sur le panel (Voir étape suivante).

2 - Si vous êtes admin ou pas du panel (Accès à tous les serveurs ou uniquement les vôtres)

La clef API

Pour accéder à la clef API utilisateur vous devez aller dans votre profil Pterodactyl

Onglet API Credentials
Mettre une description (ici Jeedom)
Ensuite si vous le souhaitez, autorisez seulement votre Jeedom, (uniquement si IP FIXE et pas d’alias comme XXXX.eu.jeedom.link) dans notre cas nous ne l’utiliserons pas car pas utile.

Ajouter une instance

Une fois que vous avez récupéré les informations api, il faut ajouter votre instance.

Si vous êtes administrateur du panel, vous pouvez cocher Je suis admin afin de récupérer tous les serveurs et pas uniquement ceux qui vous appartiennent.

Synchronisation

Maintenant que vous voyez votre instance dans les équipements, il faut cliquer sur Synchronisation automatique, les serveurs sont alors récupérés et ajoutés automatiquement dans jeedom.

Vous verrez les serveurs avec au dessus l’instance qui lui est rattachée.

Affichage côté admin

Choisissez les paramètres classiques de catégorisation, affichage et objet.

Le choix du jeu permet de récupérer le nombre de joueurs en ligne / max. Pour le cas particulier de minecraft, il y a deux possibilités:

• Méthode classique, votre jeedom fait la requête. Choisir “Minecraft”
• Méthode alternative, une demande externe est faite via une demande au site Minecraft-Api, cela afin de passer certaines sécurité parfois présentes. Choisir “Minecraft (via API externe)”
  Si votre jeu n’est pas listé, il n’est surement pas disponible. N’hésitez pas à me le signaler sur le community jeedom, je vous confirmerais si c’est possible ou non.
  L’affichage de la console sur le dashboard vous donnera accès à la console temps réel comme dans pterodactyl.

Affichage côté dashboard

Remarques:

• La valeur d’utilisation du processeur est ramenée à 100%. En effet, les valeurs sont définies à l’origine par rapport au nombre de coeurs (6 coeurs = 600), donc si vous utilisez 60 / 600, le plugin affichera 10% d’utilisation CPU. Si aucune restriction CPU n’est définie, il a été enregistré un seuil automatique à 1000 pour avoir une gauge ni trop grande, ni trop limitée.
• L’API ne renvoi jamais le retour de votre commande, comme le fait la console du panel, vérifiez bien la syntaxe avant envoi. Si vous activez la tuile pour la console vous aurez le retour dans celle-ci.
• Sur la console, lorsque vous voyez un message comme quoi la connexion est rétablie, c’est normal, toutes les 10 minutes environ jeedom doit redemander un accès à la console.
• Lorsque vous désactivez une instance, cela désactive les serveurs liés. De même pour la suppression, les serveurs sont eux aussi supprimés.

FAQ

• Je n’ai pas de retour console, que se passe t’il?

  La cause la plus probable est un refus de la part de Wings. En effet par défaut aucun accès n’est autorisé. Voici la marche à suivre:

  Ouvrez /etc/pterodactyl/config.yml et cherchez allowed_origins tout en bas:
  
  J’ai mis une étoile pour les tests, ce qui autorise tout. il est préférable de n’autoriser que votre domaine jeedom. ça peut etre votre domaine XXXXXX.eu.jeedom.link ou tout autre domaine que vous auriez mis en place pour votre jeedom. Se référer à la documentation pterodactyl/wings pour plus d’infos.
  Relancez wings avec la commande sudo systemctl restart wings

• J’ai bien mis minecraft en jeu dans la configuration pour avoir le nombre de joueurs, mais ça ne fonctionne pas. Pourquoi?

  Il faut mettre votre plugin en debug dans la configuration. Vous aurez plus de détails sur ce qui se passe.

  Comme on utilise un site tiers pour récupérer les infos, il est vivement conseillé de mettre l’adresse que les joueurs rentrent dans le jeu en IP alias (dans le panel Pterodactyl) pour que ce site puisse lui aussi s’y connecter.
  
  Dans l’administration Pterodactyl, menu management => nodes. Cliquez sur le node concerné et Allocation, vous tomberez sur le menu ci-dessus.

• Pour toutes autres questions, merci de vérifier si la question n’a pas été posée sur le community => https://community.jeedom.com/tag/plugin-pterodactyl. Si ce n’est pas le cas, n’hésitez pas à demander de l’aide.