Aller au contenu

Obtenir de l'aide

Pour débuter

Rassemblez les bons détails une seule fois, masquez ce qui est privé, et posez votre question au bon endroit.

  1. Lisez Dépannage pour votre symptôme.
  2. Lancez le diagnostic (doctor) : docker exec holyarrs /holyarrs doctor. Corrigez chaque ligne FAIL qu’il explique.

Récupérer une archive de diagnostic

Lien vers Récupérer une archive de diagnostic

Une archive de diagnostic est un seul zip avec ce qu’une personne qui vous aide demande en premier. Les propriétaires et les administrateurs peuvent la télécharger.

  1. Ouvrez la page /health.
  2. Appuyez sur Download support bundle (télécharger l’archive de diagnostic). Vous devriez obtenir un fichier .zip.
Fichier Contient
log.txt Le journal le plus récent, sans les clés, les jetons ni les mots de passe.
about.json La version et les détails de la configuration.
doctor.txt Le rapport du diagnostic.
health.json Les résultats actuels des contrôles de santé.

Si vous ne pouvez pas ouvrir la page web, envoyez à la place la sortie du diagnostic et les 100 dernières lignes du journal : docker logs --tail 100 holyarrs.

Masquer ce qui est privé

Lien vers Masquer ce qui est privé

Les secrets sont retirés, mais l’archive peut encore montrer des chemins de dossier et des noms d’hôte. Avant de publier quoi que ce soit :

  • Remplacez les noms d’hôte, les domaines et les adresses IP publiques par example.
  • Supprimez les noms de dossier que vous ne voulez pas rendre publics, comme votre nom dans un chemin.
  • Ne publiez jamais holyarrs.key, une clé API, un mot de passe ou un fichier Compose qui contient des secrets.
Endroit À utiliser pour
Discord Les questions et l’aide à la configuration.
GitHub Issues Les bugs que vous pouvez reproduire.
r/HolyArrs Les idées.

Dans votre message, dites ce que vous avez fait, ce que vous attendiez et ce qui s’est passé. Joignez l’archive, ou collez la sortie du diagnostic.

Récupérer l'archive par l'API

GET /api/v1/support/bundle, avec une clé de propriétaire ou d’administrateur qui a la portée admin, envoyée dans X-Api-Key, renvoie le même zip.

HolyArrs est gratuit. S'il vous a fait gagner du temps, mettez-lui une étoile sur GitHub, sponsorisez-le ou offrez-moi un café.