Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Github Enterprise support #496

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

kcoms555
Copy link

@kcoms555 kcoms555 commented Apr 18, 2023

Summary

Support Github Enterprise

How to switch between GitHub Enterprise <-> GitHub

// open /platform_config.js with your editor
export const DefaultPlatform = Platform.GitHub // <- set it as Platform.GitHubEnterprise if want or Platform.GitHub
export class ConfigsForEnterprise {
	// if DefaultPlatform is Platform.GitHubEnterprise, then items below must be rewritten
	// insert your baseUrl. It is used to access to most cases.
	// access ex) https://your.enterprise.url/some_org/some_repo/blob/some_branch/dir1/dir2/filename
	static github_enterprise_baseUrl = 'https://your.enterprise.url';

	// insert your api url. It is used to access to api.
	// if you uses GitHub Enterprise API v3, then set it as http(s)://HOSTNAME/api/v3
	// access ex) https://your.enterprise.url/api/v3/repos/some_org/some_repo/commits
	static github_enterprise_api_url = 'https://your.enterprise.url/api/v3';

	// insert your github enterprise client_id
	// how to get a new client_id: https://your.enterprise.url/settings/applications/new
	static github_enterprise_client_id = 'xxxxxxxxxxxxxxxxxxxx';

	// insert your github1s server url(NOT github enterprise baseUrl!) on which your github1s applications are running
	// It is required to get authentication token from your github enterprise to your github1s server.
	static auth_page_origin = 'https://your.github1s.server';
}

Limitation

  1. In the private network(internet isolated), applications requiring Internet are not working including Sourcegraph which helps indexing. If needed, It should deployed and edit source codes related to that parts.
  2. Depending on each individual situation, there may be restrictions on API access, limit on the number of requests, and unexpected bugs according to the GitHub Enterprise policy.

Related Issues

@welcome
Copy link

welcome bot commented Apr 18, 2023

Hello there!👋 Welcome to the project!💖 Thank you and congrats🎉 for opening your first pull request✨ 🙌.We will get back to you as soon as we can.😄

@vercel
Copy link

vercel bot commented Apr 18, 2023

@kcoms555 is attempting to deploy a commit to the Github1s Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello there kcoms555 👋

Thank you and congrats 🎉 for opening your first PR on this project.✨

We will review it soon!

github1s fosters an open and welcoming environment for all our contributors.🌸

@vercel
Copy link

vercel bot commented Oct 26, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
github1s ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 26, 2023 10:49am

@Siddhant-K-code
Copy link
Collaborator

cc: @conwnet wdyt about this?

@conwnet
Copy link
Owner

conwnet commented Oct 26, 2023

cc: @conwnet wdyt about this?

I found some copy-and-paste code in this PR, so I'm going to take the time to sort it out.

@Siddhant-K-code
Copy link
Collaborator

Siddhant-K-code commented Oct 26, 2023

We would also require a GitHub Enterprise URL to test this out. @kcoms555 Do you have any demo GitHub Enterprise URL to test this out?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Github Enterprise support
3 participants