about summary refs log tree commit diff
path: root/README.MD
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.MD
parentFix changes after rebasing on upstream cgit (diff)
downloadcgit-magenta-1.5.0.tar.xz
CGit-magenta 1.5.0
Diffstat (limited to '')
-rw-r--r--README.MD (renamed from README)21
1 files changed, 12 insertions, 9 deletions
diff --git a/README b/README.MD

index 2094b87..1870e16 100644 --- a/README +++ b/README.MD
@@ -1,7 +1,7 @@ -cgit-pink - CGI for Git +cgit-magenta - CGI for Git ======================= -This is a fork of cgit, an attempt to create a fast web interface +This is a fork of cgit-pink, an attempt to create a fast web interface for the Git SCM, using a built-in cache to decrease server I/O pressure. @@ -14,20 +14,26 @@ 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: +```shell $ 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: +```shell $ make get-git +``` When either a) or b) has been performed, you can build and install cgit like this: +```shell $ 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` @@ -46,14 +52,14 @@ Apache configuration A new `Directory` section must probably be added for cgit, possibly something like this: - +```xml <Directory "/var/www/htdocs/cgit/"> AllowOverride None Options +ExecCGI Order allow,deny Allow from all </Directory> - +``` Runtime configuration --------------------- @@ -80,9 +86,6 @@ the HTTP headers `Modified` and `Expires`. Online presence --------------- -* The cgit-pink homepage is hosted by cgit at - <https://git.causal.agency/cgit-pink/about> +* The cgit-magenta homepage is hosted by cgit at [cgit.rory.gay](https://cgit.rory.gay/cgit-magenta.git/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> +* Patches, bug reports, discussions and support should go to the cgit-magenta [Matrix room](https://matrix.to/#/%23cgit-magenta%3Arory.gay?via=rory.gay).