Add Troubleshooting section to README.
[viewgit.git] / inc / config.php
blobf1a016cd0f2e678bd490fc8a32bc26b7e747f285
1 <?php
2 /** @file
3 * Configuration file for viewgit.
5 * @note DO NOT EDIT THIS FILE. Create localconfig.php instead and override the settings in it.
6 */
7 $conf['projects'] = array(
8 // 'name' => array('repo' => '/path/to/repo/.git'), // path to GIT_DIR
9 );
11 // Where git is. Default is to search from PATH, but you can use an absolute
12 // path as well.
13 $conf['git'] = 'git';
15 // If set, contains an array of globs/wildcards where to include projects.
16 // Use this if you have a lot of projects under a directory.
17 //$conf['projects_glob'] = array('/path/to/*/.git', '/var/git/*.git');
19 // If set, contains an array of projects to exclude.
20 // Use this if you have set $conf['projects_glob'] and you
21 // want to exclude just some projects.
22 //$conf['projects_exclude'] = array('project1', 'project2');
24 // Name and prefix for tar/gz & zip archives generated. Default is to use the
25 // project name and version. Can be overridden in project config.
26 $conf['archive_prefix'] = '{PROJECT}-{DESCRIBE}';
28 $conf['datetime'] = '%Y-%m-%d %H:%M';
30 // More complete format for commit page
31 $conf['datetime_full'] = '%Y-%m-%d %H:%M:%S';
33 // Set timezone to format timestamps for. If you have a local one-site team,
34 // you may want to override this with your local timezone.
35 // See http://www.php.net/manual/en/timezones.php for supported values.
36 $conf['timezone'] = 'UTC';
38 // Maximum length of commit message's first line to show
39 $conf['commit_message_maxlen'] = 50;
41 // Maximum number of shortlog entries to show on the summary page
42 $conf['summary_shortlog'] = 15;
44 // Maximum number of tags to show on the summary page
45 $conf['summary_tags'] = 10;
47 // Whether to show remote labels on shortlog
48 $conf['shortlog_remote_labels'] = false;
50 // Allow checking out projects via "git clone"
51 $conf['allow_checkout'] = true;
53 // If set, this function is used to obfuscate e-mail addresses of authors/committers
54 // The 'obfuscate_mail' function simply replaces @ with ' at ' and . with ' dot '
55 //$conf['mail_filter'] = 'obfuscate_mail';
56 //$conf['mail_filter'] = create_function('$mail', 'return str_rot13(strtoupper($mail));');
58 // Whether to use GeSHi for source highlighting
59 $conf['geshi'] = false;
61 // Path to geshi.php
62 //$conf['geshi_path'] = 'inc/geshi/geshi.php';
63 //$conf['geshi_path'] = '/usr/share/php-geshi/geshi.php'; // Path on Debian
65 // Use line numbers in geshi?
66 // Setting this to "false" disables line numbers
67 // Using a value of 0 will enable "NORMAL" geshi line numbers
68 // Using values of 1 or more will enable "FANCY" geshi line numbers
69 $conf['geshi_line_numbers'] = 5;
71 // RSS time to live (how often clients should update the feed), in minutes.
72 $conf['rss_ttl'] = 10;
74 // RSS: Maximum number of items in feed
75 $conf['rss_max_items'] = 30;
77 // RSS item format. Allowed formatting:
78 // {AUTHOR}, {AUTHOR_MAIL}, {SHORTLOG}, {LOG}, {COMMITTER}, {COMMITTER_MAIL}, {DIFFSTAT}
79 $conf['rss_item_title'] = '{SHORTLOG} ({AUTHOR})';
80 $conf['rss_item_description'] = '<pre>{LOG}</pre><b>{AUTHOR}</b> &lt;{AUTHOR_MAIL}&gt;<br /><pre>{DIFFSTAT}</pre>';
82 $conf['debug'] = false;
83 $conf['debug_command_trace'] = false;
85 // Includes a small link to the ViewGit homepage on each page
86 $conf['ad'] = true;
88 // If auth_lib is set, inc/auth_<auth_lib>.php must exist and include a function
89 // named auth_check(). The function should check any required global variables
90 // (such as $_REQUEST, $_SERVER['PHP_AUTH_USER']) and die() if access is denied.
92 // For a simple username/password authorisation you can use auth_simple, see
93 // inc/auth_simple.php for more info. The array is username => md5 hash.
94 //$conf['auth_lib'] = 'simple';
95 //$conf['auth_simple_users'] = array('test' => 'd7b58f27f98f47bacd60fa87efe822ba');
97 // Uncomment the following lines to authenticate using some drupal site's
98 // config
99 //$conf['auth_lib'] = 'drupal_user';
100 //$conf['drupal_site_config'] = '/var/www/sites/default/settings.php';
102 // Which stylesheet to use
103 $conf['style'] = 'default';
105 if (!@include_once('localconfig.php')) {
106 header("Content-type: text/plain");
107 echo "ViewGit has not been configured yet, please read doc/README for installation instructions:\n\n";
108 require_once('doc/README');
109 die();