Trac 設定ファイル
Table of Contents
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 ファイルを変更する必要があります。
リファレンス
これは現在利用できる設定オプションの簡単なリファレンスです。
[account-manager]
| authentication_url | |
| password_file | |
| htdigest_realm | |
| generated_password_length | Length of the randomly-generated passwords created when resetting the password for an account. |
| password_store | |
| hash_method | |
| password_format |
[attachment]
| max_size | チケットと Wiki の添付ファイルの最大サイズを指定します。 |
| render_unsafe_content | 添付ファイルをブラウザ上に表示するか、 単にダウンロード可能にしておくかどうかを設定します。 ブラウザがほとんどのファイル種別をHTMLとして解釈することがあるということは、 悪意のあるユーザにクロスサイトスクリプティング攻撃を可能にするファイル の添付を許すことになります。 誰でもファイルを添付できるような公開サイトでは、このオプションを無効に 設定しておくことを推奨します。(デフォルトは、無効に設定されています) 。 |
[browser]
| render_unsafe_content | 添付ファイルをブラウザ上に表示するか、 単にダウンロード可能にしておくかどうかを設定します。 ブラウザがほとんどのファイル種別をHTMLとして解釈することがあるということは、 悪意のあるユーザにクロスサイトスクリプティング攻撃を可能にするファイル の添付を許すことになります。 誰でもファイルを添付できるような公開サイトでは、このオプションを無効に 設定しておくことを推奨します。(デフォルトは、無効に設定されています) 。 |
| hide_properties | Subversion の属性値のリストをリポジトリブラウザで表示しないようにします (0.9 以降)。 |
| downloadable_paths | ダウンロード可能なリポジトリのパスをリストします。 リポジトリのすべてのダウンロードを禁止したい場合は、オプションに何も設定しません。 部分的に許可する場合は、カンマ区切りでダウンロードを許可するパスを設定します (パスには グローバルパターンマッチを指定できます。例えば、 "*" はワイルドカードとして使用できます) (0.10 以降)。 |
[changeset]
| wiki_format_messages | Wiki フォーマットをチェンジセットのログメッセージに適用するかどうかを設定します。 このオプションが無効になっている場合、チェンジセットのログメッセージは Wiki 形式に 変換される前のテキスト形式で表示されます。 |
| max_diff_files | チェンジセットビューのインライン diff で表示する 更新ファイルの最大数を設定します (0.10 以降)。 |
| max_diff_bytes | 更新したファイル (旧ファイルのサイズと新ファイルのサイズを足したもの) の サイズの最大をバイト単位で指定します。これはによって、チェンジセットビューの インライン diff で表示するサイズが制限されます (0.10 以降) 。 |
[discussion]
| title | Main navigation bar button title. |
[header_logo]
| width | ヘッダロゴの幅を pixel で設定します。 |
| height | ヘッダロゴの高さを pixel で設定します。 |
| alt | ヘッダロゴに使用する alt テキストを設定します。 |
| src | ヘッダロゴに使用するイメージファイルの URL を設定します。 |
| link | ヘッダロゴがリンクする URL を設定します。 |
[httpauth]
| paths | Paths to force HTTP authentication on. |
| formats | Request formats to force HTTP authentication on |
[logging]
| log_level | ログレベルを設定します。 値は (CRITICAL, ERROR, WARN, INFO, DEBUG) の、どれかでなければなりません。 |
| 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.11 以降) |
| log_file | log_type が file のときに、ログファイルへのパスを設定します。 |
| log_type | 出力するログの種類を設定します。 値は (none, file, stderr, syslog, winlog) の、どれかでなければなりません。 |
[mimeviewer]
| php_path | PHP プログラムへのパスを設定します (0.9 以降) 。 |
| silvercity_modes | SilverCity が処理できるMIME タイプを追加します。 それぞれのエントリは mimetype:mode:quality のように 設定しなければなりません。 mimetype は MIME タイプを、 mode には、mimetype に対応する SilverCity での モードを、 quality には、変換の精度を 指定します。 quality は上書きすることができますが、デフォルトの SilverCity がレンダリングに使用する変換の精度は 3 です (0.10 以降)。 |
| tab_width | ファイルをプレビューするときのタブの表示幅を設定します (0.9 以降)。 |
| max_preview_size | HTML プレビューでのファイルの最大サイズを設定します (0.9 以降)。 |
| enscript_modes | Enscript が処理できるMIME タイプを追加します。 それぞれのエントリは mimetype:mode:quality のように 設定しなければなりません。 mimetype は MIME タイプを、 mode には、mimetype に対応する Enscript での モードを、 quality には、変換の精度を 指定します。 quality は上書きすることができますが、デフォルトの Enscript がレンダリングに使用する変換の精度は 2 です (0.10 以降)。 |
| mime_map | 追加の MIME タイプとキーワードのマッピングのリストを設定します。 マッピングリストはそれぞれの MIME タイプごとにカンマ区切りで指定します。 MIME タイプと関連するキーワードもしくはファイルの拡張子をコロン(":")区切り で記述します (0.10 以降)。 |
| enscript_path | Enscript プログラムへのパスを設定します。 |
[notification]
| smtp_always_bcc | 常に通知メールを送るメールアドレスを設定します。 設定したアドレスを受信者は見ることができません(Bcc:)。 (0.10 以降 )。 |
| always_notify_updater | チケットの属性の変更者に常に通知メールを 送信するかを設定します。 |
| smtp_user | SMTP サーバの認証ユーザ名を設定します (0.9 以降)。 |
| always_notify_owner | チケットの担当者に常に通知メールを送信するかを設定します (0.9 以降) 。 |
| smtp_subject_prefix | 通知メールの件名の頭に追加するプレフィックスを設定します。 オプションが定義されていない場合、 [$project_name] (訳注: trac.ini の project セクションの name) が設定されます。 プレフィックスが必要ない場合は、オプションに空の値を設定することで、 無効化できます (0.10.1 以降)。 |
| smtp_replyto | 通知メールに使用する返信アドレスを設定します。 |
| smtp_port | メール通知で使用する SMTP サーバのポート番号を設定します。 |
| smtp_from | 通知メールに使用する送信者アドレスを設定します。 |
| use_tls | メール通知に SSL/TLS を使用するかどうかを設定します (0.10 以降)。 |
| smtp_default_domain | アドレスにホスト名/ドメインが指定されていなかったときに、付与する文字列を設定します。 |
| always_notify_reporter | 報告者 フィールドにあるアドレスに常に通知メールを 送信するかを設定します。 |
| smtp_enabled | メール通知を有効にするかどうかを設定します。 |
| mime_encoding | メールのエンコード方法を設定します。 有効なオプションとして、Base64 エンコーディングの 'base64' 、 Quoted-Printable の 'qp' 、エンコードなしを表す 'none' があります。 エンコードをしないということは、 テキストの中の ASCII 以外の文字がメール通知で 問題を引き起こすかもしれません (0.10 以降)。 |
| smtp_always_cc | 常に通知メールを送るメールアドレスを設定します。 設定したアドレスは、すべての受信者がみることができます (Cc:)。 |
| smtp_password | SMTP サーバの認証パスワードを設定します (0.9 以降)。 |
| smtp_server | メール通知で使用する SMTP サーバのホスト名を設定します。 |
| use_public_cc | 通知メールの受信者が、 CC された他の受信者のメールアドレスを見ることができるかを設定します。 このオプションが無効になっている場合 (デフォルト)、受信者のメールアドレスは BCC フィールドに設定されます (0.10 以降)。 |
| use_short_addr | ホスト名やドメインがないメールアドレスを許容するかを設定します (ユーザ名のみの場合など)。 SMTP サーバはホスト名やドメインがないメールアドレスも受け入れるべきで、 FQDN を追加するか、ローカル配送を使うべきです (0.10 以降)。 |
[project]
| url | プロジェクトのメインとなる Web サイトの URL を設定します。 |
| name | プロジェクトの名前を設定します。 |
| icon | プロジェクトのアイコンの URL を指定します。 |
| footer | ページのフッタに表示するテキストを指定します (右詰めで表示されます)。 |
| descr | プロジェクトの概要を設定します。 |
[search]
| min_query_length | 検索を実行するときに許容するクエリ文字列の最短の長さを設定します。 |
[ticket]
| default_version | 新規登録チケットにデフォルトで設定するバージョン。 |
| restrict_owner | チケットの担当者のフィールドでドロップダウンメニューを使用するかを設定します。 担当者をドロップダウンリストにするを参照して下さい (0.9 以降)。 |
| default_type | 新規登録チケットにデフォルトで設定するチケット分類 (0.9 以降) 。 |
| default_priority | 新規登録チケットにデフォルトで設定する優先度。 |
| default_milestone | 新規登録チケットにデフォルトで設定するマイルストーン。 |
| default_component | 新規登録チケットにデフォルトで設定するコンポーネント。 |
[timeline]
| changeset_long_messages | Wiki フォーマットのチェンジセットのログメッセージを複数行表示するかどうかを設定します。 このオプションは設定されないか、 false かつ wiki_format_messages が true に設定された場合に、チェンジセットのログメッセージが1行のみ表示されるようになります (中点 (bullet points) などいくつかの WikiFormatting が失われます)。 |
| default_daysback | タイムラインに表示する日数にデフォルト値を設定します (0.9 以降)。 |
| ticket_show_details | タイムラインにすべてのチケットの変更を表示するかを設定します。 (0.9 以降) |
| changeset_show_files | タイムラインに表示するファイル数を設定します (-1: 無制限, 0: 表示しない) 。 |
[trac]
| authz_file | Subversion の 認証 (authz) ファイル へのパスを設定します。 |
| check_auth_ip | 認証時に、ユーザの IP アドレスをチェックするかどうかを 設定します (0.9 以降) 。 |
| database | このプロジェクトの データベースに接続するための文字列 を設定します。 |
| ignore_auth_case | ログイン名で大文字 / 小文字を区別するかどうかを設定します (0.9 以降) 。 |
| metanav | ナビゲーションバーの metanav に表示する項目の ID リストを設定します。 |
| base_url | Trac をデプロイするためのベース URL を設定します。 ほとんどの設定において、 Trac に自動的にアクセスできるように、 URL を再構築します。しかし、より複雑な設定をしている場合、通常は HTTP プロキシの背後で Trac を動かしているようなときですが、 このオプションを設定し、 Trac が正しい URL を使用できるようにする必要があるかもしれません。 |
| default_charset | 文字コードが設定されていないときのデフォルト値を設定します。 |
| default_handler | ベース URL へのリクエストを処理するコンポーネント名を設定します。 オプションには TimelineModule, RoadmapModule, BrowserModule, QueryModule, ReportModule , NewticketModule を指定することができます (0.9 以降)。 |
| htdocs_location | 静的なリソースへアクセスするためのベース URL を指定します。 |
| permission_store | IPermissionStore を実装しているコンポーネント名を指定します。 これは、ユーザとグループのパーミッションの管理のために使用されます。 |
| templates_dir | ClearSilver テンプレートへのパスを設定します。 |
| repository_dir | ローカルリポジトリへのパスを指定します。 |
| repository_type | リポジトリの種類を指定します (0.10 以降)。 |
| request_filters | すべてのリクエストに適用するフィルタの適用順を設定します (0.10 以降)。 |
| timeout | データベース接続のタイムアウト秒数を設定します。 '0' を指定すると、 タイムアウトなし になります。 (0.11 以降) (訳注: 0.11 からとなっていますが、 0.10.1 でも使用できます。) |
| mainnav | ナビゲーションバーの mainnav に表示する項目の ID リストを設定します。 |
| authz_module_name | authz_file で使用されるモジュールのプレフィックスを設定します。 |
[wiki]
| ignore_missing_pages | 存在しないページへの CamelCase リンクをハイライトするかどうかを設定します (0.9 以降)。 |
| 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
