cgit with patches for sandboxing using qssb
Aller au fichier
Christian Hesse 8ae1d8b8fd email-gravatar: fix html syntax issues
an attribute value specification must be an attribute value literal
unless SHORTTAG YES is specified
2014-01-15 14:43:02 +01:00
filters email-gravatar: fix html syntax issues 2014-01-15 14:43:02 +01:00
git@d2446dfd7f git: update to 1.8.5 2014-01-08 14:59:38 +01:00
tests tests/: Add t0111-filter.sh 2014-01-14 13:55:53 +01:00
.gitignore tests/.gitignore: update for using Git's test infrastructure 2013-04-08 22:27:53 +02:00
.gitmodules Delete submodules.sh and prepare for using git-submodule 2007-09-03 22:54:51 +02:00
AUTHORS authors: specify maintainers 2014-01-14 02:00:07 +01:00
cache.c cache: don't leave cache_slot fields uninitialized 2014-01-12 19:32:20 +01:00
cache.h use __attribute__ to catch printf format mistakes 2010-09-04 11:11:40 -04:00
cgit-doc.css Add cgit-doc.css 2009-02-12 10:24:25 +01:00
cgit.c filter: add support for email filter 2014-01-14 02:00:07 +01:00
cgit.css Reduce line number bloat, fix hover effect 2014-01-08 14:59:38 +01:00
cgit.h filter: add support for email filter 2014-01-14 02:00:07 +01:00
cgit.mk makefile: only display lua message once 2014-01-14 13:47:28 +01:00
cgit.png Use transparent background for the cgit logo 2011-02-19 14:41:39 +01:00
cgitrc.5.txt filter: allow returning exit code from filter 2014-01-14 18:09:52 +01:00
cmd.c Update copyright information 2014-01-08 15:10:49 +01:00
cmd.h Add is_clone flag to available commands 2011-02-19 14:57:48 +01:00
configfile.c Update copyright information 2014-01-08 15:10:49 +01:00
configfile.h Use strbuf for reading configuration files 2013-08-12 13:14:10 -06:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
favicon.ico Add favicon 2013-05-31 02:52:24 +02:00
filter.c filter: allow returning exit code from filter 2014-01-14 18:09:52 +01:00
gen-version.sh gen-version.sh: don't sed the output from git describe 2007-10-01 12:09:41 +02:00
html.c html: remove redundant htmlfd variable 2014-01-12 20:15:55 +01:00
html.h html.c: add various strbuf and varadic helpers 2013-04-08 16:10:11 +02:00
Makefile git: update to 1.8.5 2014-01-08 14:59:38 +01:00
parsing.c parsing: fix header typo 2014-01-10 17:45:43 +01:00
README README: document lua makefile flags 2014-01-14 03:48:23 +01:00
robots.txt robots.txt: disallow access to snapshots 2013-08-12 13:14:10 -06:00
scan-tree.c Replace most uses of strncmp() with prefixcmp() 2014-01-10 17:01:29 +01:00
scan-tree.h Add support for 'project-list' option 2010-08-04 03:09:32 +02:00
shared.c filter: add support for email filter 2014-01-14 02:00:07 +01:00
ui-atom.c Update copyright information 2014-01-08 15:10:49 +01:00
ui-atom.h Add atom-support 2008-08-01 22:12:34 +02:00
ui-blob.c Update copyright information 2014-01-08 15:10:49 +01:00
ui-blob.h readme: use string_list instead of space deliminations 2013-05-26 16:30:03 +02:00
ui-clone.c Update copyright information 2014-01-08 15:10:49 +01:00
ui-clone.h Add support for cloning over http 2008-08-06 11:21:09 +02:00
ui-commit.c filter: add page source to email filter 2014-01-14 02:00:07 +01:00
ui-commit.h ui-commit: Limit diff based on path limit in qry.path 2010-06-19 10:40:23 +02:00
ui-diff.c Update copyright information 2014-01-08 15:10:49 +01:00
ui-diff.h Allow for creating raw diffs with cgit_print_diff() 2013-08-16 13:15:37 -06:00
ui-log.c filter: add page source to email filter 2014-01-14 02:00:07 +01:00
ui-log.h ui-log: Add "commit-sort" option for controlling commit ordering 2012-10-17 16:30:29 +02:00
ui-patch.c Update copyright information 2014-01-08 15:10:49 +01:00
ui-patch.h ui-patch: Rename variables 2013-08-20 19:55:54 +02:00
ui-plain.c Update copyright information 2014-01-08 15:10:49 +01:00
ui-plain.h Implement plain view 2008-08-06 11:21:30 +02:00
ui-refs.c filter: add page source to email filter 2014-01-14 02:00:07 +01:00
ui-refs.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-repolist.c filter: return on null filter from open and close 2014-01-14 02:00:07 +01:00
ui-repolist.h Prepare for 'about site' page / add 'root-readme' option to cgitrc 2008-04-29 01:06:30 +02:00
ui-shared.c ui-shared: URL-escape script_name 2014-01-12 23:02:19 +01:00
ui-shared.h ui-shared: Drop filepair_cb_raw() and helper 2013-09-14 19:31:50 +02:00
ui-snapshot.c filter: add interface layer 2014-01-14 02:00:07 +01:00
ui-snapshot.h Set prefix in snapshots when using dwimmery 2008-11-30 13:39:53 +01:00
ui-ssdiff.c Reduce line number bloat, fix hover effect 2014-01-08 14:59:38 +01:00
ui-ssdiff.h ui-ssdiff: move LCS table away from the stack 2012-01-03 15:16:01 +00:00
ui-stats.c ui-stats.c: Remove unused macro 2014-01-08 14:59:38 +01:00
ui-stats.h Add and use cgit_find_stats_periodname() in print_repo() 2009-08-24 11:02:48 +02:00
ui-summary.c filter: return on null filter from open and close 2014-01-14 02:00:07 +01:00
ui-summary.h readme: use string_list instead of space deliminations 2013-05-26 16:30:03 +02:00
ui-tag.c filter: add page source to email filter 2014-01-14 02:00:07 +01:00
ui-tag.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-tree.c filter: pass extra arguments via cgit_open_filter 2014-01-12 20:20:20 +01:00
ui-tree.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00

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.

