Skip to content

Document refused agent file URLs and publicOrigin when base_url is blank #15

Closed

Description

@joeldickson

ShipLean/ShipLean#30 changed what happens behind a gateway when base_url is blank and the host resolves to a cluster service name (*.svc). The product's docs/mcp.md and docs/auth.md were updated, but the site wasn't.

agents/tools.mdx:249 says ShipLean ignores cluster service names and "otherwise, it uses the request host and scheme". That no longer tells the whole story.

What the site should say

  • attach_file without base64, and read_attachment download URLs, now fail rather than return a URL a laptop can't open. The upload error tells the agent to send base64.
  • open_url still uses that host until base_url is set.
  • /health reports publicOrigin as unknown: set base_url, and the instance settings General tab says the same.
  • One warning per process names the cause: no X-Forwarded-Host, the peer isn't in SHIPLEAN_TRUSTED_PROXIES, or the forwarded host is itself *.svc.
  • The fix is to set base_url, or to trust the gateway and have it send X-Forwarded-Host and X-Forwarded-Proto.

Pages to update

  • agents/tools.mdx, under Attachment transfer URLs.
  • start/production.mdx and ui/instance.mdx: the General tab note.
  • reference/api.mdx: publicOrigin on /health. The field isn't mentioned anywhere on the site.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions