gitweb

Репозитории

Gitweb может отображать информацию из одного или нескольких Git-репозиториев. Эти репозитории должны находиться на локальном файловом хранилище и иметь общий корень репозитория, то есть все они должны находиться под одним родительским репозиторием (но см. также раздел «Расширенная настройка веб-сервера», подраздел «Настройка веб-сервера с несколькими корнями проектов»).

our $projectroot = '/path/to/parent/directory';

Значение по умолчанию для $projectroot — /pub/git. Вы можете изменить его во время сборки gitweb с помощью переменной конфигурации сборки GITWEB_PROJECTROOT.

По умолчанию все Git-репозитории в $projectroot отображаются и доступны gitweb. Список проектов по умолчанию генерируется путем сканирования каталога $projectroot на предмет Git-репозиториев (точнее, баз данных объектов; gitweb не интересует рабочая область и лучше всего подходит для отображения «голых» репозиториев).

Имя репозитория в gitweb — это путь к его $GIT_DIR (его базе данных объектов) относительно $projectroot. Таким образом, репозиторий $repo можно найти по адресу "$projectroot/$repo".

Формат файла списка проектов

Вместо того, чтобы gitweb находил репозитории, сканируя файловую систему, начиная с $projectroot, вы можете предоставить предварительно сгенерированный список видимых проектов, установив $projects_list на указание на текстовый файл со списком проектов (с дополнительной информацией).

Этот файл использует следующий формат:

Вы можете сгенерировать файл индекса списка проектов с помощью действия project_index (ссылка TXT на странице списка проектов) непосредственно из gitweb; см. также раздел «Генерация списка проектов с помощью gitweb» ниже.

Пример содержимого:

foo.git       Joe+R+Hacker+<joe@example.com>
foo/bar.git   O+W+Ner+<owner@example.org>

По умолчанию этот файл управляет только тем, какие проекты отображаются на странице списка проектов (обратите внимание, что записи, которые не указывают на правильно распознанные Git-репозитории, не будут отображаться gitweb). Даже если проект не отображается на странице списка проектов, вы можете просмотреть его вручную, создав URL gitweb. Установив переменную конфигурации $strict_export (см. gitweb.conf[5]) в истинное значение, можно разрешить просмотр только тех репозиториев, которые также отображаются на странице обзора (т. е. доступны только проекты, явно указанные в файле списка проектов).

Генерация списка проектов с помощью gitweb

Предполагается, что GITWEB_CONFIG имеет значение по умолчанию Makefile, а именно gitweb_config.perl. Поместите следующее в файл gitweb_make_index.perl.

read_config_file("gitweb_config.perl");
$projects_list = $projectroot;

Затем создайте следующий скрипт для получения списка проектов в формате, подходящем для переменной конфигурации сборки GITWEB_LIST (или переменной $projects_list в конфигурации gitweb):

#!/bin/sh

export GITWEB_CONFIG="gitweb_make_index.perl"
export GATEWAY_INTERFACE="CGI/1.1"
export HTTP_ACCEPT="*/*"
export REQUEST_METHOD="GET"
export QUERY_STRING="a=project_index"

perl -- /var/www/cgi-bin/gitweb.cgi

Запустите этот скрипт и сохраните его вывод в файл. Этот файл можно использовать в качестве файла списка проектов, что означает, что вы можете установить $projects_list на его имя файла.

Управление доступом к Git-репозиториям

По умолчанию все Git-репозитории в $projectroot видны и доступны gitweb. Однако вы можете настроить, как gitweb управляет доступом к репозиториям.

Настройка gitweb для каждого репозитория

Вы можете настроить отдельные репозитории, отображаемые в gitweb, создав файл в каталоге GIT_DIR Git-репозитория или установив переменную конфигурации репозитория (в GIT_DIR/config, см. git-config[1]).

В репозитории вы можете использовать следующие файлы:

Действия:

Стандартные действия:

Apache как CGI

Apache должен быть настроен для поддержки CGI-скриптов в каталоге, в котором установлен gitweb. Предположим, что это каталог /var/www/cgi-bin.

ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"

<Directory "/var/www/cgi-bin">
    Options Indexes FollowSymlinks ExecCGI
    AllowOverride None
    Order allow,deny
    Allow from all
</Directory>

С этой настройкой полный путь для просмотра репозиториев будет:

http://server/cgi-bin/gitweb.cgi

Apache с mod_perl, через ModPerl::Registry

Вы можете использовать mod_perl с gitweb. Вы должны установить Apache::Registry (для mod_perl 1.x) или ModPerl::Registry (для mod_perl 2.x), чтобы включить эту поддержку.

