docs: GitHub App webhook/setup/callback URLs use the API host, not the frontend

[isiddharthsingh]

Follow-up to #506.

The GitHub App Webhook URL, Setup URL, and Callback URL are backend routes (/github/* on the Flask server, port 5080). GitHub posts to them directly, the Next.js frontend does not proxy /github/*, and the default Helm ingress puts the backend on a separate api.<domain> host. Pointing them at the frontend base URL silently 404s webhooks.

• Webhook / Setup / Callback URLs → <API_URL> (the ingress.hosts.api host, or a tunnel to port 5080 in local dev)
• Homepage URL + verification + OAuth homepage → <FRONTEND_URL>
• Added an admonition explaining why these use the API host

Docs-only; no code changes.

Summary by CodeRabbit

Documentation

• Clarified GitHub connector setup URLs by separating frontend and backend host usage (homepage uses the frontend URL; webhook/setup/callback routes use the API host).
• Updated the “Organization-owned app” setup table and added an important note about correct URL routing.
• Revised GitHub app environment variable instructions to reference API-host endpoints for webhook/setup URLs.
• Adjusted verification and on-prem OAuth fallback example URLs to use the frontend host.

[coderabbitai]

Walkthrough

The GitHub connector documentation and environment setup examples replace the single <BASE_URL> placeholder with explicit <FRONTEND_URL> and <API_URL> placeholders across the Organization-owned app field table, .env.example guidance, Step 4 env vars, the verification step, and the OAuth fallback homepage example.

Changes

GitHub Connector URL Host Clarification

Layer / File(s)	Summary
App registration table and routing admonition website/docs/integrations/connectors.md	The Organization-owned app field table updates Homepage to <FRONTEND_URL> and callback/setup/webhook URLs to <API_URL>. A new admonition block explains that GitHub's webhook/setup/callback routes must point to the backend API host because the Next.js frontend does not proxy /github/* paths.
Environment setup, env vars, verification, and OAuth fallback .env.example, website/docs/integrations/connectors.md	The .env.example GitHub App setup comment block is updated to clarify that webhook/setup URLs are backend routes requiring the API host or tunnel. Step 4 env var examples for GITHUB_APP_WEBHOOK_URL and GITHUB_APP_SETUP_URL now reference <API_URL> instead of <BASE_URL>. The verification step and the OAuth fallback path (Path B) homepage example are updated from <BASE_URL> to <FRONTEND_URL>.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Arvo-AI/aurora#371: Documentation and environment variable updates for GitHub App auth that introduces and documents the same GITHUB_APP_WEBHOOK_URL and GITHUB_APP_SETUP_URL env vars with backend host clarification.

Suggested reviewers

• OlivierTrudeau

Poem

A bunny hopped through docs one day,
Found BASE_URL leading things astray.
"Frontend here, API there!"
Split the URLs with floppy-eared care.
Now webhooks find the backend right,
And homepages shine in frontend light! 🐇✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: clarifying that GitHub App webhook, setup, and callback URLs should use the API host rather than the frontend URL. It directly matches the primary purpose outlined in the PR objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch sms10221/dev-1252-github-app-doc-url-fix

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.env.example:
- Around line 239-240: The environment variables in the .env.example file are
not ordered alphabetically. Reorder the lines containing GITHUB_APP_CLIENT_ID
and GITHUB_APP_ID so that GITHUB_APP_CLIENT_ID appears before GITHUB_APP_ID,
following alphabetical ordering conventions as expected by dotenv-linter.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9b4c4aae-6f5f-4aea-9f3f-42d254d78ac8

📥 Commits

Reviewing files that changed from the base of the PR and between 2eb6dfb and 7d541a3.

📒 Files selected for processing (1)

• .env.example

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud