crtxcr
/
cgitsb
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README: Spelling and formatting fixes 

* Several small spelling and capitalization fixes.

* Use consistent and better-looking formatting that is compatible with
  AsciiDoc (and partly compatible with RST).

Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de>
This commit is contained in:
Lukas Fleischer 2014-01-08 19:45:29 +01:00 committed by Jason A. Donenfeld
parent b6da53dd75
commit e2416259ef
1 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README
View File

@ -1,86 +1,86 @@
cgit - CGI for Git
==================
cgit - cgi for git This is an attempt to create a fast web interface for the Git SCM, using a
built-in cache to decrease server I/O pressure.
This is an attempt to create a fast web interface for the git scm, using a
builtin cache to decrease server io-pressure.
Installation Installation
------------
Building cgit involves building a proper version of git. How to do this Building cgit involves building a proper version of Git. How to do this
depends on how you obtained the cgit sources: depends on how you obtained the cgit sources:
a) If you're working in a cloned cgit repository, you first need to a) If you're working in a cloned cgit repository, you first need to
initialize and update the git submodule: initialize and update the Git submodule:
$ git submodule init # register the git submodule in .git/config $ git submodule init # register the Git submodule in .git/config
$ $EDITOR .git/config # if you want to specify a different url for git $ $EDITOR .git/config # if you want to specify a different url for git
$ git submodule update # clone/fetch and checkout correct git version $ git submodule update # clone/fetch and checkout correct git version
b) If you're building from a cgit tarball, you can download a proper git b) If you're building from a cgit tarball, you can download a proper git
version like this: version like this:
$ make get-git $ make get-git
When either a) or b) has been performed, you can build and install cgit like When either a) or b) has been performed, you can build and install cgit like
this: this:
$ make $ make
$ sudo make install $ sudo make install
This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit". You can This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
configure this location (and a few other things) by providing a "cgit.conf" can configure this location (and a few other things) by providing a `cgit.conf`
file (see the Makefile for details). file (see the Makefile for details).
Dependencies
------------
Dependencies: * git 1.7.4
-git 1.7.4 * zip lib
-zip lib * crypto lib
-crypto lib * openssl lib
-openssl lib
Apache configuration Apache configuration
--------------------
A new Directory-section must probably be added for cgit, possibly something A new `Directory` section must probably be added for cgit, possibly something
like this: like this:
<Directory "/var/www/htdocs/cgit/"> <Directory "/var/www/htdocs/cgit/">
AllowOverride None AllowOverride None
Options +ExecCGI Options +ExecCGI
Order allow,deny Order allow,deny
Allow from all Allow from all
</Directory> </Directory>
Runtime configuration Runtime configuration
---------------------
The file /etc/cgitrc is read by cgit before handling a request. In addition The file `/etc/cgitrc` is read by cgit before handling a request. In addition
to runtime parameters, this file may also contain a list of repositories to runtime parameters, this file may also contain a list of repositories
displayed by cgit (see cgitrc.5.txt for further details). displayed by cgit (see `cgitrc.5.txt` for further details).
The cache The cache
---------
When cgit is invoked it looks for a cachefile matching the request and When cgit is invoked it looks for a cache file matching the request and
returns it to the client. If no such cachefile exist (or if it has expired), returns it to the client. If no such cache file exists (or if it has expired),
the content for the request is written into the proper cachefile before the the content for the request is written into the proper cache file before the
file is returned. file is returned.
If the cachefile has expired but cgit is unable to obtain a lock for it, the If the cache file has expired but cgit is unable to obtain a lock for it, the
stale cachefile is returned to the client. This is done to favour page stale cache file is returned to the client. This is done to favour page
throughput over page freshness. throughput over page freshness.
The generated content contains the complete response to the client, including The generated content contains the complete response to the client, including
the http-headers "Modified" and "Expires". the HTTP headers `Modified` and `Expires`.
Online presence Online presence
---------------
* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/> * The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
* Patches, bugreports, discussions and support should go to the cgit * Patches, bug reports, discussions and support should go to the cgit
mailing list: <cgit@lists.zx2c4.com>. To sign up, visit mailing list: <cgit@lists.zx2c4.com>. To sign up, visit
<http://lists.zx2c4.com/mailman/listinfo/cgit> <http://lists.zx2c4.com/mailman/listinfo/cgit>