Предполагая, что gitweb установлен в /var/www/perl, следующая настройка Apache (для mod_perl 2.x) подходит.

Alias /perl "/var/www/perl"

<Directory "/var/www/perl">
    SetHandler perl-script
    PerlResponseHandler ModPerl::Registry
    PerlOptions +ParseHeaders
    Options Indexes FollowSymlinks +ExecCGI
    AllowOverride None
    Order allow,deny
    Allow from all
</Directory>

С этой настройкой полный путь для просмотра репозиториев будет:

http://server/perl/gitweb.cgi

Apache с FastCGI

Gitweb работает с Apache и FastCGI. Сначала вам нужно переименовать, скопировать или создать символическую ссылку gitweb.cgi на gitweb.fcgi. Предположим, что gitweb установлен в /usr/share/gitweb каталоге. Следующая настройка Apache подходит (НЕ ТЕСТИРОВАЛОСЬ!)

FastCgiServer /usr/share/gitweb/gitweb.cgi
ScriptAlias /gitweb /usr/share/gitweb/gitweb.cgi

Alias /gitweb/static /usr/share/gitweb/static
<Directory /usr/share/gitweb/static>
    SetHandler default-handler
</Directory>

С этой настройкой полный путь для просмотра репозиториев будет:

http://server/gitweb

Один URL для gitweb и для скачивания

Если вы хотите иметь один URL для gitweb и ваших http:// репозиториев, вы можете настроить Apache так:

<VirtualHost *:80>
    ServerName    git.example.org
    DocumentRoot  /pub/git
    SetEnv        GITWEB_CONFIG   /etc/gitweb.conf

    # turning on mod rewrite
    RewriteEngine on

    # make the front page an internal rewrite to the gitweb script
    RewriteRule ^/$  /cgi-bin/gitweb.cgi

    # make access for "dumb clients" work
    RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ \
                /cgi-bin/gitweb.cgi%{REQUEST_URI}  [L,PT]
</VirtualHost>

Вышеуказанная конфигурация предполагает, что ваши публичные репозитории находятся в /pub/git и будут обслуживаться как http://git.domain.org/dir-under-pub-git, как клонируемый URL Git, так и как браузерный интерфейс gitweb. Если вы затем запустите git-daemon[1] с --base-path=/pub/git --export-all, то вы даже сможете использовать URL git:// с точно таким же путем.

Установка переменной окружения GITWEB_CONFIG сообщит gitweb использовать указанный файл (т.е. в данном примере /etc/gitweb.conf) в качестве конфигурации для gitweb. Вам, по сути, не нужно это в примере выше; это требуется только если ваш конфигурационный файл находится в другом месте, чем встроенный (при компиляции gitweb) gitweb_config.perl или /etc/gitweb.conf. Смотрите gitweb.conf[5] для подробностей, особенно по правилам приоритета.

Если вы используете правила перенаправления из примера, вам, возможно, также потребуется что-то вроде следующего в вашем файле конфигурации gitweb (/etc/gitweb.conf следующий пример):

@stylesheets = ("/some/absolute/path/gitweb.css");
$my_uri    = "/";
$home_link = "/";
$per_request_config = 1;

Однако в настоящее время gitweb должен создавать тег HTML base при необходимости (для установки базового URI для относительных ссылок), поэтому он должен работать автоматически.

Настройка веб-сервера с несколькими корнями проекта

Если вы хотите использовать gitweb с несколькими корнями проекта, вы можете изменить ваши файлы виртуального хоста Apache и конфигурации gitweb следующим образом.

Конфигурация виртуального хоста (в файле конфигурации Apache) должна выглядеть так:

<VirtualHost *:80>
    ServerName    git.example.org
    DocumentRoot  /pub/git
    SetEnv        GITWEB_CONFIG  /etc/gitweb.conf

    # turning on mod rewrite
    RewriteEngine on

    # make the front page an internal rewrite to the gitweb script
    RewriteRule ^/$  /cgi-bin/gitweb.cgi  [QSA,L,PT]

    # look for a public_git directory in unix users' home
    # http://git.example.org/~<user>/
    RewriteRule ^/\~([^\/]+)(/|/gitweb.cgi)?$        /cgi-bin/gitweb.cgi \
                [QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]

    # http://git.example.org/+<user>/
    #RewriteRule ^/\+([^\/]+)(/|/gitweb.cgi)?$        /cgi-bin/gitweb.cgi \
                 [QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]

    # http://git.example.org/user/<user>/
    #RewriteRule ^/user/([^\/]+)/(gitweb.cgi)?$        /cgi-bin/gitweb.cgi \
                 [QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]

    # defined list of project roots
    RewriteRule ^/scm(/|/gitweb.cgi)?$ /cgi-bin/gitweb.cgi \
                [QSA,E=GITWEB_PROJECTROOT:/pub/scm/,L,PT]
    RewriteRule ^/var(/|/gitweb.cgi)?$ /cgi-bin/gitweb.cgi \
                [QSA,E=GITWEB_PROJECTROOT:/var/git/,L,PT]

    # make access for "dumb clients" work
    RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ \
                /cgi-bin/gitweb.cgi%{REQUEST_URI}  [L,PT]
