Allow displaying a website url for a project
[gitphp.git] / config / projects.conf.php.example
blob:a/config/projects.conf.php.example -> blob:b/config/projects.conf.php.example
<?php <?php
/** /**
* GitPHP Project config file * GitPHP Project config file
* *
* Copy this example file to config/projects.conf.php * Copy this example file to config/projects.conf.php
* *
* @author Christopher Han <xiphux@gmail.com> * @author Christopher Han <xiphux@gmail.com>
* @copyright Copyright (c) 2010 Christopher Han * @copyright Copyright (c) 2010 Christopher Han
* @package GitPHP * @package GitPHP
* @subpackage Config * @subpackage Config
*/ */
   
   
/* /*
* git_projects * git_projects
* List of projects * List of projects
* *
* There are several ways to list projects: * There are several ways to list projects:
* *
* 1. Array of projects * 1. Array of projects
*/ */
//$git_projects = array( //$git_projects = array(
// 'gentoo.git' // 'gentoo.git'
// 'core/fbx.git', // 'core/fbx.git',
// 'php/gitphp.git', // 'php/gitphp.git',
// 'php/mdb.git', // 'php/mdb.git',
// 'php/xxcache.git', // 'php/xxcache.git',
// 'websites/bth.git', // 'websites/bth.git',
//); //);
   
   
/* /*
* 2. Path to file with list of projects * 2. Path to file with list of projects
* Points to a flat file with a list of projects, * Points to a flat file with a list of projects,
* one on each line. Can also read Gitosis project lists. * one on each line. Can also read Gitosis project lists.
*/ */
//$git_projects = '/git/projectlist.txt'; //$git_projects = '/git/projectlist.txt';
   
/* /*
* 3. Path to scm-manager repositories.xml file * 3. Path to scm-manager repositories.xml file
* Points to the repository config file used by the scm-manager * Points to the repository config file used by the scm-manager
* program. In order for this to work, the projectroot for GitPHP * program. In order for this to work, the projectroot for GitPHP
* must be the same as the git repository directory configured * must be the same as the git repository directory configured
* in scm-manager * in scm-manager
*/ */
//$git_projects = '~/.scm/config/repositories.xml'; //$git_projects = '~/.scm/config/repositories.xml';
   
