Add project settings option to override individual settings for any project, regardless of the project list method used. Also use settings as terminology instead of override
[gitphp.git] / config / projects.conf.php.example
blob:a/config/projects.conf.php.example -> blob:b/config/projects.conf.php.example
--- a/config/projects.conf.php.example
+++ b/config/projects.conf.php.example
@@ -15,7 +15,7 @@
  * git_projects
  * List of projects
  *
- * There are three ways to list projects:
+ * There are several ways to list projects:
  *
  * 1. Array of projects
  */
@@ -37,7 +37,16 @@
 //$git_projects = '/git/projectlist.txt';
 
 /*
- * 3. Leave commented to read all projects in the project root
+ * 3. Path to scm-manager repositories.xml file
+ * Points to the repository config file used by the scm-manager
+ * program.  In order for this to work, the projectroot for GitPHP
+ * must be the same as the git repository directory configured
+ * in scm-manager
+ */
+//$git_projects = '~/.scm/config/repositories.xml';
+
+/*
+ * 4. Leave commented to read all projects in the project root
  */
 
 
@@ -49,29 +58,72 @@
  * array of settings.  This can be used with any of the project list
  * 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.
+ *
  * 'owner': the owner of the project.  This overrides the actual owner
+ *
  * 'description': the description of the project.  This overrides the 
  *		  description in the project's description file
+ *
  * 'cloneurl': the full clone url of the project.  This overrides the
  *	       clone URL setting in the config for this project.
  *	       This can also be an empty string to override the global
  *             clone url to say that only this project has no clone url.
+ *
  * 'pushurl': the full push url of the project.  This overrides the
  *	      push URL setting in the config for this project.
  *	      This can also be an empty string to override the global
  *	      push url to say that only this project has no push url.
+ *
+ * 'bugpattern': the bug number pattern of the project.  This overrides
+ *		 the bug pattern setting in the config for this project.
+ *		 This can also be an empty string to override the global
+ *		 bug pattern to say that only this project has no bug
+ *		 pattern.
+ *
+ * 'bugurl': the bug url for this project.  This overrides the bug url
+ *	     setting in the config for this project.  This can also be
+ *	     an empty string to override the global bug url to say that
+ *	     only this project has no bug url.
+ *
+ * 'compat': whether this project runs in compatibility mode.  (true/false)
+ *	     This overrides the compat setting in the config for this project.
+ *	     Compatibility mode relies more on the git executable for loading
+ *	     data, at the expense of performance.  Use if you are having
+ *	     trouble loading data for this 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(
 //	'category' => 'PHP',
 //	'description' => 'GitPHP, a web-based git repository browser in PHP',
 //	'owner' => 'Christopher Han',
-//	'cloneurl' => 'http://git.xiphux.com/php/gitphp.git',
-//	'pushurl' => ''
+//	'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' => array(
+//		'user1',
+//		'user2'
+//	)
 //);
 //$git_projects_settings['gentoo.git'] = array(
-//	'description' => 'Gentoo portage overlay'
+//	'description' => 'Gentoo portage overlay',
+//	'compat' => true
 //);
 //$git_projects_settings['core/fbx.git'] = array(
 //	'description' => 'FBX music player',
@@ -84,3 +136,20 @@
 //	'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