depot/third_party/tvl/third_party/cgit
Default email a291c8690a Project import generated by Copybara.
GitOrigin-RevId: e6e19f3d81a982a62e1bba08f0b4f7fdc21b4ea0
2022-05-19 16:39:52 +02:00
..
contrib/hooks Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
filters Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
tests Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
.gitignore Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
.mailmap Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
.skip-subtree Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
AUTHORS Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cache.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cache.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
cgit.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cgit.css Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cgit.h Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cgit.mk Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cgit.png Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
cgitrc.5.txt Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cmd.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
cmd.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
configfile.c Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
configfile.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
COPYING Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
default.nix Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
filter.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
gen-version.sh Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
html.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
html.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
Makefile Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
parsing.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
README Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
robots.txt Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
scan-tree.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
scan-tree.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
shared.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
tvl-extra.css Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-atom.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-atom.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-blame.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-blame.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-blob.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-blob.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-clone.c Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-clone.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-commit.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-commit.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-diff.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-diff.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-log.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-log.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-patch.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-patch.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-plain.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-plain.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-refs.c Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-refs.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-repolist.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-repolist.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-shared.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-shared.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-snapshot.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-snapshot.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-ssdiff.c Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-ssdiff.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-stats.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-stats.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-summary.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-summary.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-tag.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-tag.h Project import generated by Copybara. 2020-09-29 23:42:59 -04:00
ui-tree.c Project import generated by Copybara. 2022-05-19 16:39:52 +02:00
ui-tree.h Project import generated by Copybara. 2020-09-29 23:42:59 -04: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>