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

Abierto
#70 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado

Línea de trabajo

Abre la documentación de Integration API en la página enlazada y revisa los ejemplos de integration_port y Traefik YAML. Aclara si integration_port es obligatorio o tiene 3003 como valor predeterminado, explica el uso de las comillas y considera la nota sobre la indentación; se considera terminado cuando las instrucciones de configuración sean inequívocas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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 👍

Lenguaje dominante
MDX
Estrellas
14
Forks
55
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de fosrl/docs

Todos los issues de fosrl/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.