</VirtualHost>

Здесь фактический корень проекта передаётся gitweb через GITWEB_PROJECT_ROOT переменную окружения от веб-сервера, поэтому вам нужно добавить следующую строку в файл конфигурации gitweb (/etc/gitweb.conf в примере выше):

$projectroot = $ENV{'GITWEB_PROJECTROOT'} || "/pub/git";

Примечание, что это должно быть установлено для каждого запроса, поэтому либо $per_request_config должно быть false, либо вышеупомянутое должно быть помещено в код, на который ссылается $per_request_config;

Эти конфигурации позволяют сделать два действия. Во-первых, каждый пользователь unix (<user>) сервера сможет просматривать через gitweb репозитории Git, найденные в ~/public_git/ по следующему URL:

http://git.example.org/~<user>/

Если вы не хотите этой функции на вашем сервере, просто удалите второе правило перенаправления.

Если вы уже используете mod_userdir в вашем виртуальном хосте или не хотите использовать «~» в качестве первого символа, просто прокомментируйте или удалите второе правило перенаправления и раскомментируйте одно из следующих, в зависимости от того, что вы хотите.

Во-вторых, репозитории, найденные в /pub/scm/ и /var/git/, будут доступны через http://git.example.org/scm/ и http://git.example.org/var/. Вы можете добавлять столько корней проекта, сколько вам нужно, добавляя правила перенаправления, как третье и четвёртое.

Использование PATH_INFO

Если вы включите использование PATH_INFO в gitweb, поместив

$feature{'pathinfo'}{'default'} = [1];

в ваш файл конфигурации gitweb, можно настроить сервер, чтобы он потреблял и генерировал URL-адреса в виде

http://git.example.com/project.git/shortlog/sometag

т.е. без части gitweb.cgi, используя конфигурацию, такую как следующая. Эта конфигурация предполагает, что /var/www/gitweb - это DocumentRoot вашего веб-сервера, содержит скрипт gitweb.cgi и вспомогательные статические файлы (стили, favicon, JavaScript):

<VirtualHost *:80>
        ServerAlias git.example.com

        DocumentRoot /var/www/gitweb

        <Directory /var/www/gitweb>
                Options ExecCGI
                AddHandler cgi-script cgi

                DirectoryIndex gitweb.cgi

                RewriteEngine On
                RewriteCond %{REQUEST_FILENAME} !-f
                RewriteCond %{REQUEST_FILENAME} !-d
                RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
        </Directory>
</VirtualHost>

Правило перенаправления гарантирует, что существующие статические файлы будут правильно обслуживаться, а любой другой URL будет передан gitweb в качестве параметра PATH_INFO.

Обратите внимание, что в этом случае вам не нужны особые настройки для @stylesheets, $my_uri и $home_link, но вы теряете доступ «глупого клиента» к вашим проектам .git (описано в разделе «Один URL для gitweb и для скачивания»). Возможным решением для последнего является следующее: в вашем корневом каталоге проекта (например, /pub/git) имейте проекты, именованные **без** расширения .git (например, /pub/git/project вместо /pub/git/project.git) и настройте Apache следующим образом:

<VirtualHost *:80>
        ServerAlias git.example.com

        DocumentRoot /var/www/gitweb

        AliasMatch ^(/.*?)(\.git)(/.*)?$ /pub/git$1$3
        <Directory /var/www/gitweb>
                Options ExecCGI
                AddHandler cgi-script cgi

                DirectoryIndex gitweb.cgi

                RewriteEngine On
                RewriteCond %{REQUEST_FILENAME} !-f
                RewriteCond %{REQUEST_FILENAME} !-d
                RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
        </Directory>
</VirtualHost>

Дополнительное AliasMatch делает так, что

http://git.example.com/project.git

обеспечит прямой доступ к каталогу Git проекта (чтобы проект можно было клонировать), а

http://git.example.com/project

предоставит доступ через удобный для человека интерфейс gitweb.

Это решение не на 100% защищено от ошибок, в том смысле, что если у проекта есть именованная ссылка (ветвь, тег), начинающаяся с git/, то пути, такие как

http://git.example.com/project/command/abranch..git/abranch

будут возвращать ошибку 404.