Make the gtihub URL configurable to allow support for enterprise installs

[bharmann]

Description

Rather than only use GitHub.com, it would be great if we could replace the base URL host to our internal enterprise GitHub. All the paths and api calls should remain the same, so I imagine the change is fairly trivial to implement.

[MrGVSV]

So you mean like instead of github.com it would be company.com? Or company.github.com?

Do you have a public enterprise domain we could test against to ensure the feature works as intended? If not, I may need help testing any PR I end up making lol

[bharmann]

Ours isn't public, though Im happy to test. I just checked though and you can get a 45 day trial of enterprise and it comes as a downloadable VM you can just run, so that seems promising. They also have enterprise cloud which is a hybrid of full enterprise and GitHub.com.

Aside - One thing worth mentioning is enterprise is usually about 1-2 versions behind General GitHub and some features are different, so when viewing the docs, be sure the correct platform is selected else you pull out your hair looking for things that don't exist :)

[bcohen44]

Any update on support for GitHub Enterprise (configuration of the URL)?

[MrGVSV]

Sorry for the delay, life has been really busy. I can try to take a look at this soon.

I'd rather not have to use my free trial up on this issue if I can help it 😅, so I'll try to ask my questions here.

So for a company like Acme:

1. Could we expect a URL like https://acme.io?
2. Would we link to repos with the same path as we do GitHub (e.g. https://acme.io/foo-repo)?
3. Would we link to tickets with the same path as we do GitHub (e.g. https://acme.io/foo-repo/issue/1, https://acme.io/foo-repo/pull/2)?
4. Will requests made to https://api.github.com (REST) and https://api.github.com/graphql (GraphQL) still work?
5. Are images and other kinds of media content still accessible via https://raw.githubusercontent.com?

[bcohen44]

Sorry for the delay, life has been really busy. I can try to take a look at this soon.

I'd rather not have to use my free trial up on this issue if I can help it 😅, so I'll try to ask my questions here.

So for a company like Acme:

1. Could we expect a URL like https://acme.io?

Yes, custom URL

2. Would we link to repos with the same path as we do GitHub (e.g. https://acme.io/foo-repo)?

Yes, after the main domain name, the rest of the URL paths would be the same as github.com

3. Would we link to tickets with the same path as we do GitHub (e.g. https://acme.io/foo-repo/issue/1, https://acme.io/foo-repo/pull/2)?

Same answer

4. Will requests made to https://api.github.com (REST) and https://api.github.com/graphql (GraphQL) still work?

No. Everything is behind the domain name for security. And likely behind the companys' firewalls.

5. Are images and other kinds of media content still accessible via https://raw.githubusercontent.com?

No, same answer,.

[bharmann]

One thing to note, the enterprise installs have organizations attached so a repo could reside in your account if its a personal repo, ie https://foo.bar/<username>/<repo> or https://foo.bar/<org>/<repo> but passed that once you are relative to the repo, the paths associated with issues and projects etc will follow the same pattern as github.

As for the GitHub apis, you would just replace api.github.com with domain/api/v3 and passed that the api paths should also be the same as GitHub.com. @bcohen44 is correct regarding the vpn/firewall, though depending on the setup, you could probably make the assumption that if the host isn’t reachable, they aren’t connected to the corporate network or vpn and to pause any syncing till the host is reachable again.