Support a custom host for repositories (GitHub Enterprise, self-hosted GitLab) #143

Activity

1. roxblnfk

   added

   enhancementNew feature or requestNew feature or request

   on Oct 9, 2026
2. roxblnfk

   changed the title [-]Support custom hosts in repository uri (GitHub Enterprise, self-hosted GitLab)[/-] [+]Support a custom host for repositories (GitHub Enterprise, self-hosted GitLab)[/+] on Oct 9, 2026
3. roxblnfk

   added a commit that references this issue on Oct 9, 2026

   feat: pass the RR_GITHUB_API_URL host to DLoad

   ...

   9614249
4. roxblnfk commented on Oct 10, 2026

   

   roxblnfk

   on Oct 10, 2026

   MemberAuthor

   More actions

   Design

   server attribute

   The attribute is named server rather than host: it carries the scheme too (same meaning as GITHUB_SERVER_URL in GitHub Actions).

   <repository type="github" uri="org/repo" server="https://ghe.example.com"/>
   <repository type="gitlab" uri="group/tool" server="gitlab.example.com:8443"/>
   <repository type="github" uri="org/repo" server="http://127.0.0.1:8080"/>

   • Format: [scheme://]host[:port], no path, query or credentials. The scheme defaults to https; only http and https are accepted.
   • No server → behaviour stays exactly as today. An explicit https://github.com / https://gitlab.com is the same as the default.
   • The value is normalized (lower case, default port dropped).

   API base URL

   type	default	custom server
   github	https://api.github.com	{server}/api/v3
   gitlab	https://gitlab.com/api/v4	{server}/api/v4

   Tokens

   A token is declared per server in the environment: DLOAD_TOKEN_ + host and port, upper-cased, every non-alphanumeric character replaced with _:

   • ghe.example.com → DLOAD_TOKEN_GHE_EXAMPLE_COM
   • gitlab.example.com:8443 → DLOAD_TOKEN_GITLAB_EXAMPLE_COM_8443

   server	token source, by priority
   github.com (default)	DLOAD_TOKEN_GITHUB_COM, then GITHUB_TOKEN
   gitlab.com (default)	DLOAD_TOKEN_GITLAB_COM, then GITLAB_TOKEN
   custom	DLOAD_TOKEN_<HOST> only

   • GITHUB_TOKEN / GITLAB_TOKEN are never sent to a custom server.
   • The config cannot choose which variable is read: only the user's environment opts a host in, so a foreign dload.xml can't exfiltrate a token or any other variable.
   • A custom server's token is attached only to requests to the same scheme, host and port (no subdomains). The default servers keep today's rule (api.github.com, github.com, *.githubusercontent.com).
   • No token over plain http, except loopback (localhost, 127.0.0.0/8, ::1), so a local fake server can still test authentication.
   • The GitLab client stops attaching the token to every request and gets the same host check.
   • Error messages (401 / 403 / rate limit) name the variable that was actually consulted.

   Version registry

   • Repository::getId(): RepositoryId; the downloader takes the registry key from the repository instead of building it from the config.
   • RepositoryId gets an optional server (null for the public host). A custom server is stored under github@ghe.example.com/org/repo; default paths are unchanged, so existing registries stay valid.
   • RepositoryRecord gets an optional repository.server field; records without it read as the public host, so no format version bump.
5. roxblnfk commented on Oct 12, 2026

   

   roxblnfk

   on Oct 12, 2026

   MemberAuthor

   More actions

   Change of design: the server comes from uri, not a server attribute

   The design above added a server attribute next to uri. Review of #148 showed that uri already accepted a full URL and silently dropped its host: uri="https://ghe.corp.com/infra/tool" downloaded infra/tool from github.com. Keeping both attributes would leave two places to name a server and a conflict between them to resolve, while the URL alone carries everything the attribute did (scheme, host, port). The attribute was never released, so it is dropped.

   Now:

   <repository type="github" uri="https://ghe.example.com/owner/repo"/>
   <repository type="gitlab" uri="https://gitlab.example.com:8443/group/sub/project"/>
   <repository type="github" uri="http://127.0.0.1:8080/owner/repo"/>

   • owner/repo and https://github.com/owner/repo (or gitlab.com) work as before, with the same registry keys and tokens.
   • A value without a scheme never names a server. github.com/owner/repo still reads as the public host; for GitHub a scheme-less foreign host (ghe.example.com/owner/repo) is an error instead of a silent download from github.com.
   • The rest of the design stands: {server}/api/v3 / {server}/api/v4, plain http only for loopback, per-server registry keys, and per-server tokens — with an injective variable name now (. → _, - → __, port after ___), so ghe-example.com cannot read the token of ghe.example.com. Tokens are also dropped on redirects that leave their server.
6. roxblnfk

   added 2 commits that reference this issue on Oct 12, 2026

   feat(repository): support self-hosted servers via repository URLs

   ...

   This issue will close once commit d181637 is merged into the '1.x' branch.

   d181637

   feat(repository): support self-hosted servers via repository URLs

   ...

   This issue will close once commit a90a2f7 is merged into the '1.x' branch.

   a90a2f7
7. roxblnfk

   closed this as completedin #148on Oct 12, 2026