Explain in docs not to fill out the Enterprise Base URL
config setting if the GH Enterprise instance is hosted on GitHub's domain
#714
Labels
Difficulty/1:Easy
Easy ticket
Good First Issue
Suitable for first-time contributors
Hacktoberfest
Help Wanted
Community help wanted
Tech/Go
Type/Enhancement
New feature or improvement of existing feature
We currently support self-hosted GItHub Enterprise servers with custom URLs, configured with the
Enterprise Base URL
config setting. If the GH Enterprise instance is hosted by GitHub itself, the correct configuration is to leave theEnterprise Base URL
config setting blank, so the plugin uses the defaultapi.github.com
host for the GitHub client.We should make it clear in the following places to have this value blank in the case of GitHub hosting the Enterprise instance, and also rename the setting to
Custom GitHub Enterprise URL
:/github setup
flowThere is also a config setting
Enterprise Upload URL
, that is always identical to theEnterprise Base URL
. I think we should just remove theEnterprise Upload URL
since this duplication just causes confusion. We append the suffixes on both of the URLs heremattermost-plugin-github/server/plugin/plugin.go
Lines 193 to 199 in 573e4a3
And we are actually setting up the
uploadURL
path incorrectly. According to theNewEnterpriseClient
function we're calling here https://github.com/google/go-github/blob/466e52f0cd17ddbed7a4ac88307fc8fdaf440605/github/github.go#L378:/api/uploads
anywayThe text was updated successfully, but these errors were encountered: