tvl-depot/third_party/cgit
sterni 92a0d9f7da fix(3p/cgit): substitute newly supported compression tools
This code is copied from the cgit derivation in nixpkgs, seems like we
missed when these new compression methods were added.

Change-Id: I2d4118785abc173c86ac92e3007cd7027a1e0496
Reviewed-on: https://cl.tvl.fyi/c/depot/+/5637
Autosubmit: sterni <sternenseemann@systemli.org>
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
2022-05-19 09:23:43 +00:00
..
contrib/hooks merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
filters subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
tests subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
cache.c subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
cache.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
cgit.c subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
cgit.css subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
cgit.h subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
cgit.mk subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 fix(3p/cgit): substitute newly supported compression tools 2022-05-19 09:23:43 +00:00
filter.c subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
html.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00
Makefile subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
parsing.c merge(3p/cgit): subtree merge at adcc4f82 2020-11-21 20:09:33 +01:00
README subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
robots.txt subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
scan-tree.c subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 fix(3p/cgit): Fix bad free in cgit_diff_tree 2022-05-18 15:27:36 +00:00
tvl-extra.css feat(web/cgit): Use new logo in cgit page 2021-09-27 15:41:29 +00:00
ui-atom.c subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 chore(3p/cgit): git: update to v2.32.0 2021-09-21 14:14:08 +03: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 chore(3p/cgit): git: update to v2.32.0 2021-09-21 14:14:08 +03: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02: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 subtree(3p/cgit): merge cgit-pink into depot cgit 2022-05-19 10:45:02 +02:00
ui-tree.h merge(third_party/cgit): Import at master of 2020-01-11 2020-01-11 23:31:05 +00:00

cgit-pink - CGI for Git
=======================

This is a fork of cgit, 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).


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

* libzip
* libcrypto (OpenSSL)
* libssl (OpenSSL)

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-pink homepage is hosted by cgit at
  <https://git.causal.agency/cgit-pink/about>

* Patches, bug reports, discussions and support should go to the cgit-pink
  mailing list: <list+cgit@causal.agency>. Archives are available at:
  <https://causal.agency/list/cgit.html>