Bart\GitHook\GitHookSystemConfig::README PHP Method

README() public method

public README ( ) : string
return string Sample of how configuration is intended to be defined
    public function README()
    {
        return <<<README
;;
; Configurations shared by all repositories on this host
;;
;; This section holds names for environment variables to be used by hooks
[env_vars]
; How to determine name of user pushing a change
push_user_name = GITOSIS_USER


;; This section holds configurations for freezing code
[frozen]
; Do not allow merges to the following repos
; Use 'all' to block everything; otherwise a CSV of repo names
repo_names = bart, example, my-organization/repo

; A CSV of users exempt from any code freeze
super_users = gitosis-admin, linus
README;
    }