A hyperfast web frontend for git repositories written in C.
Go to file
Samuel Lidén Borell 00ecfaadea config: make empty js= omit script tag
According to the cgitrc man page, an empty js= value should cause the
script tag to be omitted. But instead, a script tag with an empty URL
is emitted. The same applies to css. So, skip emitting a tag if the
specified string is empty.

Signed-off-by: Samuel Lidén Borell <samuel@kodafritt.se>
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
2023-01-10 17:52:54 +01:00
contrib/hooks contrib/hooks: add sample post-receive hook using agefile 2015-08-12 14:06:36 +02:00
filters md2html: use proper formatting for hr 2021-05-12 15:32:50 +02:00
git@c48035d29b git: update to v2.39.0 2022-12-19 15:09:39 +01:00
tests tests: t0107: support older and/or non-GNU tar 2020-12-29 21:06:17 +01:00
.gitignore tests/.gitignore: update for using Git's test infrastructure 2013-04-08 22:27:53 +02:00
.gitmodules Use https for submodule 2017-09-22 00:52:57 +02:00
.mailmap Update .mailmap with my new email address 2017-07-27 16:20:44 +02:00
AUTHORS authors: specify maintainers 2014-01-14 02:00:07 +01:00
COPYING Update COPYING 2018-07-10 16:40:15 +02:00
Makefile config: add js 2022-12-19 16:50:21 +01:00
README Hosted on HTTPS now 2016-06-07 14:49:35 +02:00
cache.c cache: tolerate short writes in print_slot 2022-12-19 16:13:58 +01:00
cache.h global: spelling fixes 2017-10-15 18:44:55 +02:00
cgit.c config: add js 2022-12-19 16:50:21 +01:00
cgit.css css: reset font size for blame oid 2022-12-19 16:13:58 +01:00
cgit.h js: add dynamic age update 2022-12-19 16:50:23 +01:00
cgit.js js: add dynamic age update 2022-12-19 16:50:23 +01:00
cgit.mk ui-blame: add blame UI 2017-10-03 19:19:34 +01:00
cgit.png shrink cgit.png file size 2015-02-15 22:06:24 +01:00
cgitrc.5.txt config: add js 2022-12-19 16:50:21 +01:00
cmd.c global: replace references to 'sha1' with 'oid' 2020-10-20 23:57:12 +02:00
cmd.h cmd: no need for pre function hook now 2015-08-14 15:54:32 +02:00
configfile.c configfile: fix EOF handling 2016-10-01 11:43:33 +01:00
configfile.h Use strbuf for reading configuration files 2013-08-12 13:14:10 -06:00
favicon.ico Add favicon 2013-05-31 02:52:24 +02:00
filter.c filter: pipe_fh should be local 2017-10-14 16:13:07 +02:00
gen-version.sh gen-version.sh: check if git is available before trying to call it 2014-02-05 15:09:15 +01:00
html.c html: fix handling of null byte 2022-12-19 16:13:58 +01:00
html.h html: html_ntxt with no ellipsis 2017-10-03 19:19:34 +01:00
parsing.c global: replace hard coded hash length 2020-10-20 23:57:12 +02:00
robots.txt ui-tree,ui-blame: bail from blame if blob is binary 2022-12-19 15:14:05 +01:00
scan-tree.c git: update to v2.14 2017-08-10 15:58:24 +02:00
scan-tree.h Add support for 'project-list' option 2010-08-04 03:09:32 +02:00
shared.c shared: fix bad free in cgit_diff_tree 2022-12-19 15:09:34 +01:00
ui-atom.c global: use release_commit_memory() 2022-12-19 16:13:58 +01:00
ui-atom.h global: make 'char *path' const where possible 2019-06-05 15:37:49 +02:00
ui-blame.c ui-blame: add a link to the parent commit in blame 2022-12-19 16:13:58 +01:00
ui-blame.h ui-blame: add blame UI 2017-10-03 19:19:34 +01:00
ui-blob.c git: update to v2.32.0 2021-06-08 12:37:46 +02:00
ui-blob.h readme: use string_list instead of space deliminations 2013-05-26 16:30:03 +02:00
ui-clone.c git: update to v2.19.1 2018-10-12 23:06:02 +02:00
ui-clone.h Switch to exclusively using global ctx 2014-01-17 00:44:54 +01:00
ui-commit.c ui-commit: use git raw note format 2022-12-19 16:13:24 +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 global: replace references to 'sha1' with 'oid' 2020-10-20 23:57:12 +02:00
ui-diff.h git: update to v2.10.0 2016-09-04 12:38:18 +02:00
ui-log.c global: use release_commit_memory() 2022-12-19 16:13:58 +01:00
ui-log.h global: make 'char *path' const where possible 2019-06-05 15:37:49 +02:00
ui-patch.c global: replace hard coded hash length 2020-10-20 23:57:12 +02:00
ui-patch.h ui-patch: Rename variables 2013-08-20 19:55:54 +02:00
ui-plain.c git: update to v2.32.0 2021-06-08 12:37:46 +02:00
ui-plain.h Switch to exclusively using global ctx 2014-01-17 00:44:54 +01:00
ui-refs.c global: make 'char *path' const where possible 2019-06-05 15:37:49 +02:00
ui-refs.h Fix missing prototype declarations 2016-01-14 14:02:29 +01:00
ui-repolist.c ui-repolist,ui-shared: remove redundant title on repo anchors 2022-12-19 16:13:24 +01:00
ui-repolist.h Fix missing prototype declarations 2016-01-14 14:02:29 +01:00
ui-shared.c config: make empty js= omit script tag 2023-01-10 17:52:54 +01:00
ui-shared.h auth-filter: pass url with query string attached 2018-11-25 06:01:34 +01:00
ui-snapshot.c git: update to v2.29.0 2020-10-19 20:27:28 +02:00
ui-snapshot.h Remove unused parameter from cgit_print_snapshot() 2014-02-21 18:19:00 +01:00
ui-ssdiff.c ui-ssdiff: ban strncat() 2019-06-05 15:37:49 +02:00
ui-ssdiff.h Fix missing prototype declarations 2016-01-14 14:02:29 +01:00
ui-stats.c global: use release_commit_memory() 2022-12-19 16:13:58 +01:00
ui-stats.h ui-stats: make cgit_period definitions 'static const' 2015-03-09 17:40:02 +01:00
ui-summary.c global: make 'char *path' const where possible 2019-06-05 15:37:49 +02:00
ui-summary.h global: make 'char *path' const where possible 2019-06-05 15:37:49 +02:00
ui-tag.c global: replace references to 'sha1' with 'oid' 2020-10-20 23:57:12 +02:00
ui-tag.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-tree.c ui-tree: show symlink targets in tree listing 2022-12-19 15:22:52 +01:00
ui-tree.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00

README

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_PKGCONFIG=lua5.1

If this is not specified, the Lua implementation will be auto-detected,
preferring LuaJIT if many are present. Acceptable values are generally "lua",
"luajit", "lua5.1", and "lua5.2".


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

* libzip
* libcrypto (OpenSSL)
* libssl (OpenSSL)
* optional: luajit or lua, most reliably used when pkg-config is available

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 <https://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
  <https://lists.zx2c4.com/mailman/listinfo/cgit>