Changes between Version 1 and Version 2 of TracIni
- Timestamp:
- 12/14/10 02:51:48 (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracIni
v1 v2 1 = Trac 設定ファイル = 1 = The Trac Configuration File = 2 2 3 [[TracGuideToc]] 3 4 4 Trac の設定は '''`trac.ini`''' という設定ファイルを編集して行います。設定ファイルは `<projectenv>/conf/trac.ini` にあります。5 Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. Changes to the configuration are usually reflected immediately, though changes to the `[components]` or `[logging]` sections will require restarting the web server. You may also need to restart the web server after creating a global configuration file when none was previously present. 5 6 6 == グローバルな設定 == 7 The `trac.ini` configuration file should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches. 7 8 8 バージョン 0.9 から、Trac は グローバルな `trac.ini` ファイルの設定を読み込むことができるようになりました。これらのグローバルオプションは、環境ごとに特別にオプションに組み込まれ、同じオプションを指定した場合、ローカルのオプションがグローバルなオプションを上書きします。 9 == Global Configuration == 9 10 10 グローバル設定ファイルは、通常 `$prefix/share/trac/conf/trac.ini` にあります。この設定ファイルは、他の場所に移すこともできます(例えば、 `/etc/trac.ini`)しかし、設定を変更するには Trac をインストールするときに生成される `trac/siteconfig.py` ファイルを変更する必要があります。 11 In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or /etc/trac/trac.ini, depending on the distribution. If you're upgrading, you may want to specify that file to inherit from. Literally, when you're upgrading to 0.11, you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location. 11 12 12 == リファレンス == 13 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 14 {{{ 15 [inherit] 16 file = /path/to/global/trac.ini 17 }}} 18 Multiple files can be specified using a comma-separated list. 13 19 14 これは現在利用できる設定オプションの簡単なリファレンスです。 20 Note that you can also specify a global option file when creating a new project, by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command. If you do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated `conf/trac.ini` file and delete the entries that will otherwise override those set in the global file. 15 21 16 == [trac] == 17 || `database` || このプロジェクト用の[wiki:TracEnvironment#データベースに接続するための文字列 データベースに接続するための文字列] || 18 || `default_charset` || Subversionのリポジトリで使用するテキストファイルの文字コード。(デフォルトは `iso-8859-15`) || 19 || `default_handler` || ベースURLへの要求を処理するコンポーネントの名前 (デフォルトは `WikiHandler`) (''0.9 以降'') || 20 || `repository_dir` || Subversion リポジトリへのローカルパス || 21 || `authz_file` || Subversion の [http://svnbook.red-bean.com/en/1.1/ch06s04.html#svn-ch-6-sect-4.4.2 認証 (authz) ファイル]へのパス || 22 || `authz_module_name` || `authz_file` で使用されるモジュールのプレフィックス (See [http://projects.edgewall.com/trac/wiki/FineGrainedPermissions FineGrainedPermissions])|| 23 || `check_auth_ip` || 認証時にユーザのIPアドレスをチェックするかどうか (true, false) (''0.9 以降'') || 24 || `ignore_auth_case` || ログイン名で大文字小文字を無視するかどうか (true, false) (''0.9 以降'') || 25 || `templates_dir` || !ClearSilver テンプレートへのパス || 22 There are two more entries in the [[#inherit-section| [inherit] ]] section, `templates_dir` for sharing global templates and `plugins_dir`, for sharing plugins. Those entries can themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there. 26 23 27 == [project] == 28 || `name` || プロジェクト名 || 29 || `descr` || プロジェクトの概要 || 30 || `url` || プロジェクトの主な Web サイトへの URL || 31 || `icon` || URL のショートカットアイコンとして使用されるアイコンファイル (favicon) || 32 || `footer` || ページのフッタのテキスト (右揃え) || 24 == Reference for settings 33 25 34 == [header_logo] == 35 || `src` || ヘッダロゴとして使用する画像へのURL || 36 || `link` || ヘッダロゴに貼るリンク || 37 || `alt` || ヘッダロゴ用の ''alt'' テキスト || 38 || `width` || ヘッダロゴの幅 (ピクセルで指定) || 39 || `height` || ヘッダロゴの高さ (ピクセルで指定) || 40 See also: TracInterfaceCustomization. 26 This is a brief reference of available configuration options. 41 27 42 == [logging] == 43 || `log_type` || ログの種類。 (none, file, stderr, syslog, winlog) || 44 || `log_file` || ''log_type'' が ''file'' のとき、ログファイルへのパスを記述します。 || 45 || `log_level` || ログレベル (CRITICAL, ERROR, WARN, INFO, DEBUG) || 46 See also: TracLogging 28 ''Note that the [bitten], [spam-filter] and [vote] sections below are added by plugins enabled on this Trac, and therefore won't be part of a default installation.'' 47 29 48 == [attachment] == 49 || `max_size` || チケットと Wiki で添付できる最大のファイルサイズ。 || 30 [[TracIni]] 50 31 51 == [notification] == 52 || `smtp_enabled` || SMTP (e-mail) での通知の可否 (true, false) || 53 || `smtp_server` || 通知メールに使用するSMTPサーバ || 54 || `smtp_user` || SMTP サーバの認証ユーザ名 (''0.9 以降'') || 55 || `smtp_password` || SMTP サーバの認証パスワード (''0.9 以降'') || 56 || `smtp_from` || 通知メールに使用する送信者アドレス || 57 || `smtp_replyto` || 通知メールに使用する返信アドレス || 58 || `smtp_always_cc` || 常に CC にいれるメールアドレス || 59 || `always_notify_reporter` || ''報告者'' 属性に登録されているアドレスに通知メールを常に送信する || 60 || `always_notify_owner` ||''担当者'' 属性に登録されているアドレスに通知メールを常に送信する。 (''0.9 以降'') || 61 See also: TracNotification 32 == Reference for special sections 33 [[PageOutline(3,,inline)]] 62 34 63 == [mimeviewer] == 64 || `enscript_path` || Enscript プログラムへのパス || 65 || `php_path` || PHP プログラムへのパス || 66 || `max_preview_size` || HTML プレビューの最大ファイルサイズ (''0.9 以降'') || 67 || `tab_width` ||ファイルプレビューで表示するタブ幅 (''0.9 以降'') || 35 === [components] === #components-section 36 This 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. 68 37 69 == [ticket] == 70 || `default_version` || 新規チケットのデフォルトのバージョン || 71 || `default_severity` || 新規チケットのデフォルトの重要度 || 72 || `default_priority` || 新規チケットのデフォルトの優先度 || 73 || `default_milestone` || 新規チケットのデフォルトのマイルストーン || 74 || `default_component` || 新規チケットのデフォルトのコンポーネント || 75 || `restrict_owner` || チケットの担当者属性にドロップダウンメニューを使用する (0.9 以降) || 38 The 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. 76 39 77 == [ticket-custom] == 78 [wiki:TracTicketsCustomFields ユーザ定義のチケット属性] を作成する。 79 80 == [timeline] == 81 || `default_daysback` || タイムラインで表示する履歴日数のデフォルト値 (''0.9 以降'') || 82 || `changeset_show_files` || 表示するファイル数 (-1 で無制限, 0 で無効) || 83 || `ticket_show_details` || タイムラインでチケットの詳細を表示するか || 84 85 == [browser] == 86 || `hide_properties` || リポジトリブラウザで Subversion のプロパティのリスト表示をしない。 (''0.9 以降'') || 87 88 == [wiki] == 89 || `ignore_missing_pages` || 削除されたページの CamelCase のリンクをハイライトするかどうか (enable/disable) (''0.9 以降'') || 90 91 == [components] == 92 (''0.9 以降'') 93 94 このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの使用不使用を設定するために使います。使用できる/できないコンポーネントはオプションの名前を通じて特定されます。コンポーネントが使用できるかどうかはオプションの値によって決定されます; コンポーネントを使用できるようにするために、値を `enabled` または `on` に設定してください。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは使用できません。 95 96 オプションの名前はコンポーネントの完全な名前、もしくは、コンポーネントの中のモジュール / パッケージのプレフィックスとなっています。前者は 特定のコンポーネントの使用 / 不使用 を設定し、後者は特定のパッケージ / モジュールの中のコンポーネントの使用 / 不使用を設定します。 97 98 以下の設定ファイルの抜粋を見てください: 40 Consider the following configuration snippet: 99 41 {{{ 100 42 [components] … … 103 45 }}} 104 46 105 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないよう Trac を設定しています。二つ目のオプションは `webadmin` パッケージの中のすべてのコンポーネントを使用できるように設定しています。後ろにつけているワイルドカードはモジュール / パッケージがマッチングする必要があります。 47 The 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. 106 48 107 ''Trac について'' の ''Plugins'' ページを見てください。現在利用可能なコンポーネントの一覧が表示されています。(`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要です。)49 See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 108 50 109 51 See also: TracPlugins 110 52 111 ''Trac のリビジョン[http://projects.edgewall.com/trac/changeset/2335 r2335] (バージョン 0.9b1, 0.9b2 に適用されている) 以前では、このセクションの代わりに、 `[disabled_components]` セクションが使われています。このページの [http://projects.edgewall.com/trac/wiki/TracIni?version=42 以前のバージョン] に詳細が書かれています。'' 53 === [milestone-groups] === #milestone-groups-section 54 ''(since 0.11)'' 55 56 As the workflow for tickets is now configurable, there can be many ticket states, 57 and simply displaying closed tickets vs. all the others is maybe not appropriate 58 in all cases. This section enables one to easily create ''groups'' of states 59 that will be shown in different colors in the milestone progress bar. 60 61 Example configuration (the default only has closed and active): 62 {{{ 63 closed = closed 64 # sequence number in the progress bar 65 closed.order = 0 66 # optional extra param for the query (two additional columns: created and modified and sort on created) 67 closed.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 69 closed.overall_completion = truepercentage 70 71 new = new 72 new.order = 1 73 new.css_class = new 74 new.label = new 75 76 # one catch-all group is allowed 77 active = * 78 active.order = 2 79 # CSS class for this interval 80 active.css_class = open 81 # Displayed label for this group 82 active.label = in progress 83 }}} 84 85 The definition consists in a comma-separated list of accepted status. 86 Also, '*' means any status and could be used to associate all remaining 87 states to one catch-all group. 88 89 The CSS class can be one of: new (yellow), open (no color) or 90 closed (green). New styles can easily be added using the following 91 selector: `table.progress td.<class>` 92 93 === [repositories] === #repositories-section 94 95 (''since 0.12'' multirepos) 96 97 One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. 98 99 This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. 100 101 See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. 102 103 === [svn:externals] === #svn:externals-section 104 ''(since 0.11)'' 105 106 The TracBrowser for Subversion can interpret the `svn:externals` property of folders. 107 By default, it only turns the URLs into links as Trac can't browse remote repositories. 108 109 However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL. 110 111 This mapping is done in the `[svn:externals]` section of the TracIni 112 113 Example: 114 {{{ 115 [svn:externals] 116 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 117 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 118 3 = http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 119 4 = svn://anotherserver.com/tools_repository http://ourserver/tracs/tools/browser/$path?rev=$rev 120 }}} 121 With the above, the `svn://anotherserver.com/tools_repository/tags/1.1/tools` external will be mapped to `http://ourserver/tracs/tools/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). 122 123 Note 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. 124 125 Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 126 127 === [ticket-custom] === #ticket-custom-section 128 129 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 130 131 === [ticket-workflow] === #ticket-workflow-section 132 ''(since 0.11)'' 133 134 The workflow for tickets is controlled by plugins. 135 By default, there's only a `ConfigurableTicketWorkflow` component in charge. 136 That component allows the workflow to be configured via this section in the trac.ini file. 137 See TracWorkflow for more details. 112 138 113 139 ----