Overview

Default configuration

On installation, GitProxy ships with an out-of-the-box configuration. This is fine for demonstration purposes but is likely not what you want to deploy into your environment.

Configuration Sources

GitProxy supports dynamic configuration loading from multiple sources. This feature allows you to manage your configuration from external sources and update it without restarting the service. Configuration sources can be files, HTTP endpoints, or Git repositories.

To enable configuration sources, add the configurationSources section to your configuration:

{
  "configurationSources": {
    "enabled": true,
    "reloadIntervalSeconds": 60,
    "merge": false,
    "sources": [
      {
        "type": "file",
        "enabled": true,
        "path": "./external-config.json"
      },
      {
        "type": "http",
        "enabled": true,
        "url": "http://config-service/git-proxy-config",
        "headers": {},
        "auth": {
          "type": "bearer",
          "token": "your-token"
        }
      },
      {
        "type": "git",
        "enabled": true,
        "repository": "https://git-server.com/project/git-proxy-config",
        "branch": "main",
        "path": "git-proxy/config.json",
        "auth": {
          "type": "ssh",
          "privateKeyPath": "/path/to/.ssh/id_rsa"
        }
      }
    ]
  }
}

The configuration options for configurationSources are:

enabled: Enable/disable dynamic configuration loading
reloadIntervalSeconds: How often to check for configuration updates (in seconds)
merge: When true, merges configurations from all enabled sources. When false, uses the last successful configuration load. This can be used to upload only partial configuration to external source
sources: Array of configuration sources to load from

Each source can be one of three types:

file: Load from a local JSON file
http: Load from an HTTP endpoint
git: Load from a Git repository

When configuration changes are detected, GitProxy will:

Validate the new configuration
Stop existing services
Apply the new configuration
Restart services with the updated configuration

Customise configuration

To customise your GitProxy configuration, create a proxy.config.json in your current working directory. GitProxy will load this file and set the values you have specified. Any missing sections will use the default configuration values.

Here is a minimal example:

{
  "authorisedList": [
    {
      "project": "octocat",
      "repo": "Hello-World",
      "url": "https://github.com/octocat/Hello-World"
    }
  ]
}

The full configuration reference can be found at the Reference page.

Alter the configuration path

To specify a different file name for your GitProxy configuration, use:

git-proxy --config ./config.json

Or with npx:

npx -- @finos/git-proxy --config ./config.json

Set ports with ENV variables

By default, GitProxy uses port 8000 to expose the Git Server and 8080 for the frontend application. The ports can be changed by setting the GIT_PROXY_SERVER_PORT, GIT_PROXY_HTTPS_SERVER_PORT (optional) and GIT_PROXY_UI_PORT environment variables:

export GIT_PROXY_UI_PORT="5000"
export GIT_PROXY_SERVER_PORT="9090"
export GIT_PROXY_HTTPS_SERVER_PORT="9443"

Note that GIT_PROXY_UI_PORT is needed for both server and UI Node processes, whereas GIT_PROXY_SERVER_PORT (and GIT_PROXY_HTTPS_SERVER_PORT) is only needed by the server process.

By default, GitProxy CLI connects to GitProxy running on localhost and default port. This can be changed by setting the GIT_PROXY_UI_HOST and GIT_PROXY_UI_PORT environment variables:

export GIT_PROXY_UI_HOST="http://www.git-proxy.com"
export GIT_PROXY_UI_PORT="5000"

Validate configuration

To validate your GitProxy configuration, run:

git-proxy --validate

To validate your configuration at a custom file location, run:

git-proxy --validate --config ./config.json

Default configuration​

Configuration Sources​

Customise configuration​

Alter the configuration path​

Set ports with ENV variables​

Validate configuration​