/* /*
* 4. Leave commented to read all projects in the project root * 4. Leave commented to read all projects in the project root
*/ */
   
   
/* /*
* git_projects_settings * git_projects_settings
* *
* This is used to specify override settings for individual projects. * This is used to specify override settings for individual projects.
* This is an array, where each key is the project, and the value is an * This is an array, where each key is the project, and the value is an
* array of settings. This can be used with any of the project list * array of settings. This can be used with any of the project list
* methods above. * methods above.
* *
* The settings array can have the following key/value settings: * These config values can also be specified in the project's git config file,
  * under the section [gitphp]. A setting set in this file will override
  * the setting set in the project's config file.
  *
  * The following settings can be used:
* *
* 'category': the category for the project. * 'category': the category for the project.
* *
* 'owner': the owner of the project. This overrides the actual owner * 'owner': the owner of the project. This overrides the actual owner
* *
* 'description': the description of the project. This overrides the * 'description': the description of the project. This overrides the
* description in the project's description file * description in the project's description file
* *
* 'cloneurl': the full clone url of the project. This overrides the * 'cloneurl': the full clone url of the project. This overrides the
* clone URL setting in the config for this project. * clone URL setting in the config for this project.
* This can also be an empty string to override the global * This can also be an empty string to override the global
* clone url to say that only this project has no clone url. * clone url to say that only this project has no clone url.
* *
* 'pushurl': the full push url of the project. This overrides the * 'pushurl': the full push url of the project. This overrides the
* push URL setting in the config for this project. * push URL setting in the config for this project.
* This can also be an empty string to override the global * This can also be an empty string to override the global
* push url to say that only this project has no push url. * push url to say that only this project has no push url.
* *
* 'bugpattern': the bug number pattern of the project. This overrides * 'bugpattern': the bug number pattern of the project. This overrides
* the bug pattern setting in the config for this project. * the bug pattern setting in the config for this project.
* This can also be an empty string to override the global * This can also be an empty string to override the global
* bug pattern to say that only this project has no bug * bug pattern to say that only this project has no bug
* pattern. * pattern.
* *
* 'bugurl': the bug url for this project. This overrides the bug url * 'bugurl': the bug url for this project. This overrides the bug url
* setting in the config for this project. This can also be * setting in the config for this project. This can also be
* an empty string to override the global bug url to say that * an empty string to override the global bug url to say that
* only this project has no bug url. * only this project has no bug url.
* *
* 'compat': whether this project runs in compatibility mode. (true/false) * 'compat': whether this project runs in compatibility mode. (true/false)
* This overrides the compat setting in the config for this project. * This overrides the compat setting in the config for this project.
* Compatibility mode relies more on the git executable for loading * Compatibility mode relies more on the git executable for loading
* data, at the expense of performance. Use if you are having * data, at the expense of performance. Use if you are having
* trouble loading data for this project. * trouble loading data for this project.
* *
* 'website': the website url for the project. * 'website': the website url for the project.
  *
  * 'allowedusers': an array of usernames allowed to access this project.
  * Anonymous users and logged in users not in this list
  * will not be able to see or access this project.
  * By default, all users will have access to a project if
  * this option is not set.
*/ */
//$git_projects_settings['php/gitphp.git'] = array( //$git_projects_settings['php/gitphp.git'] = array(
// 'category' => 'PHP', // 'category' => 'PHP',
// 'description' => 'GitPHP, a web-based git repository browser in PHP', // 'description' => 'GitPHP, a web-based git repository browser in PHP',
// 'owner' => 'Christopher Han', // 'owner' => 'Christopher Han',
// 'cloneurl' => 'http://git.xiphux.com/php/gitphp.git', // 'cloneurl' => 'http://git.gitphp.org/gitphp.git',
// 'pushurl' => '', // 'pushurl' => '',
// 'bugpattern' => '/#([0-9]+)/', // 'bugpattern' => '/#([0-9]+)/',
// 'bugurl' => 'http://mantis.xiphux.com/view.php?id=${1}', // 'bugurl' => 'http://www.gitphp.org/projects/gitphp/issues/${1}',
// 'compat' => false, // 'compat' => false,
// 'website' => 'http://xiphux.com/programming/gitphp/' // 'website' => 'http://www.gitphp.org/',
  // 'allowedusers' => array(
  // 'user1',
  // 'user2'
  // )
//); //);
//$git_projects_settings['gentoo.git'] = array( //$git_projects_settings['gentoo.git'] = array(
// 'description' => 'Gentoo portage overlay', // 'description' => 'Gentoo portage overlay',
// 'compat' => true // 'compat' => true
//); //);
//$git_projects_settings['core/fbx.git'] = array( //$git_projects_settings['core/fbx.git'] = array(
// 'description' => 'FBX music player', // 'description' => 'FBX music player',
// 'category' => 'Core' // 'category' => 'Core'
//); //);
//$git_projects_settings['php/mdb.git'] = array( //$git_projects_settings['php/mdb.git'] = array(
// 'category' => 'PHP', // 'category' => 'PHP',
// 'description' => 'MDB: Media Database', // 'description' => 'MDB: Media Database',
// 'cloneurl' => '', // 'cloneurl' => '',
// 'pushurl' => '' // 'pushurl' => ''
//); //);
   
  /*
  * Or, in your project's config file (for example gitphp.git/config):
  *
  * [gitphp]
  * category = PHP
  * description = GitPHP, a web-based git repository browser in PHP
  * owner = Chris Han
  * cloneurl = http://git.gitphp.org/gitphp.git
  * pushurl =
  * bugpattern = "/#([0-9]+)/"
  * bugurl = http://www.gitphp.org/projects/gitphp/issues/${1}
  * compat = false
  * website = http://www.gitphp.org/
  * allowedusers = user1
  * allowedusers = user2
  */
   
comments