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

未关闭
#70 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
45/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
领域
documentation

调研方向

打开链接页面中的 Integration API 文档,并检查 integration_port 和 Traefik YAML 示例。明确 integration_port 是必需的,还是默认为 3003,解释引号的用法,并考虑缩进说明;当设置指南明确无歧义时,即视为完成。

由索引模型根据 Issue 内容生成。

描述

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 👍

主要语言
MDX
星标
14
派生
55
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

fosrl/docs 的其他 Issue

查看 fosrl/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。