A (static) git repository browser [mirror]
Go to file
Eric Sunshine 420afd3206 views: summary: suppress extra horizontal rule when no "master" branch
When a repository has a "master" branch, a short summary of its most
recent commits is shown, followed by a horizontal rule. If there is no
"master" branch, then the commit summary is suppressed, however, the
rule is shown unconditionally, which is ugly, particularly when there
is already a rule following the web_url/git_url block. Therefore,
suppress the "master" branch horizontal rule when not needed. (This is
analogous to how the rule following the web_url/git_url block is
suppressed when that information is not shown).

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Alberto Bertogli <albertito@blitiri.com.ar>
2015-01-11 21:18:06 +00:00
hooks Add a post-receive hook 2013-03-12 22:09:25 +00:00
static Show the age of a repository in the index, via javascript 2013-11-02 22:18:33 +00:00
views views: summary: suppress extra horizontal rule when no "master" branch 2015-01-11 21:18:06 +00:00
.gitignore Initial commit 2012-11-10 17:49:54 +00:00
git-arr git: Add '--' to "git rev-list" runs to avoid ambiguous arguments 2014-12-31 17:07:38 +00:00
git.py git: Add '--' to "git rev-list" runs to avoid ambiguous arguments 2014-12-31 17:07:38 +00:00
LICENSE Initial commit 2012-11-10 17:49:54 +00:00
README Add a note about pygments in the README 2012-11-21 00:29:43 +00:00
sample.conf sample.conf: document embed_markdown and embed_images 2015-01-11 21:18:00 +00:00
TODO Initial commit 2012-11-10 17:49:54 +00:00
utils.py Enable line number anchors when using pygments HtmlFormatter 2014-07-03 00:56:19 +01:00

git-arr - A git repository browser
----------------------------------

git-arr is a git repository browser that can generate static HTML instead of
having to run dynamically.

It is smaller, with less features and a different set of tradeoffs than
other similar software, so if you're looking for a robust and featureful git
browser, please look at gitweb or cgit instead.

However, if you want to generate static HTML at the expense of features, then
it's probably going to be useful.

It's open source under the MIT licence, please see the LICENSE file for more
information.


Getting started
---------------

You will need Python, and the bottle.py framework (the package is usually
called python-bottle in most distributions).

If pygments is available, it will be used for syntax highlighting, otherwise
everything will work fine, just in black and white.


First, create a configuration file for your repositories. You can start by
copying sample.conf, which has the list of the available options.

Then, to generate the output to "/var/www/git-arr/" directory, run:

  $ ./git-arr --config config.conf generate --output /var/www/git-arr/

That's it!

The first time you generate, depending on the size of your repositories, it
can take some time. Subsequent runs should take less time, as it is smart
enough to only generate what has changed.


You can also use git-arr dynamically, although it's not its intended mode of
use, by running:

  $ ./git-arr --config config.conf serve

That can be useful when making changes to the software itself.


Contact
-------

If you want to report bugs, send patches, or have any questions or comments,
just let me know at albertito@blitiri.com.ar.