feat: Add support for GHE / Data Residency and GHES by mbianchidev · Pull Request #480 · github-community-projects/private-mirrors

mbianchidev · 2026-05-28T15:59:40Z

This pull request adds comprehensive support for GitHub Enterprise Cloud with Data Residency (GHE.com) and GitHub Enterprise Server (GHES) by introducing new environment variables for custom GitHub URLs and committer email domains. It updates the authentication, webhook relay, and UI code to use these configurable endpoints throughout the application. Additionally, the documentation is updated to guide users on integrating with GHE.com and GHES, and some default behaviors and chunk sizes are improved.

Support for GitHub Enterprise (GHE.com/Server) configuration:

Added new environment variables (GITHUB_SERVER_URL, GITHUB_API_URL, GITHUB_GRAPHQL_URL, GITHUB_USER_EMAIL_DOMAIN) with sensible defaults and documentation to enable seamless integration with GHE.com and GHES instances. (.env.example, env.mjs, README.md, docs/developing.md)
Updated authentication logic to use the configured GitHub endpoints for OAuth flows, token refresh, user info, and organization membership checks, ensuring compatibility with custom GitHub deployments. (src/app/api/auth/lib/nextauth-options.ts)

Webhook relay and API usage improvements:

Updated the webhook relay script to use the configured GitHub API base URL and improved handling of environment variables, making it compatible with GHE.com/GHES and more robust in local and Docker environments. (scripts/webhook-relay.mjs)

UI and context updates for custom GitHub URLs:

Modified UI components to use the configured GitHub server URL for all links to repositories and forks, ensuring correct navigation regardless of the GitHub environment. (src/app/[organizationId]/page.tsx, src/app/components/dialog/CreateMirrorDialog.tsx, src/app/components/dialog/EditMirrorDialog.tsx)

Documentation and configuration enhancements:

Added detailed documentation for GHE.com and GHES setup, clarified environment variable usage, and improved developer guidance for building and deploying in enterprise environments. (README.md, docs/developing.md)

…jects#479) Make all GitHub host references configurable via environment variables so the app can run against GHE.com Data Residency tenants (*.ghe.com) and GitHub Enterprise Server, in addition to github.com. - New helpers in src/utils/github-urls.ts derive server/API/OAuth URLs from GITHUB_SERVER_URL (with smart derivation: github.com -> api.github.com, *.ghe.com -> api.<tenant>.ghe.com, anything else -> <server>/api/v3). GITHUB_API_URL overrides derivation. - Octokit (bot/rest.ts) and Probot (pages/api/webhooks.ts) are configured with the derived baseUrl. createAppAuth requests also use the configured base URL via @octokit/request defaults. - NextAuth GitHub provider routes authorization/token/userinfo through the configured GHE host and uses a custom userinfo.request to fetch /user/emails from the configured API host (next-auth v4 hardcodes api.github.com otherwise). OAuth refresh URL uses env. - generateAuthUrl builds git remotes from GITHUB_SERVER_URL host. - Committer email domain is configurable via GITHUB_USER_EMAIL_DOMAIN (default users.noreply.github.com preserves current behavior). - UI components use getGitHubServerUrl() for fork/org links; client bundles read NEXT_PUBLIC_GITHUB_SERVER_URL / NEXT_PUBLIC_GITHUB_API_URL inlined at build time. - webhook-relay.mjs script wires baseUrl into octokit.App and warns when not targeting github.com (polling endpoint is best-effort on GHE). - .env.example and docs (README.md, docs/developing.md) document the GHE.com / GHES configuration and Docker build-arg requirement. - Added tests for URL derivation covering github.com defaults, GHE.com Data Residency, GHES, and explicit overrides. Defaults are unchanged, so existing github.com / GHEC deployments continue to work without any new configuration. Closes github-community-projects#479 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…-support feat: add GHE.com Data Residency / GHES support (github-community-projects#479)

…plication

fix: correct GHES URL wiring and Docker client build args

mbianchidev · 2026-05-29T15:09:09Z

@wrslatz it should be ready for review 👍

riley-kohler

Apologies for the delay in review. I think we should lean on users setting all of the custom environment variables if necessary instead of attempting to derive values from those that are passed in. There is a lot of logic here that is hard to verify and will be hard to maintain in case GitHub changes URL structure or adds a new type of environment in the future. If there are GitHub provided functions that do this sort of thing we could lean on those but barring that I think that envs will be much easier to implement, test, and maintain.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Matteo Bianchi <37507190+mbianchidev@users.noreply.github.com>

…xport refactor: remove derive GitHub URL functionality in favor of explicit setup

refactor: resolve upstream conflicts and simplify GitHub config

wrslatz

Apologies for the delay in review here! I left a few suggestions, but none of them are blocking. Thanks for this great contribution that makes Private Mirrors work for more people and be more flexible in its config ❤️

…d-octokit refactor: improve GitHub integration type safety

mbianchidev · 2026-08-23T13:52:46Z

@wrslatz @riley-kohler aside from the Git options little rework (lmk what you think), the rest of comments have been addressed 👍

Thanks for taking the time to review!

refactor: type GitHub user profile directly

wrslatz

Thanks for addressing feedback!

riley-kohler

I haven't read through everything yet but running the code gives me a "Failed to fetch forks, graphql.paginate is not a function" error. From what I can tell it's due to the way that the paginate plugin is initiated and then overriden in the new src/bot/rest.ts logic.

Signed-off-by: Matteo Bianchi <37507190+mbianchidev@users.noreply.github.com>

fix: preserve GraphQL pagination for custom endpoints

mbianchidev · 2026-08-25T13:23:39Z

working to get a GHES instance to test it end to end locally

Edit:

Test is 🟢

riley-kohler

