about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorRory& <root@rory.gay>2025-03-12 07:03:11 +0100
committerRory& <root@rory.gay>2025-03-12 07:03:11 +0100
commitefa4b11f7bd90faa88c4f822ed990564f10f3687 (patch)
tree05a1c7d0f9eecaa229b53ab2fb6d1dc56e65e7aa /README
parentFix changes after rebasing on upstream cgit (diff)
downloadcgit-magenta-efa4b11f7bd90faa88c4f822ed990564f10f3687.tar.xz
CGit-magenta 1.5.0
Diffstat (limited to 'README')
-rw-r--r--README88
1 files changed, 0 insertions, 88 deletions
diff --git a/README b/README
deleted file mode 100644

index 2094b87..0000000 --- a/README +++ /dev/null
@@ -1,88 +0,0 @@ -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>