repo2html/README.md

repo2html

a post-receive hook that generates an html view of a git repository.

features

• static html files
• no background process other than git-daemon
• default repository view is an html-rendered README.md file

caveats

• binary file contents are just... shown
• images don't render
• directory tree is shown as a flat list of files, so git repositories with many files and directories will look awful
• no commit log (yet?)
• no line numbers (yet?)

disclaimer

no one is liable if this software breaks, deletes, corrupts, or ruins anything

requirements

• chicken scheme
• utf8 egg
• lowdown egg
• git

note: if you have chicken scheme installed, then you can install the eggs above by running sudo make dependencies.

quickstart

on your server, run the following commands, changing anything occurs between angled brackets ("<" and ">"):
adduser git
mkdir /var/www/git
chown git:git /var/www/git
cp git-daemon.service /etc/systemd/system/
ufw allow 9418
systemctl enable --now git-daemon.service
su - git
mkdir projects
clone this repository
cd into this repository
sudo make dependencies
make
sudo make install
edit the post-receive file
cp post-receive <path/to/bare/git/repository>/hooks/
chmod u+x <path/to/bare/git/repository>/hooks/post-receive
then in a git repository on your local machine, run git remote add origin git@<example.com>:~/projects/<repository-name>
git push

compilation

chicken scheme runs faster if it's compiled to a binary file. by default, the binary is named repo2html, and is added to /usr/local/bin.

to compile repo2html into a binary file, follow the steps below:

1. ensure you're in the repo2html git repository
2. run make dependencies as root
3. run make
4. run make install as root

server setup

TODO (git user, ssh, ufw ports, web directory, git-daemon, mkdir /home/git/projects, post-receive hook, systemd service)

usage

after you've set up your server and set your remote git url on your local machine, you can use git push to push updates to your projects, and the post-receive hook will generate an html version of your git repository.

configuration

you can configure repo2html by changing environment variables in the post-receive hook file.

refer to the list of environment variable names and their descriptions to learn more:

• GIT_WWW: the web directory where repo2html generates static git repositories. for example, /var/www/git/.
• GIT_WWW_CLONE_URL: the url that people will use when downloading your git repository. if you have git-daemon set up, then you can prefix the url with git://. otherwise, prefix the url with http://. for example, git://git.example.com. note: avoid a trailing slash in the url.
• GIT_WWW_TITLE: the text that populates the <title> html tag.
• GIT_WWW_DESCRIPTION: a string that populates the description meta information about your git repository.
• GIT_WWW_H1: the text that populates the <h1> html tag.

todos

• ☐ if no README.md file exists in the root directory of the repository, then don't create the "about" nav link. instead, make the files page the index.html
• ☐ add a "license" nav link if a LICENSE file exists in the root directory of the repository. if no LICENSE file exists, then don't create the "license" nav link
• ☐ add a "contributors" nav link

hopes

• ☐ clickable line numbers in source files
• ☐ render images
• ☐ make repos with more files and directories less daunting (recursively generate a files list page for each directory in a repo?)
• ☐ nav link: Releases