Looks good! Thanks for the contribution!

wrslatz

🚢

mbianchidev and others added 2 commits May 28, 2026 17:44

Merge pull request #1 from mbianchidev/mbianchidev/ghe-data-residency…

12f331c

…-support feat: add GHE.com Data Residency / GHES support (github-community-projects#479)

wrslatz mentioned this pull request May 29, 2026

Add GitHub Enterprise Server (GHE.com / Data Residency) support #479

Closed

wrslatz linked an issue May 29, 2026 that may be closed by this pull request

Add GitHub Enterprise Server (GHE.com / Data Residency) support #479

Closed

Initial plan

e3f5c8e

Copilot AI mentioned this pull request May 29, 2026

fix: correct GHES URL wiring and Docker client build args mbianchidev/private-mirrors#2

Merged

4 tasks

Copilot AI and others added 4 commits May 29, 2026 09:42

Fix GitHub Enterprise URL wiring

22aac25

refactor: reuse isGithubDotComHost in committer-email.ts

4d2bc74

refactor: reuse isGithubDotComHost in committer-email.ts to remove du…

b57c36b

…plication

Merge pull request #2 from mbianchidev/copilot/fix-ghes-graphql-endpoint

1537836

fix: correct GHES URL wiring and Docker client build args

mbianchidev marked this pull request as ready for review May 29, 2026 15:08

mbianchidev requested review from a team as code owners May 29, 2026 15:08

mbianchidev changed the title ~~WIP: Add support for GHE / Data Residency~~ feat: Add support for GHE / Data Residency May 29, 2026

wrslatz requested review from Miablo, ahpook and riley-kohler May 29, 2026 15:35

riley-kohler requested changes Jun 16, 2026

View reviewed changes

Comment thread src/pages/api/webhooks.ts Outdated

Copilot AI and others added 5 commits June 16, 2026 16:06

Remove derived GitHub URL configuration

5abf275

Restore webhook Probot endpoint configuration

bb96e61

Potential fix for pull request finding

252f0df

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Matteo Bianchi <37507190+mbianchidev@users.noreply.github.com>

Potential fix for pull request finding

09fe8b9

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Matteo Bianchi <37507190+mbianchidev@users.noreply.github.com>

Merge pull request #3 from mbianchidev/copilot/remove-unused-probot-e…

e9007f5

…xport refactor: remove derive GitHub URL functionality in favor of explicit setup

github-actions Bot added the feature label Jun 16, 2026

Copilot AI and others added 5 commits July 28, 2026 13:42

Merge upstream main

5554ca5

refactor: centralize GitHub environment config

e0db7aa

fix: preserve runtime feature flags

4362146

fix: preserve defaults during validation-free builds

b4e9357

Merge pull request #4 from mbianchidev/copilot/resolve-conflicts-main

4bdd19c

refactor: resolve upstream conflicts and simplify GitHub config

wrslatz requested a review from riley-kohler August 6, 2026 04:10

wrslatz approved these changes Aug 23, 2026

View reviewed changes

wrslatz assigned riley-kohler Aug 23, 2026

Copilot AI and others added 3 commits August 23, 2026 12:16

fix: address Octokit review feedback

5aba803

refactor: share bot Git identity options

282d465

Merge pull request #5 from mbianchidev/copilot/update-profile-type-an…

28f799e

…d-octokit refactor: improve GitHub integration type safety

wrslatz reviewed Aug 23, 2026

View reviewed changes

Comment thread src/app/api/auth/lib/nextauth-options.ts Outdated

refactor: type GitHub user profile directly

d17d20b

mbianchidev mentioned this pull request Aug 23, 2026

refactor: type GitHub user profile directly mbianchidev/private-mirrors#6

Merged

Merge pull request #6 from mbianchidev/cp-desktop-fix-ghe-review-comment

417670f

refactor: type GitHub user profile directly

wrslatz approved these changes Aug 23, 2026

View reviewed changes

wrslatz requested review from riley-kohler and removed request for riley-kohler August 23, 2026 16:14

riley-kohler reviewed Aug 24, 2026

View reviewed changes

Comment thread src/bot/rest.ts Outdated

Copilot AI and others added 5 commits August 25, 2026 07:49

test: reproduce GraphQL pagination regression

a34309d

fix: preserve GraphQL pagination with custom endpoint

2ab74af

Add comments for custom GraphQL clarity

1549274

Signed-off-by: Matteo Bianchi <37507190+mbianchidev@users.noreply.github.com>

Updated comments for clarity

cc7c1d5

Signed-off-by: Matteo Bianchi <37507190+mbianchidev@users.noreply.github.com>

Merge pull request #7 from mbianchidev/copilot/test-app-functionality

5d2033d

fix: preserve GraphQL pagination for custom endpoints

riley-kohler approved these changes Aug 25, 2026

View reviewed changes

riley-kohler added the release label Aug 25, 2026

mbianchidev changed the title ~~feat: Add support for GHE / Data Residency~~ feat: Add support for GHE / Data Residency and GHES Aug 25, 2026

wrslatz approved these changes Aug 26, 2026

View reviewed changes

wrslatz merged commit 03e45b2 into github-community-projects:main Aug 26, 2026
10 checks passed

Uh oh!

Conversation

mbianchidev commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mbianchidev commented May 29, 2026

Uh oh!

riley-kohler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wrslatz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbianchidev commented Aug 23, 2026

Uh oh!

Uh oh!

wrslatz left a comment

Choose a reason for hiding this comment

Uh oh!

riley-kohler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mbianchidev commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

riley-kohler left a comment

Choose a reason for hiding this comment

Uh oh!

wrslatz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mbianchidev commented May 28, 2026 •

edited

Loading

mbianchidev commented Aug 25, 2026 •

edited

Loading