gitweb.conf(5) Manual Page

プロジェクトパスの前に付加されるファイルシステム絶対パス。リポジトリへのパスは $projectroot/$project です。 インストール時に $GITWEB_PROJECTROOT に設定します。gitwebがリポジトリを見つけるには、この変数を正しく設定する必要があります。

our $projectroot = "/srv/git";

http://git.example.com/gitweb.cgi?p=foo/bar.git

http://git.example.com/gitweb.cgi/foo/bar.git

プロジェクトを一覧表示するプレーンテキストファイルの名前、またはプロジェクトをスキャンするディレクトリの名前。

<URI-encoded filesystem path to repository> SP <URI-encoded repository owner>

$projects_list 変数が設定されていない場合、gitwebはファイルシステムを再帰的にスキャンしてGitリポジトリを探します。 $project_maxdepth は、 $projectroot (開始点)を基準にしてトラバーサル深度を制限するために使用されます。 これは、$project_maxdepth よりも $projectroot から離れているディレクトリがスキップされることを意味します。

この(変数の値のファイル名の)ファイルが(リポジトリに)存在する場合にのみリポジトリを表示します。この変数がtrueと評価された場合にのみ有効です。 GITWEB_EXPORT_OK を設定することにより、gitwebを構築するときに設定できます。 このパスは GIT_DIR からの相対パスです。 git-daemon[1] は、 --export-all で開始されていない限り、 git-daemon-export-ok を使用します。デフォルトでは、この変数は設定されていません。つまり、この機能はオフになっています。

表示するリポジトリを決定するために使用される関数。このサブルーチンは、プロジェクトへのフルパスという1つのパラメーターを受け取る必要があり、trueを返した場合、そのプロジェクトはプロジェクトリストに含まれ、 $export_ok と $projects_list と $projects_maxdepth とで説明されている他の要件を満たしている限り、gitwebからアクセスできます。例:

our $export_auth_hook = sub { return -e "$_[0]/git-daemon-export-ok"; };

our $export_ok = "git-daemon-export-ok";