Installation
------------

Building cgit involves building a proper version of Git. How to do this
depends on how you obtained the cgit sources:

a) If you're working in a cloned cgit repository, you first need to
initialize and update the Git submodule:

    $ git submodule init     # register the Git submodule in .git/config
    $ $EDITOR .git/config    # if you want to specify a different url for git
    $ 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
version like this:

    $ make get-git

When either a) or b) has been performed, you can build and install cgit like
this:

    $ make
    $ sudo make install

This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
can configure this location (and a few other things) by providing a `cgit.conf`
file (see the Makefile for details).

If you'd like to compile without Lua support, you may use:

    $ make NO_LUA=1

And if you'd like to specify a Lua implementation, you may use:

    $ make LUA_IMPLEMENTATION=JIT

for using the LuaJIT project. Or:

    $ make LUA_IMPLEMENTATION=VANILLA

for the mainline Lua project. If you specify neither implementation, it will
be auto-detected, preferring LuaJIT if both are present.


Dependencies
------------

* libzip
* libcrypto (OpenSSL)
* libssl (OpenSSL)
* optional: luajit or lua

Apache configuration
--------------------

A new `Directory` section must probably be added for cgit, possibly something
like this:

    <Directory "/var/www/htdocs/cgit/">
        AllowOverride None
        Options +ExecCGI
        Order allow,deny
        Allow from all
    </Directory>


Runtime configuration
---------------------

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
displayed by cgit (see `cgitrc.5.txt` for further details).

The cache
---------

When cgit is invoked it looks for a cache file matching the request and
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 cache file before the
file is returned.

If the cache file has expired but cgit is unable to obtain a lock for it, the
stale cache file is returned to the client. This is done to favour page
throughput over page freshness.

The generated content contains the complete response to the client, including
the HTTP headers `Modified` and `Expires`.

Online presence
---------------

* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>

* Patches, bug reports, discussions and support should go to the cgit
  mailing list: <cgit@lists.zx2c4.com>. To sign up, visit 
  <http://lists.zx2c4.com/mailman/listinfo/cgit>