Gitosis and Gitweb - Part 3
So we are setup, have a project, and have contributors via the first 2 parts.
I know that we are all enamored by the UI of GitHub.com. I am. Unfortunately you can’t get private repositories for free (In all fairness it’s only $7/mo. – a very wise investment). I am aware of Gitorious like I mentioned in the first part, but I have no experience with that. I will after this series and update this series if I find it better. Again, I like to use the simplest thing that works. (Of course, “simplest” is in the eye of the beholder)
In this section I’m going to show you how to install Gitweb, a UI tool that let’s you view your repositories. I’m also going to mention how to get it to auto-detect any new repositories and ensure they show up on the web UI. I learned how to do most of this from my co-worker Antony Messerli. He is a true Linux and problem-solving Jedi.
Install Apache
First, you need to ensure apache2 is installed. Check to see if you have an /etc/apache2 folder. If you do, you should be okay. If you don’t, you need to install it.
sudo apt-get install apache2
For more in-depth advice, I always reference the Slicehost Articles
Once you have that installed the daemon restarted, go to your slices ip address in the browser of your choice (i.e,. http://123.123.123.123) and you should something like “It Works”
Voila! You have apache running.
Install the Package
sudo apt-get install gitweb
This will install gitweb into /var/www/gitweb, create a conf file at /etc/gitweb.conf, and add three files to /usr/share/gitweb (git-favicon.png, git-logo.png, gitweb.css).
Note: If for some reason, the /var/www/gitweb folder is not created, you can clone the git source (git clone git://git.kernel.org/pub/scm/git/git.git) and then just copy the git/gitweb folder to /var/www/gitweb
cp -R git/gitweb /var/www/
You only need to edit the $projectroot variable in the /etc/gitweb.conf to point to your gitosis repositories folder:
# path to git projects (<project>.git)
$projectroot = "/home/git/repositories";
...
Since this isn’t a post about Apache, I just add the gitweb directory setup to the base Apache config. Since Ubuntu includes the entire /etc/apache2/conf.d directory, I just added the following information into /etc/apach2/conf.d/gitweb:
RewriteEngine on
RewriteRule ^/gitweb/([a-zA-Z0-9_\-]+\.git)/?(\?.*)?$ /cgi-bin/gitweb.cgi/$1 [L,PT]
Alias /gitweb /home/git/repositories
<Directory /home/git/repositories>
Options Indexes FollowSymlinks ExecCGI
DirectoryIndex /cgi-bin/gitweb.cgi
AllowOverride None
</Directory>
Restart Apache to make sure everything works
sudo /etc/init.d/apache2 restart
The first time you go to your website again, you’ll see Gitweb, but it’ll say no projects are available. Fix mentioned below.
Two Hacks (open to suggestions)
1. I had to copy the git-favicon.png, git-logo.png, gitweb.css files from /usr/share/gitweb to /var/www/gitweb/. (if you had to do what is mentioned in the Note above, you don’t have to do this, since the gitweb folder from the git source clone includes these files already)
2. I had to make the repositories that I wanted visible in gitweb have permissions of 755 (aka owner has read, write, execute. group and others have read, execute.)
sudo chmod -R 755 /git/repositories/lostechies.git
Once that was done I can see the repository and it’s information on Gitweb.
If you want to edit the project description from “Unnamed repository; edit this file ‘description’ to name the repository.” go to the repositories description file (/home/git/repositories/ lostechies.git/description for this repo) and edit the file and save.
Cron job
I, again with the leadership of Ant, utilized a cron job he wrote to automatically make the repositories have permissions of 755. I do have some repositories, like gitosis-admin, that I do not ever want visible on Gitweb. The cron job excludes them. Here is the cron job code, showing that I don’t want to show my personal.git and gitosis-admin.git repositories. This could be easily written in Ruby or any other “scripting language” of your choice:
#!/bin/sh
GITOSIS_REPO_PATH="/home/git/repositories"
GITOSIS_ADMIN_PATH="$GITOSIS_REPO_PATH/gitosis-admin.git"
PERSON_REPO_PATH="$GITOSIS_REPO_PATH/personal.git"
debug ()
{
echo "[D]: $1" > /dev/null
}
for dir in `find $GITOSIS_REPO_PATH -maxdepth 1 -mindepth 1 -type d`; do
if [ "$dir" != "$GITOSIS_ADMIN_PATH" ]; then
if [ "$dir" != "$PERSON_REPO_PATH" ]; then
`chmod -R 0755 $dir`
fi
fi
debug "All repositories have permissions set to 0755"
done
I chose bash, so that I could take that time to learn it. Translation: Find all the directories in my gitosis repository path (/home/git/repositories) and if they are not gitosis-admin or personal, change their permissions, recursively, to 0755.
I put this in a file called set_gitosis_permissions_to_view_on_gitweb.sh and put it in root’s home folder, /root. I then called the file from root’s crontab:
~ /> sudo su -
# /root > crontab -e
# m h dom mon dow command
*/5 * * * * /root/set_gitosis_permissions_to_view_on_gitweb.sh
This means that every 5 minutes, my bash file will set any new repositories to 0755. This is how to get Gitweb stood up. The next post will show how to hide it behind HTTP basic auth and a self-signed certificate.
Next Part: Hiding the Gitweb site
Comments
katy lavallee: Anxiously awaiting the next part :)
Thorpe: You said you chose Bash so that you could take some time to learn it. Unfortunately however, your shebang points to sh not bash. There is some differences.