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
--- a/config/projects.conf.php.example
+++ b/config/projects.conf.php.example
@@ -58,7 +58,11 @@
  * 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.
  *
@@ -95,17 +99,27 @@
  *	     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',
+//	'cloneurl' => 'http://git.gitphp.org/gitphp.git',
 //	'pushurl' => '',
 //	'bugpattern' => '/#([0-9]+)/',
-//	'bugurl' => 'http://mantis.xiphux.com/view.php?id=${1}',
+//	'bugurl' => 'http://www.gitphp.org/projects/gitphp/issues/${1}',
 //	'compat' => false,
-//	'website' => 'http://xiphux.com/programming/gitphp/'
+//	'website' => 'http://www.gitphp.org/',
+//	'allowedusers' => array(
+//		'user1',
+//		'user2'
+//	)
 //);
 //$git_projects_settings['gentoo.git'] = array(
 //	'description' => 'Gentoo portage overlay',
@@ -122,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