cvsimport: add <remote>/HEAD reference in separate remotes more
[gitweb.git] / gitweb / README
index abbaf6b8bfe8549015f777701d43fcb8a28866d4..e02e90f0429be0d2a69b76571101f20b8f75530f 100644 (file)
@@ -1,4 +1,5 @@
 GIT web Interface
+=================
 
 The one working on:
   http://www.kernel.org/git/
@@ -6,7 +7,8 @@ The one working on:
 From the git version 1.4.0 gitweb is bundled with git.
 
 
-How to configure gitweb for your local system:
+How to configure gitweb for your local system
+---------------------------------------------
 
 You can specify the following configuration variables when building GIT:
  * GITWEB_SITENAME
@@ -31,6 +33,7 @@ You can specify the following configuration variables when building GIT:
    environment variable will be loaded instead of the file
    specified when gitweb.cgi was created.
 
+
 Runtime gitweb configuration
 ----------------------------
 
@@ -43,6 +46,34 @@ description on how to reconfigure the default features setting in your
 `GITWEB_CONFIG` or per-project in `project.git/config` inside 'gitweb.cgi'.
 
 
+Webserver configuration
+-----------------------
+
+If you want to have one URL for both gitweb and your http://
+repositories, you can configure apache like this:
+
+<VirtualHost www:80>
+    ServerName git.domain.org
+    DocumentRoot /pub/git
+    RewriteEngine on
+    RewriteRule ^/(.*\.git/(?!/?(info|objects|refs)).*)?$ /cgi-bin/gitweb.cgi%{REQUEST_URI}  [L,PT]
+    SetEnv     GITWEB_CONFIG   /etc/gitweb.conf
+</VirtualHost>
+
+The above configuration expects your public repositories to live under
+/pub/git and will serve them as http://git.domain.org/dir-under-pub-git,
+both as cloneable GIT URL and as browseable gitweb interface.
+If you then start your git-daemon with --base-path=/pub/git --export-all
+then you can even use the git:// URL with exactly the same path.
+
+Setting the environment variable GITWEB_CONFIG will tell gitweb to use
+the named file (i.e. in this example /etc/gitweb.conf) as a
+configuration for gitweb.  Perl variables defined in here will
+override the defaults given at the head of the gitweb.perl (or
+gitweb.cgi).  Look at the comments in that file for information on
+which variables and what they mean.
+
+
 Originally written by:
   Kay Sievers <kay.sievers@vrfy.org>