X-Git-Url: https://git.ladys.computer/Gitweb/blobdiff_plain/c8781675934a3002fb72e8eead8230c06902a3561390dfaaf9a4a3016717f216..08998e9a681ba845e048dc088c73293958c329e4d024a18b1c425ba83fbd9c45:/README?ds=sidebyside

diff --git a/README b/README
index 9dca8a0..c11241e 100644
--- a/README
+++ b/README
@@ -1,16 +1,73 @@
 GIT web Interface
+=================
 
 The one working on:
-  http://www.kernel.org/git/
+  http://git.kernel.org/
 
-Get the gitweb.cgi by ftp:
-  ftp://ftp.kernel.org/pub/software/scm/gitweb/
+From the git version 1.4.0 gitweb is bundled with git.
 
-It reqires the git-core binaries installed on the system:
-  http://www.kernel.org/git/?p=git/git.git;a=summary
 
-The gitweb repository is here:
-  http://www.kernel.org/git/?p=git/gitweb.git;a=summary
+Build time gitweb configuration
+-------------------------------
+There are many configuration variables which affect building gitweb (among
+others creating gitweb.cgi out of gitweb.perl by replacing placeholders such
+as `++GIT_BINDIR++` by their build-time values).
 
-Any comment/question/concern to:
+Building and installing gitweb is described in gitweb's INSTALL file
+(in 'gitweb/INSTALL').
+
+
+Runtime gitweb configuration
+----------------------------
+Gitweb obtains configuration data from the following sources in the
+following order:
+
+1. built-in values (some set during build stage),
+2. common system-wide configuration file (`GITWEB_CONFIG_COMMON`,
+   defaults to '/etc/gitweb-common.conf'),
+3. either per-instance configuration file (`GITWEB_CONFIG`, defaults to
+   'gitweb_config.perl' in the same directory as the installed gitweb),
+   or if it does not exists then system-wide configuration file
+   (`GITWEB_CONFIG_SYSTEM`, defaults to '/etc/gitweb.conf').
+
+Values obtained in later configuration files override values obtained earlier
+in above sequence.
+
+You can read defaults in system-wide GITWEB_CONFIG_SYSTEM from GITWEB_CONFIG
+by adding
+
+  read_config_file($GITWEB_CONFIG_SYSTEM);
+
+at very beginning of per-instance GITWEB_CONFIG file.  In this case
+settings in said per-instance file will override settings from
+system-wide configuration file.  Note that read_config_file checks
+itself that the $GITWEB_CONFIG_SYSTEM file exists.
+
+The most notable thing that is not configurable at compile time are the
+optional features, stored in the '%features' variable.
+
+Ultimate description on how to reconfigure the default features setting
+in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found
+as comments inside 'gitweb.cgi'.
+
+See also gitweb.conf(5) manpage.
+
+
+Web server configuration
+------------------------
+Gitweb can be run as CGI script, as legacy mod_perl application (using
+ModPerl::Registry), and as FastCGI script.  You can find some simple examples
+in "Example web server configuration" section in INSTALL file for gitweb (in
+gitweb/INSTALL).
+
+See "Webserver configuration" and "Advanced web server setup" sections in
+gitweb(1) manpage.
+
+
+AUTHORS
+-------
+Originally written by:
   Kay Sievers <kay.sievers@vrfy.org>
+
+Any comment/question/concern to:
+  Git mailing list <git@vger.kernel.org>