Minor clarifications for Integration API documentation (integration_port and Traefik config examples)
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 45/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Domaine
- documentation
Piste de recherche
Ouvrez la documentation de l’Integration API sur la page liée et examinez les exemples de integration_port et de Traefik YAML. Précisez si integration_port est obligatoire ou s’il vaut 3003 par défaut, expliquez l’utilisation des guillemets et tenez compte de la note sur l’indentation ; le travail est terminé lorsque les instructions de configuration sont sans ambiguïté.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Body
While setting up the Integration API following the documentation, I noticed a few small points that might benefit from clarification.
Documentation reference:
https://docs.pangolin.net/self-host/advanced/integration-api
- integration_port seems required
The documentation shows:
server:
integration_port: 3003 # Specify different port
The comment suggests that this only needs to be set when using a port different from 3003.
However, during setup the Integration API did not appear to start unless integration_port was explicitly defined. It might help to clarify whether:
this field is required, or
it is optional and defaults internally to 3003.
If it is required, the comment could be slightly misleading.
- Quotes in Traefik rule
The example uses:
rule: "Host(api.example.com)"
In YAML this also works without quotes:
rule: Host(api.example.com)
It might be worth mentioning whether the quotes are recommended or simply optional.
- Quotes in service URL
Similarly, the example shows:
servers:
- url: "http://pangolin:3003"
This usually works without quotes as well:
servers:
- url: http://pangolin:3003
Clarifying whether quotes are intentional or just stylistic could help avoid confusion.
- Minor YAML note (optional suggestion)
A small note reminding users that YAML is indentation-sensitive might help prevent copy/paste errors when applying the config snippets.
Thanks for the great project and documentation 👍
- Langage dominant
- MDX
- Étoiles
- 14
- Forks
- 55
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de fosrl/docs
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 55/100
-
docs(kubernetes): add --devel for Pangolin Helm pre-release installsPeut-être pris @marcschaeferger l’a pris il y a 73 jours. Ouverte
-
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
-
Issue on docsOuverte
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
Toutes les issues de fosrl/docs
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
YahiaAngelo/vphone-linux#70 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 80/100
FuRongJun-1999/dsh-memory#1000 ·
Les mainteneurs répondent en général sous 1 jour
-
curator: add zaherg/pi-sbxOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
ajeetraina/awesome-docker-sbx#561 ·
-
docs: reorder interface definition before fetch-libs and link PostgreSQL/library docs in tutorialOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
Les mainteneurs répondent en général sous 3 jours