Add GitHub Enterprise Server support #7570

doew · 2025-03-28T08:53:45Z

This change is worth documenting at https://docs.all-hands.dev/
Include this change in the Release Notes. If checked, you must provide an end-user friendly description for your change below

End-user friendly description of the problem this fixes or functionality that this introduces.
This update introduces support for GitHub Enterprise Server (GHES), allowing OpenHands to integrate seamlessly with self-hosted GitHub environments. Users can now configure OpenHands to connect with GHES instances through updated API endpoints and improved authentication mechanisms.

Give a summary of what the PR does, explaining any non-trivial design decisions.
This PR adds support for GitHub Enterprise Server by:

Implementing configuration options specific to GHES
Updating API endpoint logic to accommodate GHES-specific paths
Enhancing authentication flows to support GHES tokens and permissions
Adding test cases to validate GHES functionality

The design ensures that these changes are backward-compatible with existing GitHub.com integrations.

Link of any specific issues this addresses.
N/A

- Add TypeScript interface declarations for GitHub-related global window properties - Fix TypeScript build errors related to missing window property types - Ensure proper type checking for GitHub Enterprise integration

- Fix trailing whitespace in GitHub auth URL and URL parsing test files - Add proper end-of-file newlines to test files - Improve code formatting consistency in test files

- Add proper end-of-file newlines to Python files - Fix import ordering in test files - Standardize string quote style in GitHub configuration files - Improve code formatting and line wrapping in GitHub service tests

- Fix import ordering and remove unused imports - Improve function parameter formatting for better readability - Standardize string quote style in GitHub and settings related files - Fix whitespace and indentation issues - Remove unnecessary blank lines

malhotra5 · 2025-03-31T16:25:47Z

Thanks a bunch for putting this together!

The main feedback I have is

to make sure we're saving the enterprise url inside the secret _store field inside Settings. Specifically, adding an extra field HOST_URL inside ProviderToken
Inside the accountsettings page for the FE, add an extra host url field which saves/stores the HOST_URL for the user in the BE
Use the settings provider in the FE to access the HOST_URL and pass around the attribute as needed

We're trying to make this configurable on a per-user; let me know if you need any help with this!

doew · 2025-03-31T16:36:27Z

@malhotra5
Happy to take this suggestion on!
Initially, I thought having a global setting would be sufficient for self-hosting OpenHands, but I assume this change is necessary to support the SaaS version as well — is that correct?
It might take me a bit of time to implement, but I’ll keep working on it.

malhotra5 · 2025-03-31T18:28:03Z

Yup its so that the changes can be ported over to SAAS as well

Its also a matter of consistency, as for self hosted openhands we still maintain values inside user settings rather than setting values globally

This commit adds support for GitHub Enterprise Server instances: - Add base_url parameter to GitService interface - Add host_url field to ProviderToken model - Enhance GitHubService to handle custom API URLs for Enterprise Server - Update settings models and routes to handle host_url information - Add Enterprise Host URL input field to account settings UI - Update tests to validate Enterprise Server functionality These changes enable users to configure and connect to their own self-hosted GitHub Enterprise Server instances through the UI, allowing each user to specify their own custom GitHub host. Backward compatibility with github.com is maintained.

…rise-server-support

doew · 2025-04-02T12:00:37Z

@malhotra5

I've implemented the changes you suggested. Here's what I've done:

Added a HOST_URL field to the ProviderToken class
Added a GitHub Enterprise Server Host URL input field to the frontend account settings page
Implemented the backend logic to save and retrieve the HOST_URL
Modified the frontend settings provider to access and pass the HOST_URL attribute as needed

These changes allow users to configure their GitHub Enterprise Server host URL on a per-user basis, maintaining consistency with other OpenHands settings that are managed at the user level.

For self-hosted environments, I've maintained the ability to configure global settings through environment variables (GITHUB_ENTERPRISE_URL) and configuration files. The implementation prioritizes the user-specific host_url when available, falling back to the globally configured URL when not set.

Please let me know if you'd like to see any additional changes or have any questions!

…rise-server-support

