cgit with patches for sandboxing using qssb
Go to file
John Keeping 5f323c1ff4 Makefile: re-use Git's Makefile where possible
Git does quite a lot of platform-specific detection in its Makefile,
which can result in it defining preprocessor variables that are used in
its header files.  If CGit does not define the same variables it can
result in different sizes of some structures in different places in the
same application.

For example, on Solaris Git uses it's "compat" regex library which has a
different sized regex_t structure than that available in the platform
regex.h.  This has a knock-on effect on the size of "struct rev_info"
and leads to hard to diagnose runtime issues.

In order to avoid all of this, introduce a "cgit.mk" file that includes
Git's Makefile and make all of the existing logic apply to CGit's
objects as well.  This is slightly complicated because Git's Makefile
must run in Git's directory, so all references to CGit files need to be
prefixed with "../".

In addition, OBJECTS is a simply expanded variable in Git's Makefile so
we cannot just add our objects to it.  Instead we must copy the two
applicable rules into "cgit.mk".  This has the advantage that we can
split CGit-specific CFLAGS from Git's CFLAGS and hence avoid rebuilding
all of Git whenever a CGit-specific value changes.

Signed-off-by: John Keeping <john@keeping.me.uk>
Acked-by: Jamie Couture <jamie.couture@gmail.com>
2013-03-20 21:08:32 +01:00
filters syntax-highlighting.sh: Fix command injection. 2012-10-27 20:05:50 -06:00
git@7e2010537e Update git to v1.7.12.4 2013-03-02 10:38:03 -05:00
tests tests: check that Git version are in sync 2013-03-20 21:06:50 +01:00
.gitignore Makefile: re-use Git's Makefile where possible 2013-03-20 21:08:32 +01:00
.gitmodules Delete submodules.sh and prepare for using git-submodule 2007-09-03 22:54:51 +02:00
cache.c Mark several functions/variables static 2013-03-04 19:50:39 -05: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 find_default_branch(): Free refmatch after usage 2013-03-04 19:55:34 -05:00
cgit.css ui-repolist: Bold the currently viewed page. 2012-10-08 23:29:29 +02:00
cgit.h Free reflists after usage 2013-03-04 19:55:12 -05:00
cgit.mk Makefile: re-use Git's Makefile where possible 2013-03-20 21:08:32 +01:00
cgit.png Use transparent background for the cgit logo 2011-02-19 14:41:39 +01:00
cgitrc.5.txt Make "owner" column on index page configurable 2013-02-01 12:50:24 +01:00
cmd.c White space around control verbs. 2013-03-04 09:12:54 -05:00
cmd.h Add is_clone flag to available commands 2011-02-19 14:57:48 +01:00
configfile.c Mark several functions/variables static 2013-03-04 19:50:39 -05:00
configfile.h Move function for configfile parsing into configfile.[ch] 2008-03-28 00:09:11 +01:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +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 Mark several functions/variables static 2013-03-04 19:50:39 -05:00
html.h html.c: add html_intoption() 2011-03-06 23:57:26 +01:00
Makefile Makefile: re-use Git's Makefile where possible 2013-03-20 21:08:32 +01:00
parsing.c Mark several functions/variables static 2013-03-04 19:50:39 -05:00
README README: times, they are a-changin 2012-10-09 13:21:30 +02:00
scan-tree.c White space around control verbs. 2013-03-04 09:12:54 -05:00
scan-tree.h Add support for 'project-list' option 2010-08-04 03:09:32 +02:00
shared.c Free reflists after usage 2013-03-04 19:55:12 -05:00
ui-atom.c Mark several functions/variables static 2013-03-04 19:50:39 -05:00
ui-atom.h Add atom-support 2008-08-01 22:12:34 +02:00
ui-blob.c ui-blob.c: Use a context structure in walk_tree() 2013-03-04 09:12:54 -05:00
ui-blob.h Support refspecs in about-filter. 2010-08-20 18:57:30 +02:00
ui-clone.c Support unannotated tags in git-clone. 2013-02-01 21:11:32 +01:00
ui-clone.h Add support for cloning over http 2008-08-06 11:21:09 +02:00
ui-commit.c cgit_print_commit(): Free tmp variable 2013-03-04 20:47:53 -05: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 Mark several functions/variables static 2013-03-04 19:50:39 -05:00
ui-diff.h ui-diff.c: create a control panel for diff options 2011-03-06 23:59:56 +01:00
ui-log.c Mark several functions/variables static 2013-03-04 19:50:39 -05: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 Format git diff headers correctly when adding or removing files. 2012-11-15 00:56:20 +01:00
ui-patch.h ui-patch: Apply path limit to generated patch 2010-06-19 10:40:23 +02:00
ui-plain.c ui-plain.c: Use a context structure in walk_tree() 2013-03-04 09:12:55 -05:00
ui-plain.h Implement plain view 2008-08-06 11:21:30 +02:00
ui-refs.c print_tag_downloads(): Free ref variable 2013-03-04 19:55:21 -05:00
ui-refs.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-repolist.c Mark several functions/variables static 2013-03-04 19:50:39 -05: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 Merge branch 'wip' 2013-03-20 20:21:25 +01:00
ui-shared.h Merge branch 'lh/module-links' 2012-03-18 20:59:36 +00:00
ui-snapshot.c Mark several functions/variables static 2013-03-04 19:50:39 -05:00
ui-snapshot.h Set prefix in snapshots when using dwimmery 2008-11-30 13:39:53 +01:00
ui-ssdiff.c ssdiff: correctly manage tab expansion 2013-02-01 13:46:47 +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 Mark several functions/variables static 2013-03-04 19:50:39 -05: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 ui-log: Add "commit-sort" option for controlling commit ordering 2012-10-17 16:30:29 +02:00
ui-summary.h ui-summary: enable arbitrary paths below repo.readme 2009-08-09 13:41:54 +02:00
ui-tag.c Mark several functions/variables static 2013-03-04 19:50:39 -05:00
ui-tag.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-tree.c cgit_print_tree(): Free curr_rev after usage 2013-03-04 20:47:53 -05:00
ui-tree.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
vector.c Add vector utility functions 2010-11-10 00:22:41 +01:00
vector.h Add vector utility functions 2010-11-10 00:22:41 +01:00

                       cgit - cgi for git


This is an attempt to create a fast web interface for the git scm, using a
builtin cache to decrease server io-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).


Dependencies:
  -git 1.7.4
  -zip lib
  -crypto lib
  -openssl lib


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 cachefile matching the request and
returns it to the client. If no such cachefile exist (or if it has expired),
the content for the request is written into the proper cachefile before the
file is returned.

If the cachefile 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
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, bugreports, discussions and support should go to the cgit
  mailing list: cgit@hjemli.net