1
0
mirror of https://gitea.quitesimple.org/crtxcr/cgitsb synced 2024-11-23 00:12:10 +01:00
Go to file
John Keeping 48f175083a Makefile: drive asciidoc directly for HTML output
This is mostly taken from Git's doc/Makefile, although simplified for
our use.  The output now uses Asciidoc's default CSS which I think looks
a bit nicer than the Docbook formatting; as a result of this we no
longer need our custom .css file.

A side effect of this change is that temporary files generated from the
HTML output no longer conflict with the manpage output format (because
any temporary HTML output files use names derived from the output
filename which includes .html).

Signed-off-by: John Keeping <john@keeping.me.uk>
2018-06-16 14:06:03 +01:00
contrib/hooks
filters ui-blame: Allow syntax highlighting 2018-01-19 11:40:58 +01:00
git@2512f15446 git: update to v2.16.0 2018-01-19 11:34:43 +01:00
tests global: spelling fixes 2017-10-15 18:44:55 +02:00
.gitignore
.gitmodules
.mailmap
AUTHORS
cache.c global: spelling fixes 2017-10-15 18:44:55 +02:00
cache.h global: spelling fixes 2017-10-15 18:44:55 +02:00
cgit.c cgit: prepare repo before error pages 2018-02-12 23:25:29 +01:00
cgit.css ui-blame: Allow syntax highlighting 2018-01-19 11:40:58 +01:00
cgit.h filter: pipe_fh should be local 2017-10-14 16:13:07 +02:00
cgit.mk ui-blame: add blame UI 2017-10-03 19:19:34 +01:00
cgit.png
cgitrc.5.txt ui-blame: add blame UI 2017-10-03 19:19:34 +01:00
cmd.c ui-blame: add blame UI 2017-10-03 19:19:34 +01:00
cmd.h
configfile.c
configfile.h
COPYING
favicon.ico
filter.c filter: pipe_fh should be local 2017-10-14 16:13:07 +02:00
gen-version.sh
html.c
html.h
Makefile Makefile: drive asciidoc directly for HTML output 2018-06-16 14:06:03 +01:00
parsing.c parsing: don't clear existing state with empty input 2017-10-14 14:31:18 +02:00
README
robots.txt
scan-tree.c
scan-tree.h
shared.c git: update to v2.16.0 2018-01-19 11:34:43 +01:00
ui-atom.c
ui-atom.h
ui-blame.c ui-blame: Allow syntax highlighting 2018-01-19 11:40:58 +01:00
ui-blame.h ui-blame: add blame UI 2017-10-03 19:19:34 +01:00
ui-blob.c
ui-blob.h
ui-clone.c git: update to v2.15.1 2017-12-06 20:29:10 +01:00
ui-clone.h
ui-commit.c git: update to v2.16.0 2018-01-19 11:34:43 +01:00
ui-commit.h
ui-diff.c git: update to v2.16.0 2018-01-19 11:34:43 +01:00
ui-diff.h
ui-log.c git: update to v2.16.0 2018-01-19 11:34:43 +01:00
ui-log.h
ui-patch.c
ui-patch.h
ui-plain.c
ui-plain.h
ui-refs.c
ui-refs.h
ui-repolist.c
ui-repolist.h
ui-shared.c ui-shared: use type='search' for the search box 2017-10-15 18:43:57 +02:00
ui-shared.h ui-tree: link to blame UI if enabled 2017-10-03 19:19:34 +01:00
ui-snapshot.c
ui-snapshot.h
ui-ssdiff.c
ui-ssdiff.h
ui-stats.c
ui-stats.h
ui-summary.c
ui-summary.h
ui-tag.c
ui-tag.h
ui-tree.c ui-tree: link to blame UI if enabled 2017-10-03 19:19:34 +01:00
ui-tree.h

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>