doew · 2025-04-04T10:38:11Z

@malhotra5

Thank you for reviewing this PR. Since the last review, I have added new commits, but in the meantime, GitLab-related changes were introduced, requiring me to resolve conflicts twice.

Given that the time available for this PR is limited, I would like to discuss the best way to proceed smoothly. For example, one possible approach could be merging the PR in its current state and handling any necessary fixes in a separate PR.

Could you share your thoughts on this? I appreciate your help.

doew · 2025-04-04T13:37:43Z

Thanks for running the CI! It looks like it failed, so I’ll go ahead and push a fix to get it passing.

enyst · 2025-04-04T14:08:33Z

@doew I think, if you run a make build in the project, it will install the pre-commit hooks that make it simple.

malhotra5 · 2025-04-10T22:11:44Z

frontend/src/config/github-enterprise.ts

+export const initGitHubEnterpriseConfig = () => {
+  // Set GitHub Enterprise URL if available
+  if (import.meta.env.VITE_GITHUB_ENTERPRISE_URL) {
+    window.GITHUB_ENTERPRISE_URL = import.meta.env.VITE_GITHUB_ENTERPRISE_URL;


Could we avoid using window to pass around GitHub related settings. We'd rather just use the UserSettings because its persists for local installations as well

malhotra5 · 2025-04-10T22:12:59Z

frontend/src/types/git.d.ts

+
+// Extend Window interface to include GitHub Enterprise URL
+declare global {
+  interface Window {


similarly remove use of window here

malhotra5 · 2025-04-10T22:14:58Z

frontend/src/types/settings.ts

@@ -18,7 +32,7 @@ export type Settings = {
  ENABLE_DEFAULT_CONDENSER: boolean;
  ENABLE_SOUND_NOTIFICATIONS: boolean;
  USER_CONSENTS_TO_ANALYTICS: boolean | null;
-  PROVIDER_TOKENS: Record<Provider, string>;
+  PROVIDER_TOKENS: Record<Provider, ProviderTokenDataGet | string>;


Can we enforce this to always be ProviderTokenData instead of `string

Also the backend route can end empty token for GET requests, instead of making ProviderTokenDataPost and ProviderTokenDataGet

malhotra5 · 2025-04-10T22:15:31Z

frontend/src/utils/generate-github-auth-url.ts

@@ -7,6 +7,19 @@
 */
 export const generateGitHubAuthUrl = (clientId: string, requestUrl: URL) => {
  const redirectUri = `${requestUrl.origin}/oauth/keycloak/callback`;
+
+  // Check if GitHub Enterprise Server URL is configured
+  const githubEnterpriseUrl = window.GITHUB_ENTERPRISE_URL || "";


can we have a param from the user settings passed to this function instead of pulling the URL value out from window

malhotra5 · 2025-04-10T22:16:53Z

openhands/integrations/github/github_service.py

+            )
+        else:
+            # Default to github.com API
+            self.BASE_URL = get_github_api_url() or self.DEFAULT_BASE_URL


NIT: lets define the helper functions within this class (e.g get_github_api_url)

Let's remove the config class and just use user settings for storing the BASE_URL values

malhotra5 · 2025-04-10T22:18:36Z

openhands/server/routes/git.py

@@ -93,9 +96,14 @@ async def get_github_installation_ids(
 ):
    if provider_tokens and ProviderType.GITHUB in provider_tokens:
        token = provider_tokens[ProviderType.GITHUB]
+        # Use the host_url from the token if available, otherwise use the default API URL
+        github_api_url = token.host_url or get_github_api_url()


We should have host_url information available in the token, so get_github_api_url should be unnecessary

We strictly want to store such information on a per user basis

malhotra5 · 2025-04-10T22:20:40Z

FYI #7766 is adding similar support but for Gitlab, so some of the scaffolding changes may be quite similar

doew · 2025-04-11T01:50:47Z

Thank you very much for the helpful review!
I’ll go through each point and address them one by one.

doew and others added 16 commits March 27, 2025 13:48

Add GitHub Enterprise Server configuration options

5d1cc1c

Add GitHub Enterprise Server configuration module

2efc32c

Update GitHub Service to support GitHub Enterprise Server

693bd72

Update GitHub Routes to support GitHub Enterprise Server

1478693

Update GitHub Resolver to support GitHub Enterprise Server

dd786a2

Update frontend to support GitHub Enterprise Server

0d5ef49

Add tests for GitHub Enterprise Server support

82d7578

Fix test for GitHub Enterprise Server support

978ff86

style: fix whitespace and EOL in GitHub-related test files

255be37

- Fix trailing whitespace in GitHub auth URL and URL parsing test files - Add proper end-of-file newlines to test files - Improve code formatting consistency in test files

style: fix formatting in Python GitHub-related files

6419fa3

- Add proper end-of-file newlines to Python files - Fix import ordering in test files - Standardize string quote style in GitHub configuration files - Improve code formatting and line wrapping in GitHub service tests

fix(config): Replace tomli with toml

651f340

fix: Remove redundant configuration handling

a2db78c

Merge branch 'main' into feature/github-enterprise-server-support

f3516da

Merge branch 'main' into feature/github-enterprise-server-support

f87c341

xingyaoww requested review from chuckbutkus and malhotra5 March 28, 2025 22:19

Merge branch 'main' into feature/github-enterprise-server-support

53d0f41

doew force-pushed the feature/github-enterprise-server-support branch 2 times, most recently from c7a108c to 98adb9f Compare April 2, 2025 11:36

doew added 2 commits April 2, 2025 20:45

Merge remote-tracking branch 'origin/main' into feature/github-enterp…

c1daad8

…rise-server-support

fix: change ui component order

db6c84b

Merge remote-tracking branch 'origin/main' into feature/github-enterp…

ced5e7b

…rise-server-support

doew and others added 4 commits April 7, 2025 14:59

fix test fail

b2488de

fix: fail test_github_service_enterprise_server

c50612b

fix: fail check-hardcoded-strings.test.tsx

700cfeb

Merge branch 'main' into feature/github-enterprise-server-support

bde6e56

malhotra5 reviewed Apr 10, 2025

View reviewed changes

malhotra5 mentioned this pull request Apr 10, 2025

Add support for self-hosted gitlab domain config #7766

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GitHub Enterprise Server support #7570

Add GitHub Enterprise Server support #7570

doew commented Mar 28, 2025

malhotra5 commented Mar 31, 2025 •

edited

Loading

doew commented Mar 31, 2025

malhotra5 commented Mar 31, 2025

doew commented Apr 2, 2025

doew commented Apr 4, 2025

doew commented Apr 4, 2025

enyst commented Apr 4, 2025

malhotra5 Apr 10, 2025

malhotra5 Apr 10, 2025

malhotra5 Apr 10, 2025

malhotra5 Apr 10, 2025

malhotra5 Apr 10, 2025

malhotra5 Apr 10, 2025

malhotra5 commented Apr 10, 2025

doew commented Apr 11, 2025

Add GitHub Enterprise Server support #7570

Are you sure you want to change the base?

Add GitHub Enterprise Server support #7570

Conversation

doew commented Mar 28, 2025

malhotra5 commented Mar 31, 2025 • edited Loading

doew commented Mar 31, 2025

malhotra5 commented Mar 31, 2025

doew commented Apr 2, 2025

doew commented Apr 4, 2025

doew commented Apr 4, 2025

enyst commented Apr 4, 2025

malhotra5 Apr 10, 2025

Choose a reason for hiding this comment

malhotra5 Apr 10, 2025

Choose a reason for hiding this comment

malhotra5 Apr 10, 2025

Choose a reason for hiding this comment

malhotra5 Apr 10, 2025

Choose a reason for hiding this comment

malhotra5 Apr 10, 2025

Choose a reason for hiding this comment

malhotra5 Apr 10, 2025

Choose a reason for hiding this comment

malhotra5 commented Apr 10, 2025

doew commented Apr 11, 2025

malhotra5 commented Mar 31, 2025 •

edited

Loading