Trac 設定ファイル
Trac の設定は trac.ini 設定ファイルを設定することによって行います。設定ファイルは <projectenv>/conf/trac.ini にあります。
グローバルな設定
バージョン 0.9 から、Trac は グローバルな trac.ini ファイルの設定を読み込むことができるようになりました。これらのグローバルオプションは、環境ごとに特別にオプションに組み込まれ、同じオプションを指定した場合、ローカルのオプションがグローバルなオプションを上書きします。
グローバル設定ファイルは、通常 $prefix/share/trac/conf/trac.ini にあります。この設定ファイルは、他の場所に移すこともできます (例えば、 /etc/trac.ini) しかし、設定を変更するには Trac をインストールするときに生成される trac/siteconfig.py ファイルを変更する必要があります。
リファレンス
これは現在利用できる設定オプションの簡単なリファレンスです。
[attachment]
max_size | チケットと Wiki の添付ファイルの最大サイズをバイト数で
指定します。 |
render_unsafe_content | 添付ファイルをブラウザ上に表示するか、
単にダウンロード可能にしておくかどうかを設定します。
ブラウザがほとんどのファイルを HTML として解釈することがあるため、
悪意のあるユーザにクロスサイトスクリプティング攻撃を可能にするファイル
の添付を許すことになります。
誰でもファイルを添付できるような公開サイトでは、このオプションを無効に
設定しておくことを推奨します (デフォルトは、無効に設定されています)。 |
[browser]
color_scale | age 列に色付けされます。
ソースコード注釈と同じカラースケールが使用されます:
青が古く、赤が新しいものを指します。
(0.11 以降) |
downloadable_paths | ダウンロード可能なリポジトリのパスをリストします。
このオプションに何も設定しない場合、全てのダウンロードを禁止されます。
部分的に許可する場合は、カンマ区切りでダウンロードを許可するパスを設定します
(パスには "*" をワイルドカードとして扱うような glob パターンを使用できます)
(0.10 以降) |
hide_properties | カンマ区切りでバージョン管理の属性を設定すると、その属性は
リポジトリブラウザで表示されなくなります。
(0.9 以降) |
intermediate_color | (r,g,b) の 3 色で指定します。この色は中間を指す
色として、 2 色の間のカラースケールとして使用されます
(intermediate_point 参照)。
intermediate color をセットしない場合、
oldest_color と newest_color の中間の色が使用されます。
(0.11 以降) |
intermediate_point | 0 から 1 (最大) の間で値を設定します。
この値は intermediate_color に設定したポイントへの補間に
使用されます。
(0.11 以降) |
newest_color | (r,g,b) の 3 色で指定します。この色は新しいものを指す
色として 注釈 (blame) や、 color_scale が有効に設定されていれば
ブラウザの age 列のカラースケールに使用されます。
(0.11 以降) |
oldest_color | (r,g,b) の 3 色で指定します。この色は古いものを指す
色として 注釈 (blame) や、 color_scale が有効に設定されていれば
ブラウザの age 列のカラースケールに使用されます。
(0.11 以降) |
oneliner_properties | カンマ区切りでバージョン管理の属性を設定すると、その属性は
リポジトリブラウザ上で 1 行スタイルの Wiki コンテンツとして表示されます。
(0.11 以降) |
render_unsafe_content | ファイルをブラウザ上に表示するか、単にダウンロード可能にしておくか
を設定します。
この設定を有効にすると、ブラウザがほとんどのファイルを HTML として解釈
するため、悪意のあるユーザにクロスサイトスクリプティング攻撃を含む
ファイルの添付を許すことになります。
誰でもファイルを添付できるような公開サイトでは、このオプションを無効に
設定しておくことを推奨します (デフォルトは無効に設定されています)。 |
wiki_properties | カンマ区切りでバージョン管理の属性を設定すると、その属性は
リポジトリブラウザ上で Wiki コンテンツとして表示されます。
(0.11 以降) |
[changeset]
max_diff_bytes | 更新したファイル (旧ファイルのサイズと新ファイルのサイズを足したもの)
のサイズの最大をバイト単位で指定します。チェンジセットビューの diff で
直接表示するサイズを制限します (0.10 以降)。 |
max_diff_files | チェンジセットビューの diff で直接表示する
更新ファイルの最大数を設定します。(0.10 以降)。 |
wiki_format_messages | Wiki フォーマットをチェンジセットのログメッセージに適用するかどうかを設定します。
このオプションが無効になっている場合、チェンジセットのログメッセージは
整形済みテキストとして表示されます。 |
alt | ヘッダロゴに使用する alt テキストを設定します。 |
height | ヘッダロゴの高さを pixel で設定します。 |
link | ヘッダロゴがリンクする URL を設定します。 |
src | ヘッダロゴに使用するイメージファイルの URL を設定します。 |
width | ヘッダロゴの幅を pixel で設定します。 |
[inherit]
plugins_dir | 共有するプラグインをおくディレクトリのパスを指定します。
このディレクトリに配置されたプラグインは、 Environemnt の plugins
ディレクトリのプラグインに加えて、
優先してロードされます。
(0.11 以降) |
templates_dir | 共有するテンプレートディレクトリのパスを指定します。
指定したパスは環境の templates ディレクトリに加えてロードされますが、
templates ディレクトリが優先となります。
(0.11 以降) |
[logging]
log_file | log_type が file のときのログファイルへのパスを設定します。 |
log_format | ログのフォーマットをカスタマイズします。
デフォルトでは以下のフォーマットが使用されます :
Trac[$(module)s] $(levelname)s: $(message)s
Python のロガーライブラリがサポートしている標準のキー
( http://docs.python.org/lib/node422.html 参照) に加えて、以下のキーを使用することができます :
- $(path)s 現在の環境へのパス
- $(basename)s 現在の環境のパスの一番最後の部分
- $(project)s プロジェクト名
%(...)s を使用すると ConfigParser が解釈し展開してしまうので、 $(...)s
を使用することを覚えておいて下さい。
例:
($(thread)d) Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s
(0.10.5 以降) |
log_level | ログレベルを設定します。
値は (CRITICAL, ERROR, WARN, INFO, DEBUG) の、どれかでなければなりません。 |
log_type | 出力するログの種類を設定します。
値は (none, file, stderr, syslog, winlog) の、どれかでなければなりません。 |
[milestone]
stats_provider | ITicketGroupStatsProvider を implement するコンポーネントの名前を設定します。
ロードマップビューの表示で使用する、チケットのグループでの統計情報を収集する
ために使用されます。 |
[mimeviewer]
enscript_modes | Enscript が処理できる MIME タイプを追加します。
それぞれのエントリは mimetype:mode:quality というタプルで
設定しなければなりません。 mimetype には MIME タイプを、
mode には変換に使用する Enscript のモードを、
quality には変換に関連する quality ratio を
設定します。
quality で設定した値で、 Enscript のデフォルトの quality ratio
を上書きします。デフォルトは 2 です
(0.10 以降)。 |
enscript_path | Enscript プログラムへのパスを設定します。 |
max_preview_size | HTML プレビューでのファイルの最大サイズを設定します。 (0.9 以降) |
mime_map | 追加の MIME タイプとキーワードのマッピングのリストを設定します。
マッピングリストはそれぞれの MIME タイプごとにカンマ区切りで指定します。
MIME タイプと関連するキーワードもしくはファイルの拡張子をコロン (":")
区切りで記述します。 (0.10 以降) |
php_path | PHP コマンドへのパスを設定します (0.9 以降) 。 |
tab_width | ファイルをプレビューするときのタブの表示幅を設定します。 (0.9 以降) |
treat_as_binary | バイナリデータとして取り扱う MIME タイプをカンマ区切りのリストで
設定します。 (0.11.5 以降) |
[notification]
admit_domains | メールアドレスとして有効とするドメインをカンマ区切りで設定します。
(localdomain など) |
always_notify_owner | チケットの担当者 (owner) に常に通知メールを送信するかを設定します (0.9 以降) 。 |
always_notify_reporter | 報告者 (reporter) フィールドにあるアドレスに常に通知メールを
送信するかを設定します。 |
always_notify_updater | チケット属性が変更された場合に、それまでの全ての変更を行った人に、
常に通知メールを送信するかを設定します。 |
ignore_domains | メールアドレスの一部として有効としないドメインをカンマ区切りで設定します。
(ユーザ名に Kerberos ドメインが付いている場合などの対策) |
mime_encoding | メールのエンコード方法を設定します。
有効なオプションとして、Base64 エンコーディングの 'base64',
Quoted-Printable の 'qp', すべての文字が ASCII の場合は 7bit で、
そうでない場合には適切な 8bit で送信する 'none' があります。
(0.10 以降)。 |
smtp_always_bcc | 常に通知メールを送るメールアドレスを設定します。
設定したアドレスを受信者は見ることができません(Bcc:)。(0.10 以降 )。 |
smtp_always_cc | 常に通知メールを送るメールアドレスを設定します。
設定したアドレスは、すべての受信者がみることができます (Cc:)。 |
smtp_default_domain | アドレスにホスト名/ドメインが指定されていなかったときに、付与する文字列を設定します。 |
smtp_enabled | メール通知を有効にするかどうかを設定します。 |
smtp_from | 通知メールに使用する送信者アドレスを設定します。 |
smtp_from_name | 通知メールに使用する送信者名を設定します。 |
smtp_password | SMTP サーバの認証パスワードを設定します (0.9 以降)。 |
smtp_port | メール通知で使用する SMTP サーバのポート番号を設定します。 |
smtp_replyto | 通知メールに使用する返信アドレスを設定します。 |
smtp_server | メール通知で使用する SMTP サーバのホスト名を設定します。 |
smtp_subject_prefix | 通知メールの件名の頭に追加するプレフィックスを設定します。
オプションが定義されていない場合、[$project_name] (訳注: trac.ini の project セクションの name) が設定されます。
プレフィックスが必要ない場合は、オプションに空の値を設定することで、
無効化できます (0.10.1 以降)。 |
smtp_user | SMTP サーバの認証ユーザ名を設定します (0.9 以降)。 |
ticket_subject_template | 通知の件名 (Subject) に使用する Genshi のテキストテンプレートの
snippet を設定します。
デフォルトでは件名のテンプレートは $prefix #$ticket.id: $summary
です。 $prefix は smtp_subject_prefix の設定値に置換されます。
(0.11 以降) |
use_public_cc | 通知メールの受信者が、 CC された他の受信者のメールアドレスを見ることができるかを設定します。
このオプションが無効になっている場合 (デフォルト)、受信者のメールアドレスは BCC フィールドに設定されます
(0.10 以降)。 |
use_short_addr | ホスト名やドメインがないメールアドレスを許容するかを設定します (ユーザ名のみの場合など)。
SMTP サーバはホスト名やドメインがないメールアドレスも受け入れるべきで、
FQDN を追加するか、ローカル配送を使うべきです (0.10 以降)。 |
use_tls | メール通知に SSL/TLS を使用するかどうかを設定します (0.10 以降)。 |
[project]
admin | プロジェクトの管理者のメールアドレスを設定します。 |
admin_trac_url | この Trac で発生したエラーを報告する先の Trac インスタンスの
ベース URL を設定します。
絶対 URL, 相対 URL, およびこの Trac インスタンスを指す '.' が
指定可能です。空白値を指定すると報告ボタンが表示されなくなります。
(0.11.3 以降) |
descr | プロジェクトの概要を設定します。 |
footer | ページのフッタに表示するテキストを指定します (右詰めで表示されます)。 |
icon | プロジェクトのアイコンの URL を指定します。 |
name | プロジェクトの名前を設定します。 |
url | プロジェクトのメインとなる Web サイトの URL を設定します。
通常、 base_url が示すウェブサイトを指定します。 |
[query]
default_anonymous_query | 認証されていないユーザへのデフォルトのクエリ。このクエリは
クエリ言語 のシンタックスか、 query:
の Trac リンク でも使われる ? で始まる
URL クエリ文字列で記述します
(0.11.2 以降)。 |
default_query | 認証されたユーザへのデフォルトのクエリ。このクエリは
クエリ言語 のシンタックスか、 query:
の Trac リンク でも使われる ? で始まる
URL クエリ文字列で記述します
(0.11.2 以降)。 |
items_per_page | カスタムクエリの検索結果で 1 ページあたり表示するチケット数の
デフォルト値 (0.11 以降) |
[report]
items_per_page | レポートの検索結果ページで 1 ページに表示するチケット数の
デフォルト値 (0.11 以降) |
items_per_page_rss | レポートの RSS フィードに掲載するチケット数
(0.11 以降) |
[revisionlog]
[roadmap]
stats_provider | ITicketGroupStatsProvider を implement するコンポーネントの名前を設定します。
ロードマップビューの表示で使用する、チケットのグループでの統計情報を収集する
ために使用されます。 |
[search]
min_query_length | 検索を実行するときに許容するクエリ文字列の最短の長さを設定します。 |
[svn]
branches | ブランチ として分類するパスのカンマ区切りリスト。
パスが '*' で終わっている場合、そのパスに含まれる全ての
ディレクトリエントリが含まれます。
例: /trunk, /branches/*, /projectAlpha/trunk, /sandbox/* |
tags | タグ として分類するパスのカンマ区切りリスト。
パスが '*' で終わっている場合、そのパスに含まれる全ての
ディレクトリエントリが含まれます。
例: /tags/*, /projectAlpha/tags/A-1.0, /projectAlpha/tags/A-v1.1 |
[ticket]
default_cc | 新規登録チケットにデフォルトで設定する関係者リスト。 |
default_component | 新規登録チケットにデフォルトで設定するコンポーネント。 |
default_description | 新規登録チケットにデフォルトで設定する説明。 |
default_keywords | 新規登録チケットにデフォルトで設定するキーワード。 |
default_milestone | 新規登録チケットにデフォルトで設定するマイルストーン。 |
default_owner | 新規登録チケットにデフォルトで設定する担当者。 |
default_priority | 新規登録チケットにデフォルトで設定する優先度。 |
default_resolution | チケットを解決にする (閉じる) ときに、デフォルトで設定する解決方法
(0.11 以降)。 |
default_severity | 新規登録チケットにデフォルトで設定する重要度。 |
default_summary | 新規登録チケットにデフォルトで設定する概要 (タイトル)。 |
default_type | 新規登録チケットにデフォルトで設定するチケット分類 (0.9 以降)。 |
default_version | 新規登録チケットにデフォルトで設定するバージョン。 |
max_comment_size | チケットのコメント (comment) の最大サイズを設定します
(0.11.2 以降)。 |
max_description_size | チケットの記述 (description) の最大サイズを設定します
(0.11 以降)。 |
preserve_newlines | Wiki フォーマッタが Wiki テキスト中の改行を文字を考慮するかを
設定します。
'default' に設定されている場合、新規作成した Environment では 'yes' と同じ意味になりますが、
アップグレードした Environemnt では、以前のふるまいを踏襲します ('no' に相当)
(0.11 以降)。 |
restrict_owner | チケットの担当者のフィールドでドロップダウンメニューを使用します。
このオプションを true に設定すると、性能に影響する可能性があるので
注意してください。
担当者をドロップダウンリストにする を参照して下さい
(0.9 以降)。 |
workflow | チケットのアクションに使用するワークフローコントローラを順にリスト形式で設定します。
(0.11 以降)。 |
[timeline]
abbreviated_messages | WikiFormatting で書かれたメッセージを切り詰めるかどうかを設定します。
このオプションは default のレンダリングでのみ有効です。 特定のイベントプロバイダによって、
設定が上書きされることがあります。詳しくは、イベントプロバイダのドキュメントを参照して下さい
(0.11 以降)。 |
changeset_collapse_events | 全く同じログメッセージで、同一編集者による連続したチェンジセットを
1 つのイベントとして扱います。
この場合、ログビューでは範囲を持つチェンジセットとしてリンクされます。
(0.11 以降) |
changeset_long_messages | Wiki フォーマットのチェンジセットのログメッセージを複数行表示するかどうかを設定します。
このオプションが設定されないか、 false である場合、かつ wiki_format_messages
が true に設定されている場合、チェンジセットのログメッセージは、1 行のみ
表示され、いくつかのフォーマット (中点 (bullet points) など) は無視されます。 |
changeset_show_files | タイムラインに表示するファイル数を設定します (-1: 無制限, 0: 表示しない)。
また、変更のあったファイルに共通するプレフィックスを 位置 として
表示します (0.11 以降)。 |
default_daysback | タイムラインに表示する日数にデフォルト値を設定します
(0.9 以降)。 |
max_daysback | タイムラインで表示可能な日数の最大値 (-1 は無制限を意味する)
(0.11 以降)。 |
newticket_formatter | 新規登録チケットの記述 (description) を表示するときに使用する
フォーマッタの flavor (例えば 'html' や 'oneliner')を設定します。
'oneliner' を設定した場合、 [timeline] の abbreviated_messages オプションが適用されます
(0.11 以降)。 |
ticket_show_details | タイムラインにオープン/クローズだけでなく、すべてのチケットの変更を
表示するかを設定します
(0.9 以降)。 |
[trac]
authz_file | Subversion の
認証 (authz) ファイル へのパスを設定します。 |
authz_module_name | authz_file で使用されるモジュールのプレフィックスを設定します。 |
auto_reload | 変更があった後、テンプレートファイルを自動的に再読込するかを設定します。 |
backup_dir | データベースのバックアップ作成位置を設定します。 |
base_url | Trac がデプロイされている URL を設定します。
ドキュメントを生成するときに使用される base URL です。
Web でブラウズできるコンテキスト外で利用されます。たとえば、
通知メールで Trac のリソースを指す URL を挿入する場合
などです。 |
check_auth_ip | 認証時に、ユーザの IP アドレスをチェックするかどうかを
設定します (0.9 以降) 。 |
database | このプロジェクトのデータベースに接続する
文字列
を設定します。 |
debug_sql | DEBUG レベルのログとして SQL クエリを出力します。
(0.11.5 以降) |
default_charset | 文字コードが設定されていないときのデフォルト値を設定します。 |
default_handler | ベース URL へのリクエストを処理するコンポーネント名を設定します。
オプションには TimelineModule, RoadmapModule, BrowserModule,
QueryModule, ReportModule, TicketModule, WikiModule などが
使用できます。デフォルトは WikiModule です (0.9 以降)。 |
default_timezone | デフォルトのタイムゾーンを指定します。 |
htdocs_location | 静的なリソースへアクセスするためのベース URL を指定します。 |
ignore_auth_case | ログイン名をすべて小文字に変換してから使用するかを設定します
(0.9 以降) 。 |
mainnav | ナビゲーションバーの mainnav に表示する項目の順序を
ID のリストで設定します。詳しくは TracNavigation を参照してください。 |
metanav | ナビゲーションバーの metanav に表示する項目の順序を
ID のリストで設定します。詳しくは TracNavigation を参照してください。 |
mysqldump_path | MySQL データベースバックエンドをバックアップするために使用する mysqldump のパスを設定します |
never_obfuscate_mailto | Wiki に記載されたあいまいな mailto: をリンクから除外します。
この設定は show_email_addresses や EMAIL_VIEW パーミッションの
設定に優先します (0.11.6 以降)。 |
permission_policies | IPermissionPolicy を実装するコンポーネントのリストを設定します。設定されている
順に適用されます。これらのコンポーネントは、 Trac リソースへの細かい
アクセスコントロールを行います。
デフォルトは DefaultPermissionPolicy (0.11 より前のふるまい) と
LegacyAttachmentPolicy (ATTACHMENT_* パーミッションをレルム固有にパーミッションに
マップします) です。 |
permission_store | IPermissionStore を実装しているコンポーネント名を設定します。
ユーザとグループのパーミッションの管理のために使用されます。 |
pg_dump_path | Postgres データベースバックエンドをバックアップするために使用する pg_dump のパスを設定します |
repository_dir | ローカルリポジトリへのパスを指定します。相対パスを使用できます
(0.11 以降)。 |
repository_type | リポジトリの種類を指定します。(0.10 以降) |
request_filters | すべてのリクエストに適用するフィルタの適用順を設定します
(0.10 以降)。 |
secure_cookies | Cookie を HTTPS 接続で使用します。
True に設定された場合、すべての Cookie に secure フラグを付与
することで、 HTTPS 接続でサーバに送信されるようにします。このオ
プションは Trac への接続に HTTPS が使える場合だけ、使用するよう
にしてください。 (since 0.11.2 以降) |
show_email_addresses | ユーザ名の代わりにメールアドレスを表示します。 false の場合、
メールアドレスはわかりづらくなります (0.11 以降)。 |
show_ip_addresses | リソース (Wiki など) を編集した IP アドレスを表示します
(0.11.3 以降)。 |
timeout | データベース接続のタイムアウト秒数を設定します。
'0' を指定すると、 タイムアウトなし になります。 (0.11 以降) |
use_base_url_for_redirect | [trac] base_url をリダイレクトにも使用するか設定します。
Trac を HTTP プロキシの背後で動作させる設定下では、
自動ではアクセスに使用された URL を再構成できないため、
このオプションを使って、強制的に base_url の設定先にリダイレクトするよう
Trac を設定する必要があります。この使用で制限事項が追加されます。
その Environment はリダイレクト先として使用される URL からアクセスしないと
使いづらくなります。 (0.10.5 以降) |
[tracnav]
provide_jpnav | Legacy: Also provide macro as 'JPNav'. |
[wiki]
ignore_missing_pages | 存在しないページへの CamelCase リンクをハイライトするかどうかを設定します
(0.9 以降). |
max_size | Wiki ページで許容する最大のページサイズを設定します。
(0.11.2 以降) |
render_unsafe_content | <script> や <embed> のようなセキュリティ上安全とはいえない HTML タグを
HTML Wiki プロセッサ で使用可能にするかどうかを設定します。
(0.10.4 以降).
誰でも Wiki を編集できるような公開サイトでは、このオプションを無効に
設定しておくことを推奨します。 (デフォルトは、無効に設定されています)。 |
split_page_names | スペースで WikiPageNames を区切るのを可能にするかどうかを設定します
(0.10 以降). |
[components]
(0.9 以降)
このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの使用不使用を設定するために使います。使用できる / できないコンポーネントはオプションの名前を通じて特定されます。コンポーネントが使用できるかどうかはオプションの値によって決定されます; コンポーネントを使用できるようにするために、値を enabled または on に設定してください。他の値 (一般的には disabled または off) の場合、コンポーネントは使用できません。
オプションの名前はコンポーネントの完全な名前、もしくは、コンポーネントの中のモジュール / パッケージのプレフィックスとなっています。前者は 特定のコンポーネントの使用 / 不使用 を設定し、後者は特定のパッケージ / モジュールの中のコンポーネントの使用 / 不使用を設定します。
以下の設定ファイルの抜粋を見てください:
[components]
trac.ticket.report.ReportModule = disabled
webadmin.* = enabled
最初のオプションは レポートモジュール を使用しないように Trac を設定しています。二つ目のオプションは webadmin パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはマッチするモジュール / パッケージを一度に設定します。
利用可能なコンポーネントの一覧がほしい場合、 Trac について の Plugins ページを参照してください。 (CONFIG_VIEW パーミッション が必要となります。)
See also: TracPlugins
r2335 (バージョンでは 0.9b1, 0.9b2) までの Trac では、このセクションの代わりに [disabled_components] セクションを使用してください。このページの 以前のバージョン に詳細が書かれています。
See also: TracGuide, TracAdmin, TracEnvironment