Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
Sep 2, 2019, 4:56:56 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v1 v2  
    1 = Trac Environment = #TracEnvironment
     1= The Trac Environment
    22
    3 Trac はプロジェクトのデータを保存するために、ディレクトリ構造とデータベースを使用します。このディレクトリを "Environment" と呼びます。
     3[[TracGuideToc]]
     4[[PageOutline(2-5,Contents,pullout)]]
    45
    5 == Environment の作成 == #CreatinganEnvironment
     6Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
    67
    7 新しい Trac Environment を作成するには、 [TracAdmin#initenv trac-admin の initenv] を使用します:
    8 {{{
     8Trac supports [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] databases. With PostgreSQL and MySQL you have to create the database before running `trac-admin initenv`.
     9
     10== Creating an Environment
     11
     12A new Trac environment is created using the [TracAdmin#initenv initenv] command:
     13{{{#!sh
    914$ trac-admin /path/to/myproject initenv
    1015}}}
    1116
    12 `trac-admin` はプロジェクトの名前とデータベースに接続するための文字列
    13 (後で説明します) を尋ねてきます。
     17`trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
    1418
    15 === Tips === #SomeUsefulTips
    16  - Environment のディレクトリ配下は、 Web サーバの実行ユーザが書き込み可能でなければなりません。
    17  適切なパーミッションの付与を忘れないようにしてください。
    18  同じことがソースコードリポジトリにも当てはまりますが、
    19  Subversion リポジトリの場合は、ファイルシステムに Barkley DB を使用していない場合は、 Trac は読み取りパーミッションしか必要としません。 Subversion以外のリポジトリについては、各々のプラグインを確認してください
     19A base configuration can be specified using the `--inherit` or `--config` options. The `--inherit` option can be specified one or more times to utilize a [TracIni#GlobalConfiguration global configuration]. The options specified in a `--config` file will be used to override the defaults when initializing `trac.ini`. See below for an [#SourceCodeRepository example] of defining repositories in a configuration file.
    2020
    21  - `initenv` で Subversion リポジトリを使用するように指定されても、 trac-admin コマンドは指定されたリポジトリのパスに対して `svnadmin create` を実行したりしません。新しい Trac enviroment を作るときに、 Subversion リポジトリも新規で作る場合は、 `svnadmin create` は `trac-admin initenv` よりも前に実行しておいてください。 Environment の初期化中にリポジトリが見つからない場合、 "Warning: couldn't index the repository" というメッセージが表示されてしまいます
     21=== Useful Tips
    2222
    23  - 非 ASCII 文字を含むパスはサポートされていません
     23 - Place your environment's directory on a filesystem which supports sub-second timestamps, as Trac monitors the timestamp of its configuration files and changes happening on a filesystem with too coarse-grained timestamp resolution may go undetected in Trac < 1.0.2. This is also true for the location of authentication files when using TracStandalone.
    2424
    25  - プロジェクト名に空白文字が混じっていると認証で問題が生じることがありますので注意してください  ([trac:#7163 #7163] を参照して下さい。)
     25 - The user under which the web server runs will require file system write permission to the environment directory and all the files inside. Please remember to set the appropriate permissions. The same applies to the source code repository, although the user under which Trac runs will only require write access to a Subversion repository created with the BDB file system; for other repository types, check the corresponding plugin's documentation.
    2626
    27  - [TracIni#GlobalConfiguration グローバル設定ファイル] に定義した [TracIni#inherit-section 共有するプラグインのディレクトリ] に配置した TracPlugins は Environment の作成時はロードされないようになりました。そのため、データベースのテーブルなどを追加で作成する必要がある場合は [TracUpgrade#UpgradetheTracEnvironment Environment をアップグレード] せねばなりません
     27 - Non-ascii environment paths are not supported.
    2828
    29 == データベースに接続するための文字列 == #DatabaseConnectionStrings
     29 - TracPlugins located in a [TracIni#inherit-plugins_dir-option shared plugins directory] that is defined in an [TracIni#GlobalConfiguration inherited configuration] are not enabled by default, in contrast to plugins in the environment `plugins` directory. Hence, if they need to create extra tables, for example, the tables will not be created during environment creation and you'll need to [TracUpgrade#UpgradetheTracEnvironment upgrade the environment]. Alternatively you can avoid the need to upgrade the environment by explicitly enabling the plugin(s) in a configuration file using the `--inherit` or `--config` option. See TracAdmin#FullCommandReference for more information.
    3030
    31 バージョン 0.9 以降、 Trac は [http://sqlite.org/ SQLite] と
    32 [http://www.postgresql.org/ PostgreSQL] データベースバックエンドの両方をサポートします。
    33 [http://mysql.com/ MySQL] のサポートは 0.10 で加えられました。 デフォルトでは
    34 SQLiLte を使用します。 (ほとんどのプロジェクトは SQLite で十分です)。データベース
    35 ファイルは Environment ディレクトリに保存されますので、 Environment の残りと共に容易に
    36 [wiki:TracBackup バックアップ] することができます。
     31{{{#!div style="border: 1pt dotted; margin: 1em;"
     32**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
    3733
    38 === SQLite の接続文字列 === #SQLiteConnectionString
    39 SQLite データベースに接続するための文字列は以下の通りです:
     34This is a common beginners' mistake.
     35It happens that the structure for a Trac environment is loosely modeled after the Subversion repository directory structure, but those are two disjoint entities and they are not and //must not// be located at the same place.
     36}}}
     37
     38== Database Connection Strings
     39
     40You will need to specify a database connection string at the time the environment is created. The default is SQLite, which is sufficient for most projects. The SQLite database file is stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment.
     41
     42Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be [http://meyerweb.com/eric/tools/dencoder/ URL encoded].
     43{{{#!sh
     44$ python -c "import urllib; print urllib.quote('password@:/123', '')"
     45password%40%3A%2F123
     46}}}
     47
     48=== SQLite Connection String
     49
     50The connection string for an SQLite database is:
    4051{{{
    4152sqlite:db/trac.db
    4253}}}
    43 `db/trac.db` の箇所は Trac Environment のデータベースファイルへのパスを指します。
     54where `db/trac.db` is the path to the database file within the Trac environment.
    4455
    45 === PostgreSQL の接続文字列 === #PostgreSQLConnectionString
    46 PostgreSQL や MySQL を代わりに使用する場合、異なる接続用文字列を
    47 使用しなければなりません。 例えば PostgreSQL に接続するとき、
    48 ユーザ名 `johndoe` でパスワード `letmein` で
    49 同じマシンの `trac` と呼ばれるデータベースに接続するには以下のように指定します:
     56=== PostgreSQL Connection String
     57
     58The connection string for PostgreSQL is a bit more complex. For example, to connect to a PostgreSQL database named `trac` on `localhost` for user `johndoe` and password `letmein`, use:
    5059{{{
    5160postgres://johndoe:letmein@localhost/trac
    5261}}}
    53 ''"/" 及び "@" はパスワードの一部として使用出来ないので注意してください''
    5462
    55 PostgreSQL がデフォルト以外のポート番号 (例えば、 9432) で起動しているときはこのようにします:
     63If PostgreSQL is running on a non-standard port, for example 9342, use:
    5664{{{
    5765postgres://johndoe:letmein@localhost:9342/trac
    5866}}}
    5967
    60 UNIX ホストでは、 UNIX ソケットで接続するように設定できます。
    61 この場合、環境変数 PGHOST に定義されたデフォルトソケットを使用します:
     68On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
    6269{{{
    6370postgres://user:password@/database
    6471}}}
    65 ソケットを特定する場合はこうです:
     72
     73or a specific one:
    6674{{{
    6775postgres://user:password@/database?host=/path/to/socket/dir
    6876}}}
    6977
    70 PostgreSQL を使用するとき、 `trac-admin initenv` を実行する前に
    71 データベースを作成しなければいけません。
    72 
    73 [http://postgresql.org PostgreSQL] の詳細設定の方法については　[http://www.postgresql.org/docs/ PostgreSQL ドキュメント] を参照してください。
    74 下記は `tracuser` という名のデータベースユーザ及び `trac` という名のデータベースを作成します。
    75 {{{
    76 createuser -U postgres -E -P tracuser
    77 createdb -U postgres -O tracuser -E UTF8 trac
    78 }}}
    79 `createuser` を実行する時、'tracuser' のパスワードの入力を促されます。この新しいユーザはスーパーユーザではないので、他のデータベースを作ったり、他の role (訳注: PostgreSQL でのユーザ) を作る権限を与えられていません。これらの権限は trac のインスタンスを実行する為には必要ではありません。ユーザにパスワードを付与したくない場合、 `createuser` コマンドから `-P` と `-E` オプションを取り除いてください。また、データベースが UTF8 で作成する必要があることに注意してください。 LATIN1 のエンコードが原因のエラーを引き起こします。 SQL_ASCII でも同様です。
    80 
    81 デフォルト設定 (debian) の下では、 `postgres` ユーザとして `createuser` と `createdb` スクリプトを実行してください。 例えば:
    82 {{{
    83 sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
    84 sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     78See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     79Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
     80{{{#!sh
     81$ createuser -U postgres -E -P tracuser
     82$ createdb -U postgres -O tracuser -E UTF8 trac
    8583}}}
    8684
    87 Trac はデフォルトで `public` スキーマを使用しますが、明示的に違うスキーマを指定することができます:
     85When running `createuser` you will be prompted for the password for the `tracuser`. This new user will not be a superuser, will not be allowed to create other databases and will not be allowed to create other roles. These privileges are not needed to run a Trac instance. If no password is desired for the user, simply remove the `-P` and `-E` options from the `createuser` command. Also note that the database should be created as UTF8. LATIN1 encoding causes errors, because of Trac's use of unicode.
     86
     87Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
     88{{{#!sh
     89$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     90$ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     91}}}
     92
     93Trac uses the `public` schema by default, but you can specify a different schema in the connection string:
    8894{{{
    8995postgres://user:pass@server/database?schema=yourschemaname
    9096}}}
    9197
    92 === MySQL の接続文字列 === #MySQLConnectionString
     98=== MySQL Connection String
    9399
    94 MySQL を代わりに使用したい場合、違う接続文字列を使用します。
    95 例えば、同じマシンにある `trac` という MySQL データベースに、
    96 `johndoe` というユーザでパスワード `letmein` で接続する場合の
    97 MySQL の接続文字列は次の通りです:
     100The format of the MySQL connection string is similar to PostgreSQL, with the `postgres` scheme being replaced by `mysql`. For example, to connect to a MySQL database on `localhost` named `trac` for user `johndoe` with password `letmein`:
    98101{{{
    99102mysql://johndoe:letmein@localhost:3306/trac
    100103}}}
    101104
    102 == ソースコードリポジトリ == #SourceCodeRepository
     105=== Changing Database Backend
    103106
    104 0.12 以降のバージョンでは、一つの Environment から複数のリポジトリに接続できるようになりました。 Environment からリポジトリに接続する方法は沢山あるので、詳細は TracRepositoryAdmin を参照してください。左記のページではリポジトリごとに設定する項目 (`type`, `url`, `description` など) について詳しく解説されています。
     107The TracAdmin `convert_db` command allows migrating between SQLite, MySQL and PostgreSQL databases.
    105108
    106 Trac 0.12 の `trac-admin` コマンドでは、接続するリポジトリの指定が必須ではなくなりました。デフォルトでは Trac はソースコードリポジトリへの接続を作成せず、メインナビゲーションの ''リポジトリブラウザ'' (英語版では ''Browse Source'') も表示されなくなります。
    107 ロードされている `trac.versioncontrol.*` コンポーネントを完全に無効化するには下記設定を行ってください
    108 {{{
     109[[TracAdminHelp(convert_db)]]
     110
     111== Deleting a Trac Environment
     112
     113The Trac environment can be deleted using standard filesystem utilities to delete the directory that was passed to the `initenv` command. For an environment using SQLite, this will also delete the SQLite database, which resides on-disk in the environment `db` directory. For an environment using PostgreSQL or MySQL, you will need to use the associated database utilities to delete the database.
     114
     115== Source Code Repository
     116
     117A single environment can be connected to more than one repository. However, by default Trac is not connected to any source code repository, and the ''Browse Source'' navigation item will not be displayed. There are several ways to connect repositories to an environment, see TracRepositoryAdmin.
     118
     119Repositories can be defined at the time of environment creation by specifying a configuration file to the `initenv` command using the `--config` or `--inherit` options. Cached repositories will be synchronized if the repository connector(s) are enabled. Example:
     120
     121{{{#!sh
     122$ trac-admin $ENV initenv --config=config.ini
     123$ cat config.ini
    109124[components]
    110 trac.versioncontrol.* = disabled
     125tracopt.versioncontrol.* = enabled
     126
     127[repositories]
     128.dir = /path/to/default/type/repos
     129repos1.type = git
     130repos1.dir = /path/to/git/repos
     131repos2.type = svn
     132repos2.dir = /path/to/svn/repos
    111133}}}
    112134
    113 バージョン管理システムによっては、リポジトリへのパスだけではなく、リポジトリ内の ''scope'' を設定することもできます。
    114 Trac はそのスコープ以下に限定したファイルとチェンジセットに関連する情報を表示します。
    115 Trac のバックエンドに Subversion を 使う場合は、この機能を利用できます。
    116 他のリポジトリシステムについては、対応するプラグインのドキュメントで確認して下さい。
     135== Directory Structure
    117136
    118 デフォルトリポジトリのみで構成される Subversion リポジトリの設定の一例です:
    119 {{{
    120 [trac]
    121 repository_type = svn
    122 repository_dir = /path/to/your/repository
    123 }}}
     137An environment consists of the following files and directories:
    124138
    125 スコープを絞った Subversion リポジトリの設定の一例です:
    126 {{{
    127 [trac]
    128 repository_type = svn
    129 repository_dir = /path/to/your/repository/scope/within/repos
    130 }}}
    131 
    132 == ディレクトリ構造 == #DirectoryStructure
    133 
    134 プロジェクト Environment のディレクトリは通常、以下に示すファイルとディレクトリから成り立ちます。
    135 
    136  * `README` - Environment について記述したドキュメント
    137  * `VERSION` - Environment のバージョン識別情報
    138  * `attachments` - 全ての添付ファイルはここに保存されます
     139 * `README` - Brief description of the environment.
     140 * `VERSION` - Environment version identifier.
     141 * `files`
     142  * `attachments` - Attachments to wiki pages and tickets.
    139143 * `conf`
    140    * `trac.ini` - メインとなる設定ファイル。詳細は TracIni に記述しています
     144  * `trac.ini` - Main [TracIni configuration file].
    141145 * `db`
    142    * `trac.db` - SQLite データベース (SQLite を使用している場合)
    143  * `htdocs` - Web のリソースを格納するディレクトリ、URL `/htdocs/site/...` を使用した Genshi テンプレートから参照する ''(0.11 以降)''
    144  * `log` - ログファイルのデフォルトディレクトリ、ログ機能が有効に設定され相対パスが与えられた場合に使用する
    145  * `plugins` - Environment に固有の [wiki:TracPlugins プラグイン] (Python egg または単独のファイル、 [http://trac.edgewall.org/milestone/0.10 0.10] 以降)
    146  * `templates` - カスタム (プロジェクトに固有の) Genshi テンプレート ''(0.11 以降)''
    147    * `site.html` - カスタムヘッダ, フッタ, スタイルシート。 TracInterfaceCustomization#SiteAppearance に記載
    148 
    149 === 要注意: ''Trac Environment のディレクトリ'' と ''ソースコードリポジトリのディレクトリ'' を一緒にしないで下さい。 #Caveat
    150 
    151 初心者がよくやる誤りです。
    152 上記のディレクトリ構造は Subversion リポジトリのディレクトリ構造をざっくりと真似ているだけです。
    153 全く関連はありませんので、2つは同じ場所においては ''いけません''。
     146  * `trac.db` - The SQLite database, if you are using SQLite.
     147 * `htdocs` - Directory containing web resources, which can be referenced in templates using the path `/chrome/site/...`.
     148 * `log` - Default directory for log files when `file` logging is enabled and a relative path is given.
     149 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
     150 * `templates` - Custom Genshi environment-specific templates.
     151  * `site.html` - Method to [TracInterfaceCustomization#SiteAppearance customize] the site header, footer, and style.
    154152
    155153----
    156 See also: TracAdmin, TracBackup, TracIni, TracGuide
     154See also: TracAdmin, TracBackup, TracIni