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

Aperta
#70 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Apri la documentazione di Integration API nella pagina collegata e esamina gli esempi di integration_port e Traefik YAML. Chiarisci se integration_port è obbligatorio o se il valore predefinito è 3003, spiega l’uso delle virgolette e considera la nota sull’indentazione; il lavoro è concluso quando le istruzioni di configurazione non sono ambigue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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 👍

Lingua principale
MDX
Stelle
14
Fork
55
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di fosrl/docs

Tutte le issue di fosrl/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.