Move config file to example
[gitphp.git] / config / gitphp.conf.php.example
blob:a/config/gitphp.conf.php.example -> blob:b/config/gitphp.conf.php.example
--- a/config/gitphp.conf.php.example
+++ b/config/gitphp.conf.php.example
@@ -1,6 +1,6 @@
 <?php
 /*
- *  config.inc.php
+ *  gitphp.conf.php
  *  gitphp: A PHP git repository browser
  *  Component: Configuration
  *
@@ -56,17 +56,20 @@
  * The variable '$gitphp_version' will expand to the
  * version number only
  */
-$gitphp_conf['title'] = "centraldogma :: $gitphp_appstring";
+$gitphp_conf['title'] = "$gitphp_appstring";
 
 /*
  * self
  * This is the path to the script that will be inserted
- * in urls.
+ * in urls.  If you leave this blank/commented the script
+ * will try to guess the correct URL, but you can override
+ * it here if it's not being guessed correctly.
+ *
  * If only specifying the directory path (and omitting the
  * index.php filename), make sure to include the trailing
  * slash!
  */
-$gitphp_conf['self'] = "http://centraldogma/gitphp/";
+//$gitphp_conf['self'] = "http://localhost/gitphp/";
 
 /*
  * smarty_prefix
@@ -90,26 +93,34 @@
 $gitphp_conf['smarty_prefix'] = "smarty/";
 
 /*
- * bzsnapshots
- * If set to true, will bzcompress snapshot tars before sending them.
- * Your PHP must have been compiled with bzip2 support!
+ * compressformat
+ * Indicates what kind of compression will be done on the
+ * snapshot archive.  Recognized settings are:
+ *
+ * GITPHP_COMPRESS_BZ2 - create a tar.bz2 file (php must have bz2 support)
+ * GITPHP_COMPRESS_GZ - create a tar.gz file (php must have gzip support)
+ * GITPHP_COMPRESS_ZIP - create a zip file
+ *
+ * Any other setting, or no setting, will create uncompressed tar archives
+ * If you choose a compression format and your php does not support it,
+ * gitphp will fall back to uncompressed tar archives
  */
-$gitphp_conf['bzsnapshots'] = TRUE;
+$gitphp_conf['compressformat'] = GITPHP_COMPRESS_BZ2;
 
 /*
- * bzblocksize
- * Sets the compression level for bzip2.  Ranges from 1-9, with
+ * compresslevel
+ * Sets the compression level for snapshots.  Ranges from 1-9, with
  * 9 being the most compression but requiring the most processing
- * (bzip defaults to 4)
+ * (bzip defaults to 4, gzip defaults to -1)
  */
-$gitphp_conf['bzblocksize'] = 9;
+$gitphp_conf['compresslevel'] = 9;
 
 /*
  * geshi
  * Run blob output through geshi syntax highlighting
  * and line numbering
  */
-$gitphp_conf['geshi'] = TRUE;
+$gitphp_conf['geshi'] = FALSE;
 
 /*
  * geshiroot
@@ -129,7 +140,7 @@
  * This requires either PHP >= 5.3.0, PECL fileinfo, or
  * Linux
  */
-$gitphp_conf['filemimetype'] = FALSE;
+$gitphp_conf['filemimetype'] = TRUE;
 
 /*
  * magicdb
@@ -145,6 +156,19 @@
 //$gitphp_conf['magicdb'] = "C:\\wamp\\php\\extras\\magic";  // Windows
 
 /*
+ * search
+ * Set this to false or comment it out to disable searching
+ */
+$gitphp_conf['search'] = TRUE;
+
+/*
+ * filesearch
+ * Set this to false to disable searching within files
+ * (it can be resource intensive)
+ */
+$gitphp_conf['filesearch'] = TRUE;
+
+/*
  * git_projects
  * Two-dimensional array list of projects
  * First array index is the name of the category the projects
@@ -157,34 +181,11 @@
  * Comment out $git_projects (leave null) to attempt to read all
  * projects in the projectroot.
  */
-$git_projects['Core']['FBX'] = "core/fbx.git";
-$git_projects['Core']['Mvm'] = "core/mvm.git";
-$git_projects['Core']['PySoulforge'] = "core/pysoulforge.git";
-$git_projects['Core']['Scripts'] = "core/scripts.git";
-$git_projects['Core']['Soulforge'] = "core/soulforge.git";
-$git_projects['Core']['XNSS'] = "core/xnss.git";
-$git_projects['Core']['XNSS_old'] = "core/xnss_old.git";
-$git_projects['PHP']['Codex'] = "php/codex.git";
-$git_projects['PHP']['gitphp'] = "php/gitphp.git";
-$git_projects['PHP']['MDB'] = "php/mdb.git";
-$git_projects['PHP']['xxcache'] = "php/xxcache.git";
-$git_projects['Nuclear']['Fusion'] = "nuclear/fusion.git";
-$git_projects['Websites']['lots'] = "websites/lots.git";
-$git_projects['Websites']['bth'] = "websites/bth.git";
-$git_projects['School']['CS135'] = "school/cs135.git";
-$git_projects['School']['CS150'] = "school/cs150.git";
-$git_projects['School']['CS151'] = "school/cs151.git";
-$git_projects['School']['CS156'] = "school/cs156.git";
-$git_projects['School']['CS160'] = "school/cs160.git";
-$git_projects['School']['CS161'] = "school/cs161.git";
-$git_projects['School']['CS169'] = "school/cs169.git";
-$git_projects['School']['CS178'] = "school/cs178.git";
-$git_projects['School']['CS180'] = "school/cs180.git";
-$git_projects['School']['CS189'] = "school/cs189.git";
-$git_projects['School']['CS183'] = "school/cs183.git";
-$git_projects['School']['CS193'] = "school/cs193.git";
-$git_projects['School']['CS195'] = "school/cs195.git";
-$git_projects['School']['CS196'] = "school/cs196.git";
+//$git_projects['Core']['FBX'] = "core/fbx.git";
+//$git_projects['PHP']['gitphp'] = "php/gitphp.git";
+//$git_projects['PHP']['MDB'] = "php/mdb.git";
+//$git_projects['PHP']['xxcache'] = "php/xxcache.git";
+//$git_projects['Websites']['bth'] = "websites/bth.git";
 
 ?>
 

comments