tvl-depot/third_party/cgit
Todd Zullinger 35630558ff test(3p/cgit): t0107: support older and/or non-GNU tar
The untar tests for various compression algorithms use shortcut options
from GNU tar to handle decompression.  These options may not be provided
by non-GNU tar nor even by slightly older GNU tar versions which ship on
many systems.

An example of the latter case is the --zstd option.  This was added in
GNU tar-1.32 (2019-02-23)¹.  This version of tar is not provided by
CentOS/RHEL, in particular.  In Debian, --zstd has been backported to
the tar-1.30 release.

Avoid the requirement on any specific implementations or versions of tar
by piping decompressed output to tar.  This is compatible with older GNU
tar releases as well as tar implementations from other vendors.  (It may
also be a slight benefit that this more closely matches what the
snapshot creation code does.)

¹ Technically, the --zstd option was first released in tar-1.31
  (2019-01-02), but this release was very short-lived and is no longer
  listed on the GNU Tar release page.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Change-Id: Ib65412cd1d23312ddd4cf840c09efc32512d3122
2021-09-21 14:14:05 +03:00
..
contrib/hooks merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
filters refactor(3p/cgit): md2html: use sane_lists extension 2021-09-21 14:10:17 +03:00
tests test(3p/cgit): t0107: support older and/or non-GNU tar 2021-09-21 14:14:05 +03:00
.gitignore merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
.mailmap merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
.skip-subtree feat(third_party/cgit): Add derivation to build cgit 2020-01-12 02:49:44 +00:00
AUTHORS merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
cache.c chore(3p/cgit): git: update to v2.30.0 2021-09-21 14:10:15 +03:00
cache.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
cgit.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
cgit.css merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
cgit.h merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
cgit.mk merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
cgit.png merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
cgitrc.5.txt merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
cmd.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
cmd.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
configfile.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
configfile.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
COPYING merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
default.nix refactor(third_party): Consistent use of depot.third_party vs. pkgs 2021-04-10 11:48:55 +00:00
favicon.ico merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
filter.c fix(3p/cgit): Fix compilation under Clang 2020-06-03 02:24:00 +01:00
gen-version.sh merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
html.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
html.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
Makefile chore(3p/cgit): git: update to v2.30.0 2021-09-21 14:10:15 +03:00
parsing.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
README merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
robots.txt merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
scan-tree.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
scan-tree.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
shared.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
tvl-extra.css feat(3p/cgit): Highlight cheddar callout in about views 2021-09-15 13:53:28 +00:00
ui-atom.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-atom.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-blame.c chore(3p/cgit): git: update to v2.30.0 2021-09-21 14:10:15 +03:00
ui-blame.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-blob.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-blob.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-clone.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-clone.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-commit.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-commit.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-diff.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-diff.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-log.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-log.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-patch.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-patch.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-plain.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-plain.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-refs.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-refs.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-repolist.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-repolist.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-shared.c chore(3p/cgit): git: update to v2.30.0 2021-09-21 14:10:15 +03:00
ui-shared.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-snapshot.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-snapshot.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-ssdiff.c merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-ssdiff.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-stats.c chore(3p/cgit): git: update to v2.30.0 2021-09-21 14:10:15 +03:00
ui-stats.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-summary.c feat(third_party/cgit): Use README at each subtree 2020-01-11 23:47:39 +00:00
ui-summary.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-tag.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-tag.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
ui-tree.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
ui-tree.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00: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_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>