Minor clarifications for Integration API documentation (integration_port and Traefik config examples)

Ouverte
#70 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

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

  1. 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.

  1. 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.

  1. 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.

  1. 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

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de fosrl/docs

Toutes les issues de fosrl/docs

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.