{

    "_Comment": "The is an example configuration file used by the Node application. This file is in JSON format and every property (say, X) has a corresponding description property (X-Description), which provides a simple explanation about the property itself. To start using this file, fill in the required fields and delete this property from the file.",  

    "Version": 2,

    "Version-Description": "Version number of this config file",

    "Server-Use-HTTPS": false,

    "Server-Use-HTTPS-Description": "Boolean value that determines whether to use secure socket layer for HTTP communication",

    "Server-Key-File-Path": "",

    "Server-Key-File-Path-Description": "Absolute Path on the server to the server key file; MUST when HTTPS protocol is to be used",

    "Server-Certificate-File-Path": "",

    "Server-Certificate-File-Path-Description": "Absolute Path on the server to the certificate file; MUST when HTTPS protocol is to be used",

    "Server-Setup-HTTP-Redirector": true,

    "Server-Setup-HTTP-Redirector-Description": "Boolean value that determines if an HTTP listener has to be setup; this listener simply diverts the incoming requests to same endpoint over HTTPS",

    "Server-Port": 9999,

    "Server-Port-Description": "Integer value that defines the port on which the server has to listen to",

    "Server-Socket-Timeout": 180000,

    "Server-Socket-Timeout-Description": "Timeout (in milliseconds) to be set for socket connection. Default is 3 minutes. Set to 0 for indefinite.",

    "Git-Executable-Path": "/usr/bin/git",

    "Git-Executable-Path-Description": "Absolute path to the git executable on the server; provide the absolute path, if 'git' is not found on the PATH environment variable",

    "Git-Repositories-Root-Dir": "/home/admin/gitrepos",

    "Git-Repositories-Root-Dir-Description": "Absolute path to the directory on the server where the Git repositories are located",

    "Git-Use-Request": false,

    "Git-Use-Request-Description": "Boolean Value that determines if request module is to be used to make http calls. This is required if Rational Team Concert server is used for authentication and is configured to use form based authentication. Setting to true implies that request module is installed and is available to this server.",

    "Git-Use-NodeGit": true,

    "Git-Use-NodeGit-Description": "Boolean Value that determines if nodegit module is to be used for operating on Git repositories. Setting to true implies that nodegit module is installed and is available to this server.",

    "Auth-Profiles": {

        "Basic-1": {

            "type": "BASIC",

            "url": "https://rtc:9443/ccm/secure/authenticated/identity",

            "method": "GET"

        }

    },

    "Auth-Profiles-Description": "Set of authentication profiles available. It is a map - with the profile name itself being the key, and the properties being the value. The value object must contain 'type' property as one of 'LDAP', 'BASIC' (Please note that it is case-sensitive). In case of LDAP authentication, the value object should have properties pertaining LDAP authentication. Some basic properties are listed here. However, you can add others if needed. The list of properties is documented here: https://github.com/vesse/node-ldapauth-fork#ldapauth-config-options. In case of BASIC authentication, the value object should have 'url' and 'method' properties against which the HTTP Basic authentication is done. If 'method' property is absent, 'GET' is assumed.",

    "Git-URL-Prefixes": {

        "/git": {

            "authProfile": "localhost"

        }

    },

    "Git-URL-Prefixes-Description": "Set of URL prefixes to be considered for the Git request. It is a map - with the prefix itself being the key, and the properties being the value. Right now the only supported property is 'authProfile' and its value can be one of the profile names in 'Auth-Profiles' configuration property. If 'authProfile' property is defined, the corresponding auth profile is applied; otherwise, no authentication is performed. In this case for example, the auth profile 'Ldap-1' will be applied for a Git repository having a url http://gitserver:9999/git/MyRepo.git since /git is the prefix to the git repository MyRepo.git"

}