From: Aaron Taylor Date: Sun, 8 Nov 2020 14:55:27 +0000 (-0800) Subject: Updated README file. X-Git-Url: http://git.subgeniuskitty.com/gitweb-sgk/.git/commitdiff_plain/39b78f14d30409e642d2b4fbb75c3a5d9961c704 Updated README file. --- diff --git a/README.md b/README.md index 101f36f..58a1446 100755 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # Overview # This is a fork of `gitweb` containing customizations used on -. +. Changes include defaulting to side-by-side diffs, automatically displaying -README files when present, and a new summary page. +README files when present, and a new tree+readme page for 'summary' mode. + # Status # -Working. Tested on . +Working. Runs on Debian Linux. + # Instructions # The following instructions work on Debian 10. All paths are examples from -the SGK gitweb server located at . For more +the SGK gitweb server located at . For more details, including accompanying scripts, see sysadmin notes on -. +. ----- @@ -84,7 +86,7 @@ Create a Gitweb configuration file at `/etc/gitweb.conf`. For example, $feature{'highlight'}{'default'} = [1]; Create an Apache vhost definition among the Apache2 configuration files. For -the Debian 10 server that runs , this means +the Debian 10 server that runs , this means creating the file `/etc/apache2/sites-available/git.subgeniuskitty.com/conf` with the following contents. @@ -114,25 +116,25 @@ Clone a copy of the gitweb repository into the vhost's webroot. Ensure it is owned by an SSH-enabled user for management, and that permissions are suitable for reading by the Apache2 user, usually `www-data` on Debian. - mkdir -p /srv/apache2_vhosts - git clone /srv/git/gitweb-sgk /srv/apache2_vhosts/git.subgeniuskitty.com - chown -R ataylor:ataylor /srv/apache2_vhosts/git.subgeniuskitty.com + mkdir -p /srv/apache_vhosts + git clone /srv/git/gitweb-sgk /srv/apache_vhosts/git.subgeniuskitty.com + chown -R ataylor:ataylor /srv/apache_vhosts/git.subgeniuskitty.com In order to maintain a public/private split, gitweb only displays repos that have been cloned into `/srv/gitweb_cache`. Remember to set `.git/description` and `.git/category` for any repos cloned into this gitweb cache folder. - mkdir -p /srv/gitweb_cache - git clone /srv/git/repo_name /srv/gitweb_cache/repo_name - echo "A description goes here." > /srv/gitweb_cache/repo_name/.git/description - echo "Category" > /srv/gitweb_cache/repo_name/.git/category - printf '#!/usr/bin/bash\ncd /srv/gitweb_cache/repo_name/.git\ngit pull\n' > /srv/git/repo_name/hooks/post-update - chmod +x /srv/git/repo_name/hooks/post-update + mkdir -p /srv/gitweb_cache + git clone /srv/git/repo_name /srv/gitweb_cache/repo_name + echo "A description goes here." > /srv/gitweb_cache/repo_name/.git/description + echo "Category" > /srv/gitweb_cache/repo_name/.git/category + printf '#!/usr/bin/bash\ncd /srv/gitweb_cache/repo_name\ngit --git-dir=.git pull\n' > /srv/git/repo_name/hooks/post-update + chmod +x /srv/git/repo_name/hooks/post-update Turn everything on. - a2enmod cgi - a2enmod rewrite - a2ensite git.subgeniuskitty.com - systemctl reload apache2 + a2enmod cgi + a2enmod rewrite + a2ensite git.subgeniuskitty.com + systemctl reload apache2