Minor clarifications for Integration API documentation (integration_port and Traefik config examples)
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
- 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 👍
- 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
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di fosrl/docs
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 55/100
-
docs(kubernetes): add --devel for Pangolin Helm pre-release installsForse già presa @marcschaeferger l’ha presa 73 giorni fa. Aperta
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
-
Issue on docsAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
YahiaAngelo/vphone-linux#70 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
I maintainer di solito rispondono entro 3 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
FuRongJun-1999/dsh-memory#1000 ·
I maintainer di solito rispondono entro 1 giorno
-
curator: add zaherg/pi-sbxAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
ajeetraina/awesome-docker-sbx#561 ·
-
docs: reorder interface definition before fetch-libs and link PostgreSQL/library docs in tutorialAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
I maintainer di solito rispondono entro 3 giorni