Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
May 13, 2012, 9:15:45 PM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v1 v2  
    1 = Trac 設定ファイル =
     1= Trac 設定ファイル = #TheTracConfigurationFile
     2
    23[[TracGuideToc]]
    34
    4 Trac の設定は '''`trac.ini`''' 設定ファイルを設定することによって行います。設定ファイルは `<projectenv>/conf/trac.ini` にあります
     5Trac の設定は `<projectenv>/conf/` にある '''`trac.ini`''' というファイルを編集して行います。変更した内容は通常、即座に反映されますが、 `[components]` セクションや `[logging]` セクションへの変更では Web サーバを再起動する必要があります。また、グローバルな設定ファイルを新しく作成した直後も Web サーバを再起動しなければなりません
    56
    6 == グローバルな設定 ==
     7`trac.ini` 設定ファイルは Web サーバから書き込み可能でなければなりません。 Trac は現在のところ、キャッシュを破棄するために完全に Environment を再読み込みするトリガーとして利用しています。
    78
    8 バージョン 0.9 から、Trac は グローバルな `trac.ini` ファイルの設定を読み込むことができるようになりました。これらのグローバルオプションは、環境ごとに特別にオプションに組み込まれ、同じオプションを指定した場合、ローカルのオプションがグローバルなオプションを上書きします。
     9== グローバルな設定 == #GlobalConfiguration
    910
    10 グローバル設定ファイルは、通常 `$prefix/share/trac/conf/trac.ini` にあります。この設定ファイルは、他の場所に移すこともできます (例えば、 `/etc/trac.ini`) しかし、設定を変更するには Trac をインストールするときに生成される `trac/siteconfig.py` ファイルを変更する必要があります。
     110.11 より前のバージョンでは、グローバルな設定ファイルは `$prefix/share/trac/conf/trac.ini` や `/etc/trac/trac.ini` などディストリビューションに依存した特定の位置に配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。以前のバージョンから 0.11 にアップグレードした場合、プロジェクトの `trac.ini` ファイルに `[inherit]` セクションを追加しなければなりません。カスタマイズしたテンプレートや画像のファイルは `$prefix/share/trac/...` から他の場所に移動することもできます。
    1112
    12 == リファレンス ==
     13グローバルな設定は Environment 固有の設定とマージされます。ローカルの設定はグローバルの設定を上書きます。グローバルな設定ファイルは以下のように指定します:
     14{{{
     15[inherit]
     16file = /path/to/global/trac.ini
     17}}}
     18カンマ区切りにすることで、複数のファイルを指定することができます。
    1319
    14 これは現在利用できる設定オプションの簡単なリファレンスです。
     20Note: 新しいプロジェクトを作る時に [TracAdmin#initenv trac-admin] の `initenv` コマンドに `--inherit=/path/to/global/trac.ini` オプションを追加することで、グローバル設定ファイルを指定することができます。オプションを追加せずにプロジェクトを作成した場合でも、新しく作成された `conf/trac.ini` ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、新しい Environment でグローバル設定ファイルを使用することができます。
    1521
    16 '''Note:[http://trac.edgewall.org/milestone/0.10 mileston:0.10] 以降、 TracIni のリファレンスは
    17 TracIniMacro を使って、ソースコードから自動生成されたものになります。しかしこのページでは、
    18 古い ''wiki'' の内容のままにするので、以前通りに、コミュニティによって簡単に
    19 ドキュメントを修正できます。'''
     22[[#inherit-section| [inherit] ]] セクションには、共有するテンプレートの配置先を指す `templates_dir` と、共有するプラグインを指す `plugins_dir` という二つのエントリもあります。これらがグローバル設定ファイルに指定することができます。この場合、他の `[inherit] file` が指定されていれば、設定ファイルは順次読み込まれます。
    2023
     24Note: TracEnvironment の `templates/` ディレクトリ内のテンプレートは、 `[inherit] templates_dir` で見つかるテンプレートより優先されます。次に、`[inherit] templates_dir` のテンプレートはインストールされているテンプレートより優先されます。これらを設定するには注意が必要です。特に、デフォルトのテンプレートをオーバーライドする場合、 Trac を新しいバージョンにアップデートする際には必ず変更点を再読み込みして下さい。 ( TracInterfaceCustomization を行うために推奨する方法は、適切に `ITemplateStreamFilter` の変更が行えるカスタムプラグインを作成することです。)
    2125
    22 == [trac] ==
    23 || `base_url`        || Trac をデプロイするためのベースの URL を設定します。 ほとんどの設定において、 Trac に自動的にアクセスできるように、 URL を再構築します。しかし、より複雑な設定をしている場合、通常は HTTP プロキシの背後で Trac を動かしているようなときですが、 このオプションを設定し、 Trac が正しい URL を使用できるようにする必要があるかもしれません。 ||
    24 || `database`        || このプロジェクトの [wiki:TracEnvironment#データベースに接続するための文字列 データベースに接続するための文字列] を設定します ||
    25 || `default_charset` || Subversion のリポジトリで使用するテキストファイルの文字コードを設定します (デフォルトは `iso-8859-15`) ||
    26 || `default_handler` || ベース URL への要求を処理するコンポーネントの名前を設定します (デフォルトは `WikiModule`) 。その他のオプションは、 `TimelineModule`, `RoadmapModule`, `BrowserModule`, `ReportModule`, `NewticketModule` があります。 (''0.9 以降'') ||
    27 || `repository_dir`  || ローカルリポジトリへのパスを設定します ||
    28 || `authz_file`      || Subversion の [http://svnbook.red-bean.com/en/1.1/ch06s04.html#svn-ch-6-sect-4.4.2 認証 (authz) ファイル]へのパスを設定します ||
    29 || `authz_module_name` || `authz_file` で使用されるモジュールのプレフィックスを設定します ([http://projects.edgewall.com/trac/wiki/FineGrainedPermissions FineGrainedPermissions] 参照) ||
    30 || `check_auth_ip` || 認証時にユーザの IP アドレスをチェックするかどうかを設定します (true, false) (''0.9 以降'') ||
    31 || `ignore_auth_case` || ログイン名で大文字 / 小文字を区別するかどうかを設定します (true, false) (''0.9 以降'') ||
    32 || `templates_dir`   || !ClearSilver テンプレートへのパスを設定します ||
    33 || `htdocs_location`   || 静的リソースへのパスを設定します (デフォルトは `/trac`) ||
    34 || `permissions_store` || ||
    35 || `metanav` || メタナビゲーションバーに表示されるセクションの順を設定します。 [wiki:TracPermissions Trac のパーミッション機構] で、このリストにセクションが追加されたり削除されたりします。 ||
    36 || `mainnav` || メインナビゲーションバーに表示されるセクションの順を設定します。 ||
     26== リファレンス == #Referenceforsettings
    3727
    38 == [diff] ==
    39 || `tab_width` || ''0.9以降廃止予定。 `[mimeviewer]` セクションの `tab_width` オプションを使用して下さい。'' ||
    40  
    41 == [project] ==
    42 || `name`   || プロジェクトの名前を設定します ||
    43 || `descr`  || プロジェクトの概要を設定します ||
    44 || `url`    || プロジェクトのメインとなる Web サイトの URL を設定します ||
    45 || `icon`   || URL のショートカットアイコンとして使用されるアイコンファイルを設定します (favicon) ||
    46 || `footer` || ページのフッタに表示するテキストを設定します (右詰めで表示されます) ||
     28現在利用できる設定項目のリファレンスとデフォルトの設定です。(訳注: 0.12 ではデフォルトの値は表示されません。)
    4729
    48 == [header_logo] ==
    49 || `src`    || ヘッダロゴに使用するイメージファイルの URL を設定します ||
    50 || `link`   || ヘッダロゴがリンクする URL を設定します ||
    51 || `alt`    || ヘッダロゴに使用する ''alt'' テキストを設定します ||
    52 || `width`  || ヘッダロゴの幅を pixel で設定します ||
    53 || `height` || ヘッダロゴの高さを pixel で設定します ||
    54 See also: TracInterfaceCustomization.
     30[[TracIni]]
    5531
    56 == [logging] ==
    57 || `log_type`  || 出力するログの種類を設定します (none, file, stderr, syslog, winlog) ||
    58 || `log_file`  || ''log_type'' が ''file'' のときに、ログファイルへのパスを設定します ||
    59 || `log_level` || ログレベルを設定します (CRITICAL, ERROR, WARN, INFO, DEBUG) ||
    60 See also: TracLogging
     32== 特殊なセクションのリファレンス == #Referenceforspecialsections
     33[[PageOutline(3,,inline)]]
    6134
    62 == [attachment] ==
    63 || `max_size` || チケットと Wiki の添付ファイルの最大サイズを指定します ||
    64 || `render_unsafe_content` || ファイル形式がバイナリ以外の場合に、ブラウザ上に表示するか、単にダウンロード可能にしておくかどうかを設定します。添付したテキストファイルがブラウザによってHTMLに変換できるということは、悪意のあるユーザにクロスサイトスクリプティング攻撃を可能にするファイルの添付を許すことになります。誰でもファイルを添付できるような公開サイトでは、このオプションを無効に設定しておくことを推奨します。(デフォルトは、無効に設定されています) ||
     35=== [components] === #components-section
     36このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。
    6537
    66 == [notification] ==
    67 || `smtp_enabled`   || メール通知を有効にするかどうかを設定します (true, false) ||
    68 || `smtp_server`    || メール通知で使用する SMTP サーバのホスト名を設定します (デフォルト: `localhost`) ||
    69 || `smtp_port`      || メール通知で使用する SMTP サーバのポート番号を設定します (デフォルト: `25`) ||
    70 || `smtp_user`      || SMTP サーバの認証ユーザ名を設定します (''0.9 以降'') ||
    71 || `smtp_password`  || SMTP サーバの認証パスワードを設定します (''0.9 以降'') ||
    72 || `smtp_from`      || 通知メールに使用する送信者アドレスを設定します ||
    73 || `smtp_replyto`   || 通知メールに使用する返信アドレスを設定します ||
    74 || `smtp_default_domain` || ドメイン名がついていないメールアドレスに特定のドメイン名を追加します (''0.10 以降'') ||
    75 || `smtp_always_cc` || 常に CC にいれるメールアドレスを設定します ||
    76 || `smtp_always_bcc` || 常に通知メールを送信するが、他の受信者にメールアドレスが見えないようにしておくメールアドレス (BCC:) を設定します (''0.10 以降'') ||
    77 || `use_public_cc` || 通知メールの受信者が、 CC された他の受信者のメールアドレスを見ることができるかを設定します (''0.10 以降'') ||
    78 || `use_short_addr` || SMTP サーバにユーザ名 / ログイン名を送信するかどうか (''0.10 以降'') ||
    79 || `always_notify_reporter` || ''報告者'' フィールドにあるアドレスに常に通知メールを送信するかを設定します ||
    80 || `always_notify_owner` || チケットの担当者に常に通知メールを送信するかを設定します (''0.9 以降'') ||
    81 || `always_notify_updater` || チケットの更新者が自らの更新した部分についての通知を受け取るかどうかを設定します (''0.10 以降'') ||
    82 || `mime_encoding` || メールの MIME エンコーディングの方法を設定します (''0.10 以降'') ||
    83 
    84 See also: TracNotification
    85 
    86 == [mimeviewer] ==
    87 || `enscript_path` || Enscript プログラムへのパスを設定します ||
    88 || `php_path` || PHP プログラムへのパスを設定します ||
    89 || `max_preview_size` || HTML プレビューでのファイルの最大サイズを設定します (''0.9 以降'') ||
    90 || `tab_width` || ファイルをプレビューするときのタブの表示幅を設定します (''0.9 以降'') ||
    91 
    92 == [ticket] ==
    93 || `default_version`   || 新規登録チケットにデフォルトで設定するバージョン ||
    94 || `default_severity`  || 新規登録チケットにデフォルトで設定する重要度 ||
    95 || `default_priority`  || 新規登録チケットにデフォルトで設定する優先度 ||
    96 || `default_milestone` || 新規登録チケットにデフォルトで設定するマイルストーン ||
    97 || `default_component` || 新規登録チケットにデフォルトで設定するコンポーネント ||
    98 || `default_type`      || 新規登録チケットにデフォルトで設定するバージョン ||
    99 || `restrict_owner`    || チケットの担当者のフィールドでドロップダウンメニューを使用するかを設定します。 [wiki:TracTickets#担当者をドロップダウンリストにする TracTickets の担当者をドロップダウンリストにする] を参照して下さい (''0.9 以降'') ||
    100 
    101 == [ticket-custom] ==
    102 [wiki:TracTicketsCustomFields ユーザ定義のチケット属性] を作成する。
    103 
    104 == [timeline] ==
    105 || `default_daysback` || タイムラインに表示する日数にデフォルト値を設定します (''0.9 以降'') ||
    106 || `changeset_show_files` || タイムラインに表示するファイル数を設定します (`-1`: 無制限, `0`: 表示しない) ||
    107 || `ticket_show_details` || タイムラインにすべてのチケットの変更を表示するかを設定します (''0.9 以降'') ||
    108 
    109 == [browser] ==
    110 || `hide_properties` || Subversion の属性値のリストをリポジトリブラウザで表示しないようにします (''0.9 以降'') ||
    111 
    112 == [wiki] ==
    113 || `ignore_missing_pages` || 存在しないページへの CamelCase リンクをハイライトするかどうかを設定します (''0.9 以降'') ||
    114 
    115 == [components] ==
    116 (''0.9 以降'')
    117 
    118 このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの使用不使用を設定するために使います。使用できる / できないコンポーネントはオプションの名前を通じて特定されます。コンポーネントが使用できるかどうかはオプションの値によって決定されます; コンポーネントを使用できるようにするために、値を `enabled` または `on` に設定してください。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは使用できません。
    119 
    120 オプションの名前はコンポーネントの完全な名前、もしくは、コンポーネントの中のモジュール / パッケージのプレフィックスとなっています。前者は 特定のコンポーネントの使用 / 不使用 を設定し、後者は特定のパッケージ / モジュールの中のコンポーネントの使用 / 不使用を設定します。
     38オプションの名前はコンポーネントの完全修飾名、もしくは、コンポーネントのモジュール/パッケージ プレフィックスとなっています。前者は 特定のコンポーネントの有効/無効を設定し、後者は特定のパッケージ/モジュール内のコンポーネントの有効/無効を設定します。
    12139
    12240以下の設定ファイルの抜粋を見てください:
     
    12745}}}
    12846
    129 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないよう Trac を設定しています。二つ目のオプションは `webadmin` パッケージの中のすべてのコンポーネントを使用できるように設定しています。後ろにつけているワイルドカードはモジュール / パッケージがマッチングする必要があります。インストールして利用可能なコンポーネントの一覧がほしい場合、 ''About Trac'' の ''Plugin'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。)
     47最初のオプションは [wiki:TracReports レポートモジュール] を使用しないように Trac を設定しています。二つ目のオプションは `webadmin` パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはモジュール/パッケージのマッチを行う場合、必須です。
     48
     49アクティブなコンポーネントの一覧を取得するには、 ''Trac について'' (訳注: 英語版では ''About Trac'') の ''Plugins'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。)
    13050
    13151See also: TracPlugins
    13252
    133 == [changeset] ==
    134 (''0.10 以降'')
     53=== [milestone-groups] === #milestone-groups-section
     54''(0.11 以降)''
    13555
    136 || `max_diff_bytes` || チェンジセットで表示する古いファイル ''と'' 新しいファイルの diff の合計サイズ。 [[br]] サイズが大きいファイルの 正確な diff をリクエストした場合、 (例: ''最終更新'' リンクを使用した場合) サイズの制限は考慮 ''されず'' 、 diff が常に出力されることに注意して下さい。||
     56今やチケットのワークフローは変更可能です。チケットステータスを数多く持つことができます。
     57単に解決した (closed) チケットと、その他のチケットを対比して表示することが、すべてのケースで
     58適切とは言えなくなりました。このセクションでは、簡単にステータスの ''グループ'' を作成ができます。
     59グループはマイルストーンのプログレスバーで異なった色で表示させることができます。
     60
     61設定の例 (closed と active しか持たない場合):
     62{{{
     63closed = closed
     64# sequence number in the progress bar
     65closed.order = 0
     66# optional extra param for the query (two additional columns: created and modified and sort on created)
     67closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     68# indicates groups that count for overall completion percentage
     69closed.overall_completion = true
     70
     71new = new
     72new.order = 1
     73new.css_class = new
     74new.label = new
     75
     76# one catch-all group is allowed
     77active = *
     78active.order = 2
     79# CSS class for this interval
     80active.css_class = open
     81# Displayed label for this group
     82active.label = in progress
     83}}}
     84
     85グループの定義は、含めるステータスをカンマ区切りのリストにして構成します。
     86また、 '*' はあらゆるステータスを意味し、残りのすべてのステータスをキャッチオールグループに
     87関連付けます。
     88
     89CSS クラスは次のいずれかを設定します: new (黄色), open (無色), closed (緑色)。
     90新しくスタイルを追加するには、以下のセレクタを使用します:
     91`table.progress td.<class>`
     92
     93=== [repositories] === #repositories-section
     94
     95(''0.12 以降'' のマルチリポジトリ)
     96
     97trac.ini の `[repositories]` セクションに設定できることは、新しいリポジトリを登録すること以外にもあります。
     98
     99使い勝手を増すエイリアスや、一時的なリポジトリ、インストール時の初期状態などを設定することができます。
     100
     101このセクションとその他諸々の書き方についての詳細は [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] を参照してください。
     102
     103=== [svn:externals] === #svn:externals-section
     104''(0.11 以降)''
     105
     106Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。
     107デフォルトでは URL をリンクとして処理できるだけであり、 Trac 自身はリモートとなるリポジトリをブラウズすることはできません。
     108
     109しかしながら、別の Trac インスタンス (または [http://www.viewvc.org/ ViewVC] のような別のリポジトリブラウザ) がリンク先のリポジトリにをブラウズできるように設定されていれば、別のリポジトリブラウザを指す外部の URL を Trac に設定しておくことができます。
     110
     111このマッピングは TracIni の `[svn:externals]` セクションで設定します。
     112
     113例:
     114{{{
     115[svn:externals]
     1161 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1172 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
     1183 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
     1194 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
     120}}}
     121上記では、 `svn://anotherserver.com/tools_repository/tags/1.1/tools` という external は `http://ourserver/tracs/tools/browser/tags/1.1/tools?rev=` にマップされます (`rev` は external にリビジョンが指定された場合、適切なリビジョン番号に設定されます。詳細は [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book の externals] を参照してください)。
     122
     123Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。
     124
     125最後に [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] で導入された相対 URL は、現在のところサポートしていません。
     126
     127=== [ticket-custom] === #ticket-custom-section
     128
     129このセクションでは、チケットに追加フィールドを定義することができます。詳しくは TracTicketsCustomFields を参照してください。
     130
     131=== [ticket-workflow] === #ticket-workflow-section
     132''(0.11 以降)''
     133
     134チケットのワークフローはプラグインで制御します。
     135デフォルトでは `ConfigurableTicketWorkflow` コンポーネントが制御を行います。
     136このコンポーネントでは、 trac.ini ファイルのこのセクションでワークフローを設定することが可能です。
     137詳細は TracWorkflow を参照してください。
    137138
    138139----