概要ページにも表示されているリポジトリの表示のみを許可します。これにより、たとえば、 $ export_ok ファイルは、リポジトリが表示されているかどうかだけでなく、リポジトリが使用可能かどうかを判断します。 $projects_list がプロジェクトのリストを含むファイルを指している場合、リストされているリポジトリのみがgitwebで使用できます。 GITWEB_STRICT_EXPORT を介してgitwebの構築中に設定できます。デフォルトでは、この変数は設定されていません。つまり、プロジェクトリストページから非表示になっている(たとえば、 `$projects_listファイルにリストされいない)リポジトリに直接のアクセスができます。

使用するコアgit実行可能ファイル。デフォルトでは $GIT_BINDIR/git に設定されており、これはデフォルトで $(bindir)/git に設定されています。バイナリパッケージからインストールされたGitを使用する場合は、通常、これを /usr/bin/git に設定する必要があります。Webサーバーに適切なPATHが通っている場合、これは単に git になる可能性があります。 セキュリティの観点から、gitバイナリへの絶対パスを使用することをお勧めします。複数のGitバージョンがインストールされている場合は、gitバイナリへの絶対パスを使用して、使用するバージョンを選択できます。gitwebが機能するには、(正しく)設定する必要があります。

/etc/mime.types を試す前に、(ファイル名拡張子に基づいて)MIMEタイプを推測するために使用するファイル。 NOTE このパスは、相対的である場合、CGIスクリプトではなく、現在のGitリポジトリに相対的であると見なされます。 設定されていない場合、 /etc/mime.types のみが使用されます(/etc/mime.types がファイルシステムに存在する場合)。 mimetypesファイルが見つからない場合、ファイルの拡張子に基づくmimetypeの推測は無効になります。デフォルトでは設定されていません。

Path to the highlight executable to use (it must be the one from http://andre-simon.de/zip/download.php due to assumptions about parameters and output). By default set to highlight; set it to full path to highlight executable if it is not installed on your web server’s PATH. Note that highlight feature must be set for gitweb to actually use syntax highlighting.

our %highlight_ext;
$highlight_ext{'phtml'} = 'php';

スタイルシートのURIのリスト(ページのベースURIからの相対パス)。複数のスタイルシートを指定する場合があります。たとえば、 gitweb.css をベースとして使用し、サイト固有の変更を別のスタイルシートに追加して、gitwebのアップグレードを容易にします。 たとえば、あなたが site スタイルシートを追加するには以下のようにします

push @stylesheets, "gitweb-site.css";

Webサーバー上で git-logo.png を配置する場所を指定します。または、72x27サイズの汎用ロゴのURIを指します。この画像は、各gitwebページの右上隅に表示され、Atomフィードのロゴとして使用されます。 gitwebのベースURIからの相対パスです。 GITWEB_LOGO 変数を使用してgitwebを構築するときに調整できます。デフォルトでは static/git-logo.png に設定されています。

Webサーバー上で git-favicon.png を配置する場所を指します。または、 image/png タイプとして提供されるfaviconの汎用URIを指します。favicon(Webサイトアイコン)をサポートするWebブラウザーは、favicon(Webサイトアイコン)をブラウザーのURLバーに表示し、ブックマークのサイト名の横に表示する場合があります。gitwebのベースURIからの相対パスです。 GITWEB_FAVICON 変数を使用してビルド時に調整できます。 デフォルトでは static/git-favicon.png に設定されています。

Webサーバー上で gitweb.js を配置する場所を指します。より一般的には、gitwebで使用されるJavaScriptコードのURIを指します。 gitwebのベースURIを基準にしています。 GITWEB_JS ビルド時構成変数を使用してビルド時に設定できます。

すべてのページの上部にあるホームリンク(home link)のターゲット(パンくずリスト(breadcrumbs)ビューの最初の部分)。 デフォルトでは、現在のページの絶対URIに設定されます($my_uri 変数の値、または $my_uri が未定義または空の文字列の場合は / に設定されます)。

Label for the "home link" at the top of all pages, leading to $home_link (usually the main gitweb page, which contains the projects list). It is used as the first component of gitweb’s "breadcrumb trail": <home-link> / <project> / <action>. Can be set at build time using the GITWEB_HOME_LINK_STR variable. By default it is set to "projects", as this link leads to the list of projects. Another popular choice is to set it to the name of site. Note that it is treated as raw HTML so it should not be set from untrusted sources.

ホームリンクの前のパンくずリスト(breadcrumb trail)の先頭に、gitwebサーバーをホストする組織や部門など、gitwebプロジェクトリストの論理的に「上位」にあたるページに追加される追加のリンク。リストの各要素は配列への参照であり、要素0はリンクテキスト($home_link_str 相当)で、要素1はターゲットURL($home_link 相当)です。

    our @extra_breadcrumbs = (
      [ 'home' => 'https://www.example.org/' ],
      [ 'dev'  => 'https://dev.example.org/' ],
    );

Gitロゴリンク(または、別のロゴ画像を使用することを選択した場合はサイトのロゴ)の、URIとラベル(タイトル)。デフォルトでは、これらは両方ともGitホームページ https://git-scm.com を参照します。 過去には、 https://www.kernel.org のGitのドキュメントを参照していました。

ページタイトルに表示される、サイト名または組織名です。 ブックマークなどを分かりやすくするために、何か説明的なものに設定してください。 この変数が設定されていない場合、あるいは設定されていても、gitweb は SERVER_NAME CGI環境変数の値を使用して、サイト名を "$SERVER_NAME Git" に設定し、この環境変数が設定されていない場合(例: gitweb がスタンドアローンのスクリプトとして起動している場合など)は "Untitled Git" に設定します。

各ページの<head>セクションに含まれるHTMLスニペット。ビルド時に GITWEB_SITE_HTML_HEAD_STRING を使用して設定できます。 デフォルト値はありません。

各ページの先頭にインクルードされるHTMLを記述したファイル名。 gitweb.cgi スクリプトを含むディレクトリからの相対パスです。 ビルド時に GITWEB_SITE_HEADER を使用して設定することができる。デフォルト値はありません。

各ページの下部にインクルードされるHTMLを含むファイルの名前。 gitweb.cgi スクリプトを含むディレクトリに相対的です。ビルド時に GITWEB_SITE_FOOTER を使用して設定できます。 デフォルト値はありません。

存在すればgitwebプロジェクトの概要ページ(projects_list ビュー)にインクルードされるHTMLファイルの名前。 gitweb.cgi スクリプトを含むディレクトリに相対的です。デフォルト値は、 GITWEB_HOMETEXT 変数を使用してビルド時に調整できます。デフォルトでは indextext.html に設定されています。

プロジェクトリストの「説明」列の幅(文字数)。長い説明は切り捨てられます(単語の境界で切り取ろうと試みます)。完全な説明は、(通常はマウスオーバーで表示される)title属性にあります。デフォルトは25ですが、長いプロジェクトの説明を使用する場合は小さすぎる可能性があります。

プロジェクトリストページでのプロジェクトの順序のデフォルト値。これは、プロジェクトリストを明示的に並べ替えない場合に使用される順序を意味します(URLに o CGIクエリパラメータがない場合)。 有効な値は、「none」(並べ替えなし)、「project」(プロジェクトはプロジェクト名、つまり「$ projectroot」からのリポジトリへのパス)、「descr」(プロジェクトの説明)、「owner」、「age」(最新のコミットの日付) です。

mimetypeチェックで他のタイプが生成されない場合の、blob_plain (raw)ビューのデフォルトのmimetype。デフォルトでは "text/plain" です。 Gitwebは、 $mimetypes_file (設定されていてfileが存在する場合)と /etc/mime.types ファイルを使用して、ファイル名の拡張子に基づいて表示するファイルのmimetypeを推測します。( mime.types(5) manpage を参照してください。gitwebではファイル名拡張子ルールのみがサポートされています。)

テキストファイルのデフォルトの文字セット。これが設定されていない場合は、Webサーバー構成が使用されます。デフォルトでは設定されていません(unset)。

行にUTF-8以外の文字が含まれている場合、Gitwebはこの文字セットを想定します。フォールバックデコードはエラーチェックなしで使用されるため、「utf-8」にすることもできます。値は有効なエンコーディングである必要があります。 リストについては、 Encoding::Supported (3pm) の manpage を参照してください。デフォルトは「latin1」、別名「iso-8859-1」です。

git-diffおよびgit-diff-treeの検出オプションの名前を変更します。デフォルトは ('-M') です。コピーも検出するには ('-C') または ('-C', '-C'）に設定するか、名前変更を検出したくない場合は () 、つまり空のリストに設定します。

GitベースURLのリスト。これらのURL群は、プロジェクトの概要ページに表示される、プロジェクトを取得する場所を説明するURLを生成するために使用されます。このリストの各要素の完全なフェッチURLは $git_base_url/$project です。 複数のベースURLを設定できます(たとえば、1つは git:// プロトコル用、もう1つは http:// プロトコル用)。

プロジェクトリストページでカテゴリ別にプロジェクトをグループ化できるようにするかどうか。プロジェクトのカテゴリは、各リポジトリの構成の $GIT_DIR/category ファイル、または gitweb.category 変数によって決定されます。デフォルトでは無効になっています(0に設定)。

何も指定されていないプロジェクトのデフォルトカテゴリ。 これが空の文字列に設定されている場合、そのようなプロジェクトは未分類のままで、分類されたプロジェクトの上に表示されます。 プロジェクトカテゴリが有効になっている場合、つまり $projects_list_group_categories がtrueの場合にのみ使用されます。デフォルトでは "" (空文字列)に設定されています。

trueの場合、リポジトリ内のコンテンツがクロスサイトスクリプティング(XSS)攻撃を開始するのを防ぐために、一部のgitweb機能が無効になっています。リポジトリのコンテンツを信頼できない場合は、これをtrueに設定します。デフォルトではFalse(0に設定)。

gitwebクエリに応答する最大負荷を設定するために使用されます。サーバーの負荷がこの値を超えると、gitwebは「503 Service Unavailable」エラーを返します。 gitwebがその値を判別できない場合、サーバーの負荷は0と見なされます。 現在、Linuxでのみ動作し、 /proc/loadavg を使用します。 負荷は、システム上でアクティブなタスクの数 — 実際に実行されているプロセス — が最後の1分間に平均化されたものです。

trueの場合、プロジェクトリストページの最新のコミットの日付の列を省略します。リポジトリごとに少しのI/Oとフォークを節約できます。

trueの場合、リポジトリ所有者に関する情報を表示できなくなります。

これがコードへの参照に設定されている場合、リクエストごとに1回実行されます。この方法で、セッションごとに構成の一部を変更設定できます。たとえば、gitweb構成ファイルで以下のコードを使用する場合があります

our $per_request_config = sub {
        $ENV{GL_USER} = $cgi->remote_user || "gitweb";
};

Gitwebバージョン。gitweb.perlからgitweb.cgiを作成するときに自動的に設定されます。たとえば、あなたが変更したgitwebを実行している場合は、変更することをお勧めします。

our $version .= " with caching";

gitwebスクリプトの完全なURLと絶対URL。以前のバージョンのgitwebでは、これらの変数を設定する必要があるかもしれませんが、今では設定する必要はありません。 まだ設定する必要がある場合は、 $per_request_config を参照してください。

gitwebによって生成されたページ内の相対URLのベースURL(例えば、相対URLの場合は $logo 、 $favicon 、 @stylesheets)が必要で、空でないPATH_INFOを持つURLに対してのみ <base href="$base_url"> が必要でした。通常、gitwebはその値を正しく設定し、この変数に $my_uri や "/" などを設定する必要はありません。あなたがとにかくそれをオーバーライドする必要がある場合は、 $per_request_config を参照してください。

「blame」および「blame_incremental」ブロブビューを有効にし、各行にそれを変更した最後のコミットを表示します。 git-blame(1) を参照してください。 これはCPUに非常に負荷がかかる可能性があるため、デフォルトでは無効になっています。

「snapshot」アクションを有効にして構成します。これにより、ユーザーは、 git-archive(1) によって生成され、そして、場合によってはさらに圧縮された、任意のツリーまたはコミットの圧縮アーカイブをダウンロードできます。大規模なプロジェクトがある場合、これにより大量のトラフィックが発生する可能性があります。

grep検索を有効にします。これにより、現在選択されているツリー(ディレクトリ)内で指定の文字列を含むファイルが一覧表示されます。 git-grep(1) を参照してください。 もちろん、これは潜在的にCPUを集中的に使用する可能性があります。 デフォルトで有効になっています。

いわゆるpickaxe検索を有効にします。これにより、ファイル内の特定の文字列を導入または削除したコミットが一覧表示されます。 これは実用的で、「blame」アクションの非常に高速な代替手段ですが、それでもCPUに負荷がかかる可能性があります。 デフォルトで有効になっています。

ls -l と同様に、別の列の「ツリー」ビューにブロブ(通常のファイル)のサイズを表示できるようにします。 git-ls-tree(1) のmanpageにある -l オプションの説明を参照してください。これにはちょびっとI/Oコストがかかります。デフォルトで有効になっています。

コミットのリストを電子メール(プレーンテキスト)出力形式で表示する「パッチ」ビューを有効にして構成します。 git-format-patch(1) も参照してください。 この値は、「パッチ」ビューで生成されたパッチセット内のパッチの最大数です。 default フィールドを、パッチビューを無効にするための単一の項目を含むリストまたは空のリストに設定するか、制限を削除するために単一の負の数を含むリストに設定します。デフォルト値は16です。

アバター(avatar)のサポート。この機能を有効にすると、「shortlog」や「commit」などのビューに、各コミッターと作成者の電子メールに関連付けられたアバターが表示されます。

生成されたHTMLなどのコンテンツの電子メールアドレスを改訂します。これにより、Gitログの作者/コミッターおよびコメントセクションから取得された電子メールアドレスを不明瞭にします。 これは、アドレスを収集して悪用するWebクローラーを妨害することを目的としています。このようなクローラーはrobots.txtを尊重しない場合があります。 注意: ユーザーとユーザーツールもアドレスが編集されたものとして表示されることに注意してください。Gitwebがワークフローの最後のステップではない場合、後続のステップは、受け取った情報が編集されているために誤動作する可能性があります。デフォルトでは無効になっています。

「ブロブ」ビューでサーバー側構文ハイライトサポートします。$height_bin プログラムが使用可能である必要があるため(上記の「構成変数」セクションの、この変数の説明を参照)、デフォルトで無効になっています。

「ヘッド」リストにリモートヘッド(リモート追跡ブランチ)を表示できるようにします。ほとんどの場合、リモート追跡ブランチのリストは不要な内部プライベート詳細であるため、この機能はデフォルトで無効になっています。 git-instaweb(1) は、通常、ローカルリポジトリを参照するために使用され、この機能を有効にして使用します。

テキスト検索を有効にします。これにより、作者(author)または、コミッターまたは、コミットテキストが特定の文字列に一致するコミットが一覧表示されます。 git-log(1) のmanpage にある --author と --committer と --grep オプションの説明を参照してください。デフォルトで有効になっています。

この機能が有効になっている場合、gitwebは、プロジェクトルート(ベース名)のサブディレクトリ内のプロジェクトを既存のプロジェクトのフォークと見なします。 $projname.git プロジェクトごとに、 $projname/ ディレクトリ内のプロジェクトとそのサブディレクトリはメインプロジェクトリストに表示されません。代わりに、 $projname の横に + マークが表示されます。これは、すべてのフォーク($projname/ サブディレクトリ内のすべてのプロジェクト)を一覧表示する "forks" ビューにリンクしています。さらに、プロジェクトの「fork」ビューは、プロジェクトの概要ページからリンクされています。

すべてのプロジェクトページのアクションバーへのカスタムリンクを挿入します。これにより、あなたはgitwebに統合されているサードパーティのスクリプトにリンクできます。

$feature{'actions'}{'default'} =
        [ ('graphiclog', '/git-browser/by-commit.html?r=%n', 'summary')];

ページフッター(ページの下部)に各ページを生成して表示するのにかかった時間とGitコマンドの数を表示できるようにします。たとえば、フッターには次のように含まれます。「This page took 6.53325 seconds and 13 Git commands to generate.」(このページの生成には6.53325秒と13のGitコマンドが必要でした。)。デフォルトでは無効になっています。

JavaScriptを介してgitweb出力の日付の共通タイムゾーンを変更する機能を有効にして構成します。 gitweb出力の日付には、「commit」ビューと「commitdiff」ビューと「log」ビューでのauthordateとcommitterdate、および「tag」ビューでのtaggerdateが含まれます。デフォルトで有効になっています。

$feature{'javascript-timezone'}{'default'}[0] = "utc";

"refs" の下にある、ブランチのrefとして使用される追加ディレクトリのリスト。たとえば、gerrit のセットアップで、refs/heads/ 以下のすべてのブランチが公式のもので、push-after-review のもの、そして refs/sandbox/, refs/wip, refs/other 以下のブランチはより広いパーミッションを持つユーザーのものである場合、あなたはこの変数を以下のように設定したいと思うことでしょう。

$feature{'extra-branch-refs'}{'default'} =
        ['sandbox', 'wip', 'other'];

[gitweb]
        extraBranchRefs = sandbox wip other

[gitweb]
        extraBranchRefs = sandbox
        extraBranchRefs = wip other