a gopher interface forked from the popular cgit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
KatolaZ 220cb74d33 change return type of gopher_include to int 3 years ago
contrib/hooks contrib/hooks: add sample post-receive hook using agefile 7 years ago
filters auth-filters: add simple file-based authentication scheme 4 years ago
git@53f9a3e157 git: update to v2.18.0 4 years ago
tests global: spelling fixes 5 years ago
.gitignore added comment in NOTE_70 4 years ago
.gitmodules Use https for submodule 5 years ago
.mailmap Update .mailmap with my new email address 5 years ago
AUTHORS added readme stuff 4 years ago
AUTHORS_70 added readme stuff 4 years ago
COPYING Update COPYING 4 years ago
Makefile merging upstream 1.2.1 4 years ago
NOTES_70 added comment in NOTE_70 4 years ago
README added readme stuff 4 years ago
README_70 added README_70 4 years ago
cache.c cache: close race window when unlocking slots 4 years ago
cache.h global: spelling fixes 5 years ago
cgit-70.c removed http_headers if repos are not present 3 years ago
cgit.c config: record repo.snapshot-prefix in the per-repo config 4 years ago
cgit.css css: use correct size in annotated decoration 4 years ago
cgit.h first commit on cgit_70 -- repolist, summary 4 years ago
cgit.mk ui-blame: add blame UI 5 years ago
cgit.png shrink cgit.png file size 7 years ago
cgit_70.mk also tags work 4 years ago
cgitrc.5.txt cgitrc.5: add local tar signature example 4 years ago
cmd.c ui-blame: add blame UI 5 years ago
cmd.h cmd: no need for pre function hook now 7 years ago
cmd_70.c fixed repo and summary header 4 years ago
configfile.c configfile: fix EOF handling 6 years ago
configfile.h Use strbuf for reading configuration files 9 years ago
favicon.ico Add favicon 9 years ago
filter.c filter: pipe_fh should be local 5 years ago
gen-version.sh gen-version.sh: check if git is available before trying to call it 9 years ago
html.c html: html_ntxt with no ellipsis 5 years ago
html.h html: html_ntxt with no ellipsis 5 years ago
parsing.c git: update to v2.18.0 4 years ago
robots.txt robots.txt: disallow access to snapshots 9 years ago
scan-tree.c git: update to v2.14 5 years ago
scan-tree.h Add support for 'project-list' option 12 years ago
shared.c Fix gcc 8.1.1 compiler warnings 4 years ago
shared_70.c first commit on cgit_70 -- repolist, summary 4 years ago
ui-atom.c ui-atom: properly escape delimiter in page link 5 years ago
ui-atom.h Add atom-support 14 years ago
ui-blame.c git: update to v2.18.0 4 years ago
ui-blame.h ui-blame: add blame UI 5 years ago
ui-blob.c git: update to v2.18.0 4 years ago
ui-blob.h readme: use string_list instead of space deliminations 9 years ago
ui-clone.c clone: fix directory traversal 4 years ago
ui-clone.h Switch to exclusively using global ctx 9 years ago
ui-commit.c git: update to v2.18.0 4 years ago
ui-commit.h ui-commit: Limit diff based on path limit in qry.path 12 years ago
ui-diff.c git: update to v2.18.0 4 years ago
ui-diff.h git: update to v2.10.0 6 years ago
ui-log.c git: update to v2.18.0 4 years ago
ui-log.h ui-log: Add "commit-sort" option for controlling commit ordering 10 years ago
ui-patch.c cache: flush stdio before restoring FDs 5 years ago
ui-patch.h ui-patch: Rename variables 9 years ago
ui-plain.c git: update to v2.18.0 4 years ago
ui-plain.h Switch to exclusively using global ctx 9 years ago
ui-refs.c ui-refs: use shared function to print tag downloads 4 years ago
ui-refs.h Fix missing prototype declarations 7 years ago
ui-repolist.c global: remove functionality we deprecated for cgit v1.0 4 years ago
ui-repolist.h Fix missing prototype declarations 7 years ago
ui-shared.c Fix gcc 8.1.1 compiler warnings 4 years ago
ui-shared.h ui-shared: pass separator in to cgit_print_snapshot_links() 4 years ago
ui-shared_70.c first commit on cgit_70 -- repolist, summary 4 years ago
ui-shared_70.h first commit on cgit_70 -- repolist, summary 4 years ago
ui-snapshot.c snapshot: support tar signature for compressed tar 4 years ago
ui-snapshot.h Remove unused parameter from cgit_print_snapshot() 8 years ago
ui-ssdiff.c Fix gcc 8.1.1 compiler warnings 4 years ago
ui-ssdiff.h Fix missing prototype declarations 7 years ago
ui-stats.c forms: action should not be empty 6 years ago
ui-stats.h ui-stats: make cgit_period definitions 'static const' 7 years ago
ui-summary.c ui-summary: send images plain for about page 7 years ago
ui-summary.h Fix missing prototype declarations 7 years ago
ui-tag.c ui-shared: pass separator in to cgit_print_snapshot_links() 4 years ago
ui-tag.h Add separate header-files for each page/view 14 years ago
ui-tree.c git: update to v2.18.0 4 years ago
ui-tree.h Add separate header-files for each page/view 14 years ago
ui_70-commit.c removed patch display from commit page 4 years ago
ui_70-diff.c added my name to copyright statements -- few tweaks 4 years ago
ui_70-log.c towards pager support 4 years ago
ui_70-patch.c added my name to copyright statements -- few tweaks 4 years ago
ui_70-refs.c fixed link to full log list 4 years ago
ui_70-repolist.c fixed repo and summary header 4 years ago
ui_70-shared.c change return type of gopher_include to int 3 years ago
ui_70-shared.h patch and plain diff works 4 years ago
ui_70-summary.c another minor fix in index link 4 years ago
ui_70-tag.c also tags work 4 years ago
ui_70-tree.c fixed dir entries in tree view 4 years ago
ui_70_repolist.c first commit on cgit_70 -- repolist, summary 4 years ago

README

This is the original README for cgit. It is still mostly relevant for
cgit-70. More specific information about cgit-70 are available in
README_70.



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>