Changes between Version 5 and Version 6 of TracIni


Ignore:
Timestamp:
Jan 28, 2010, 4:25:36 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v5 v6  
    1 = Trac 設定ファイル =
     1= The Trac Configuration File =
     2
    23[[TracGuideToc]]
    34
    4 Trac の設定は '''`trac.ini`''' 設定ファイルを設定することによって行います。設定ファイルは `<projectenv>/conf/trac.ini` にあります。
     5== Global Configuration ==
    56
    6 == グローバルな設定 ==
     7In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or sometimes /etc/trac/trac.ini depending on the distribution. If you're upgrading, you may want to specify that file to inherit from.
    78
    8 バージョン 0.9 から、Trac は グローバルな `trac.ini` ファイルの設定を読み込むことができるようになりました。これらのグローバルオプションは、環境ごとに特別にオプションに組み込まれ、同じオプションを指定した場合、ローカルのオプションがグローバルなオプションを上書きします。
     9Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
     10{{{
     11[inherit]
     12file = /usr/share/trac/conf/trac.ini
     13}}}
    914
    10 グローバル設定ファイルは、通常 `$prefix/share/trac/conf/trac.ini` にあります。この設定ファイルは、他の場所に移すこともできます (例えば、 `/etc/trac.ini`) しかし、設定を変更するには Trac をインストールするときに生成される `trac/siteconfig.py` ファイルを変更する必要があります。
    11 
    12 == リファレンス ==
    13 
    14 これは現在利用できる設定オプションの簡単なリファレンスです。
    15 
    16 '''Note:[http://trac.edgewall.org/milestone/0.10 mileston:0.10] 以降、 TracIni のリファレンスは
    17 TracIniMacro を使って、ソースコードから自動生成されたものになります。しかしこのページでは、
    18 古い ''wiki'' の内容のままにするので、以前通りに、コミュニティによって簡単に
    19 ドキュメントを修正できます。'''
     15Note that you can also specify a global option file when creating a new project,  by adding the option
     16`--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command.
     17If you would not do this but nevertheless intend to use a global option file with your new environment,
     18you would have to go through the newly generated conf/trac.ini file and delete the entries that would
     19otherwise override those set in the global file.
    2020
    2121
    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` || メインナビゲーションバーに表示されるセクションの順を設定します。 ||
     22== Reference ==
    3723
    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` || ページのフッタに表示するテキストを設定します (右詰めで表示されます) ||
     24This is a brief reference of available configuration options.
    4725
    48 == [header_logo] ==
    49 || `src`    || ヘッダロゴに使用するイメージファイルの URL を設定します ||
    50 || `link`   || ヘッダロゴがリンクする URL を設定します ||
    51 || `alt`    || ヘッダロゴに使用する ''alt'' テキストを設定します ||
    52 || `width`  || ヘッダロゴの幅を pixel で設定します ||
    53 || `height` || ヘッダロゴの高さを pixel で設定します ||
    54 See also: TracInterfaceCustomization.
     26[[TracIni()]]
    5527
    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
    6128
    62 == [attachment] ==
    63 || `max_size` || チケットと Wiki の添付ファイルの最大サイズを指定します ||
    64 || `render_unsafe_content` || ファイル形式がバイナリ以外の場合に、ブラウザ上に表示するか、単にダウンロード可能にしておくかどうかを設定します。添付したテキストファイルがブラウザによってHTMLに変換できるということは、悪意のあるユーザにクロスサイトスクリプティング攻撃を可能にするファイルの添付を許すことになります。誰でもファイルを添付できるような公開サイトでは、このオプションを無効に設定しておくことを推奨します。(デフォルトは、無効に設定されています) ||
     29== [components] == #components-section
     30This section is used to enable or disable components provided by plugins, as well as by Trac itself. The component to enable/disable is specified via the name of the option. Whether its enabled is determined by the option value; setting the value to `enabled` or `on` will enable the component, any other value (typically `disabled` or `off`) will disable the component.
    6531
    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 以降'') ||
     32The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module.
    8333
    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 オプションの名前はコンポーネントの完全な名前、もしくは、コンポーネントの中のモジュール / パッケージのプレフィックスとなっています。前者は 特定のコンポーネントの使用 / 不使用 を設定し、後者は特定のパッケージ / モジュールの中のコンポーネントの使用 / 不使用を設定します。
    121 
    122 以下の設定ファイルの抜粋を見てください:
     34Consider the following configuration snippet:
    12335{{{
    12436[components]
     
    12739}}}
    12840
    129 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないよう Trac を設定しています。二つ目のオプションは `webadmin` パッケージの中のすべてのコンポーネントを使用できるように設定しています。後ろにつけているワイルドカードはモジュール / パッケージがマッチングする必要があります。インストールして利用可能なコンポーネントの一覧がほしい場合、 ''About Trac'' の ''Plugin'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。)
     41The first option tells Trac to disable the [wiki:TracReports report module]. The second option instructs Trac to enable all components in the `webadmin` package. Note that the trailing wildcard is required for module/package matching.
     42
     43See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
    13044
    13145See also: TracPlugins
    13246
    133 == [changeset] ==
    134 (''0.10 以降'')
     47== [ticket-custom] == #ticket-custom-section
    13548
    136 || `max_diff_bytes` || チェンジセットで表示する古いファイル ''と'' 新しいファイルの diff の合計サイズ。 [[br]] サイズが大きいファイルの 正確な diff をリクエストした場合、 (例: ''最終更新'' リンクを使用した場合) サイズの制限は考慮 ''されず'' 、 diff が常に出力されることに注意して下さい。||
     49In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     50
     51== [ticket-workflow] == #ticket-workflow-section
     52''(since 0.11)''
     53
     54The workflow for tickets is controlled by plugins.
     55By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     56That component allows the workflow to be configured via this section in the trac.ini file.
     57See TracWorkflow for more details.
     58
     59== [milestone-groups] == #milestone-groups-section
     60''(since 0.11)''
     61
     62As the workflow for tickets is now configurable, there can be many ticket states,
     63and simply displaying closed tickets vs. all the others is maybe not appropriate
     64in all cases. This section enables one to easily create ''groups'' of states
     65that will be shown in different colors in the milestone progress bar.
     66
     67Example configuration (which is also the default):
     68{{{
     69closed = closed
     70closed.order = 0                     # sequence number in the progress bar
     71closed.query_args = group=resolution # optional extra param for the query
     72closed.overall_completion = true     # count for overall completion
     73
     74active = *                           # one catch-all group is allowed
     75active.order = 1
     76active.css_class = open              # CSS class for this interval
     77active.label = in progress           # Displayed label for this group
     78}}}
     79
     80The definition consists in a comma-separated list of accepted status.
     81Also, '*' means any status and could be used to associate all remaining
     82states to one catch-all group.
     83
     84The CSS class can be one of: new (yellow), open (no color) or
     85closed (green). New styles can easily be added using the following
     86selector:  `table.progress td.<class>`
     87
     88== [svn:externals] == #svn:externals-section
     89''(since 0.11)''
     90
     91The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
     92However, if those externals are ''not'' using the `http:` protocol, or if a link to a different repository browser (such another Trac or [http://www.viewvc.org/ ViewVC]) is desired, then Trac needs to be able to map an external prefix to this other URL.
     93
     94This mapping is done in the `[svn:externals]` section of the TracIni
     95
     96Example:
     97{{{
     98[svn:externals]
     991 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
     1002 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
     1013 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
     1024 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
     103}}}
     104With the above, the `svn://anotherserver.com/tools_repository/tags/1.1/tools` external will be mapped to `http://ourserver/trac/support/browser/tags/1.1/tools?rev=` (and `rev` will be set to the appropriate revision number if the external additionally specifies a revision, see the [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details).
     105
     106Note that the number used as a key in the above section is purely used as a place holder, as the URLs themselves can't be used as a key due to various limitations in the configuration file parser.
    137107
    138108----