Skip to content

Git Provider Integration#

GitHub Enterprise#

Outbound Proxy#

If the SysGit auth server can reach your GitHub Enterprise Server (GHES) appliance only through a corporate HTTP(S) proxy, set these on the auth server container:

Variable Value
HTTPS_PROXY Your proxy, e.g. http://proxy.example.com:3128
NODE_USE_ENV_PROXY 1
NO_PROXY Comma-separated hosts the auth server must reach directly (see below)

The auth server runs on Node.js, which ignores HTTPS_PROXY unless NODE_USE_ENV_PROXY=1 is also set. Without it, sign-in fails because the OAuth token exchange tries to reach the appliance directly. Recent auth images set NODE_USE_ENV_PROXY=1 by default; setting it yourself is harmless, and it has no effect when no proxy variable is set.

Once the proxy is on, every outbound HTTPS request from the auth server uses it: sign-in, user lookups, git clone and push (which pass through the auth server), and licence checks. List in NO_PROXY anything that must stay direct, such as other SysGit services reached over HTTPS by internal hostname, or the appliance itself if it is reachable without the proxy. Entries are hostnames (ghes.internal) or domain suffixes (.corp.example.com). Set HTTP_PROXY as well only if the auth server must reach a plain-http:// host through the proxy.

If the proxy inspects TLS, the auth server must trust its CA: add the CA to the certificate bundle mounted into the auth container, as for an appliance with an internal CA.

Users' browsers call the appliance directly with their own proxy settings; these variables do not affect them.

Web Commit Signing#

Required only for signed-commit support

SysGit does not yet create signed commits. Set this up when you upgrade to a release that adds signed commits on GitHub Enterprise Server, or now if you want to prepare. Until then, branches that require signed commits will reject commits from SysGit.

SysGit's signed commits are signed by the appliance, as commits made in the GHES web editor are. The appliance needs a signing key, which is off by default. On the appliance's administrative shell:

  1. Create a signing key. Generate a PGP key without a passphrase whose email is the appliance's no-reply address. Find that address with:

     ghe-config smtp.noreply-address
    

    Then generate the key (for example with gpg --full-generate-key, leaving the passphrase empty) and note its key ID.

  2. Store the private key. It must be stored as one line, with each line break written as \n:

     ghe-config secrets.gpgverify.web-signing-key \
       "$(gpg --armor --export-secret-keys KEY_ID | awk '{printf "%s\\n", $0}')"
    
    • A multi-line value produces an invalid configuration file, and ghe-config-apply fails.
    • A double-escaped value (\\n) is accepted, but GHES then silently creates unsigned commits. If your branches require signed commits, they are rejected on push.
  3. Enable web commit signing and apply:

    ghe-config app.github.web-commit-signing-enabled true
    ghe-config-apply
    
  4. Create the web-flow user. Create a GHES user named web-flow and add the key's public half to its account (Settings → SSH and GPG keys → New GPG key):

     gpg --armor --export KEY_ID
    

To check: edit a file in the GHES web editor and confirm the commit shows Verified. If it is unverified, recheck step 2.

See Also#