doc/README

   1 Description
   2 ===========
   3 ViewGit is a git web interface / repository viewer, that aims to be easy to set
   4 up and upgrade, light on dependencies, and comfortable to use.
   5
   6 Some of the current features are:
   7 - Project index with description, last change, tree browsing, and download links
   8 - Project summary page with shortlog snippet and list of tags and heads (branches)
   9 - Shortlog: date of change, author, short message, and links to commit/commitdiff/tree/download
  10 - Commit: details of the commit
  11 - Commitdiff: colored diff of the changes in a commit
  12 - Tree (directory) browsing with downloadable trees (as tar/gz and zip), and downloadable files
  13 - RSS feeds of changes with configurable item title/description content
  14 - (Optional) Checkouts using mod_rewrite and git-update-server-info in .git/hooks/post-update
  15 - Alternative project list configuration using globs/wildcards (useful for mass hosting of projects)
  16 - Optional e-mail address obfuscator
  17 - Optional GeSHi support (not bundled)
  18
  19 Dependencies
  20 ============
  21 - PHP 5
  22 - Apache or compatible web server
  23 - Reasonably new git
  24
  25 First installation
  26 ==================
  27 - Create inc/localconfig.php and consult inc/config.php for what to put there.
  28   You can also look at inc/example-localconfig.php for example config.
  29 - Copy doc/example-htaccess to .htaccess and edit RewriteBase in it
  30
  31 Troubleshooting
  32 ===============
  33
  34 Add the following to your localconfig.php:
  35 $conf['debug'] = true;
  36 $conf['debug_command_trace'] = true;
  37
  38 This will show a debug trace of the git commands being run. If you see non-zero
  39 exit values, try running the commands manually as the webserver user, to see
  40 what goes wrong:
  41
  42 $ sudo su www-data
  43 $ <paste command>
  44