Changes between Version 1 and Version 2 of TracEnvironment

08/27/15 23:20:06 (2 years ago)



  • TracEnvironment

    v1 v2  
    1 = Trac Environment =
     1= The Trac Environment
    3 Trac はプロジェクトのデータを保存するために、ディレクトリ構造とデータベースを使用します。このディレクトリを "Environment" と呼びます。
    5 == Environment の作成 ==
     6Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
    7 新しい Trac Environment を作成するには、 [wiki:TracAdmin trac-admin] コマンドを使用します:
    8 {{{
    9 $ trac-admin /path/to/projectenv initenv
     8== Creating an Environment
     10A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     12$ trac-admin /path/to/myproject initenv
    12 [wiki:TracAdmin trac-admin] はあなたに、プロジェクトの名前、
    13 データベースに接続するための文字列 (以下に説明します) 、
    14 ソースコードリポジトリの種類とパスを尋ねてきます。
     15`trac-admin` will ask you for the name of the project and the database connection string, see below.
    16 ''Note: Environment のディレクトリ配下は、 Web サーバの実行ユーザに書き込みパーミッションを
    17 与える必要があります。適切なパーミッションの付与を忘れないようにしてください。
    18 書き込みパーミッションの付与は、 Trac が最終的に使用している Subversion のリポジトリにも当てはまります。
    19 ただし、あなたが Subversion リポジトリに Barkley DB のファイルシステムを使用していないならば、
    20 Trac は読み取りパーミッションしか必要としません。''
     17=== Useful Tips
    22 == データベースに接続するための文字列 ==
     19 - 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.
    24 バージョン 0.9 以降の Trac では [ SQLite],
    25 [ PostgreSQL] と [ MySQL] をバックエンドのデータベースとして
    26 利用可能になりました。通常では SQLite を使用します。たぶんほとんどのプロジェクトにとっては SQLite で十分です。
    27 データベースファイルは Environment のディレクトリに保存されます。そして、
    28 [wiki:TracBackup Trac のバックアップ] で Environment の残りの部分 (データベースファイル以外のファイル)
    29 と一緒にバックアップすることができます。
     21 - 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.
     23 - `initenv`, when using an svn repository, does not imply that trac-admin will perform `svnadmin create` for the specified repository path. You need to perform the `svnadmin create` prior to `trac-admin initenv` if you're creating a new svn repository altogether with a new Trac environment; otherwise you will see a message "Warning: couldn't index the repository" when initializing the environment.
    31 組み込みの SQLite データベースに接続するための文字列は以下の通りです:
     25 - Non-ascii environment paths are not supported.
     27 - Also, it seems that project names with spaces can be problematic for authentication, see [trac:#7163].
     29 - TracPlugins located in a [TracIni#inherit-section shared plugins folder] that is defined in an [TracIni#GlobalConfiguration inherited configuration] are currently not loaded during creation, and hence, if they need to create extra tables for example, you'll need to [TracUpgrade#UpgradetheTracEnvironment upgrade the environment] before being able to use it.
     31== Database Connection Strings
     33Trac supports [ SQLite], [ PostgreSQL] and [ MySQL] database backends. The default is SQLite, which is probably sufficient for most projects. The database file is then stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment.
     35Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     37=== SQLite Connection String
     39The connection string for an SQLite database is:
     43where `db/trac.db` is the path to the database file within the Trac environment.
    36 もしあなたが、 PostgreSQL や MySQL を代わりに使用する場合、
    37 異なる接続用文字列を使用しなければなりません。 例えば、 PostgreSQL に接続するとき、
    38 ユーザ名 `johndoe` でパスワード `letmein` で
    39 ローカルホストの `trac` と呼ばれるデータベースに接続するには以下のように指定します:
     45=== PostgreSQL Connection String
     47If you want to use PostgreSQL instead, you'll have to use a different connection string. For example, to connect to a PostgreSQL database on the same machine called `trac` for user `johndoe` with the password `letmein` use:
    44 もし、 PostgreSQL がデフォルト以外のポート番号 (例えば、 9432) で起動しているときはこのようにします:
     52If PostgreSQL is running on a non-standard port, for example 9342, use:
    49 PostgreSQL を使用するとき、 `trac-admin initenv` を実行する前に
    50 データベースを作成しなければいけません。
    52 PostgreSQL データベースの名前は "trac" にしてください。そのほうが都合がいいです:
    53 また、 trac-user-name に大文字を使用すると動きません。
     57On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
    55 sudo su - postgres -c createdb trac
    56 sudo su - postgres -c psql trac
    57 CREATE USER trac-user-name WITH PASSWORD 'trac-pass-name';
    60 (sudo/su を設定していなければ、手動で createdb と psql を実行する必要があることに留意してください。このドキュメントを読んで最初そのことを理解するまで少し時間がかかりました。 (訳注: この一文は本家サイトの Wiki に寄せられた感想のようです))
     62or a specific one:
    62 == ソースコードリポジトリ ==
     67Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    64 最初にリポジトリの ''type'' を指定しなければなりません。 (例 Subversion ならば `svn` 、
    65 これがデフォルトです)、そしてリポジトリの ''path'' を指定しなければなりません。
     69See the [ PostgreSQL documentation] for detailed instructions on how to administer [ PostgreSQL].
     70Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
     72$ createuser -U postgres -E -P tracuser
     73$ createdb -U postgres -O tracuser -E UTF8 trac
    67 リポジトリなしで、 Trac を使用したいときは、単に ''path'' 部分に何も入力しないままにして下さい。
    68 (その場合''type'' の情報は影響しません)
     76When running `createuser` you will be prompted for the password for the user '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. SQL_ASCII also seems to work.
    70 リポジトリシステムによっては、リポジトリへのパスだけではなく、リポジトリ内の ''scope'' を設定
    71 することもできます。 Trac はそのスコープ以下に限定したファイルとチェンジセット
    72 に関連する情報を表示します。 Trac のバックエンドで  Subversion を 使う場合
    73 このようなことが可能です; 他のリポジトリシステムについては、対応するプラグインのドキュメントで確認して下さい。
     78Under some default configurations (Debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user:
     80$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     81$ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
    75 Subversion リポジトリの設定の一例です:
     84Trac uses the `public` schema by default, but you can specify a different schema in the connection string:
     89=== MySQL Connection String
     91The format of the MySQL connection string is similar to those for PostgreSQL, with the `postgres` scheme being replaced by `mysql`. For example, to connect to a MySQL database on the same machine called `trac` for user `johndoe` with password `letmein`:
     96== Source Code Repository
     98Since Trac 0.12, a single environment can be connected to more than one repository. There are many different ways to connect repositories to an environment, see TracRepositoryAdmin. This page also details the various attributes that can be set for a repository, such as `type`, `url`, `description`.
     100In Trac 0.12 `trac-admin` no longer asks questions related to repositories. Therefore, by default Trac is not connected to any source code repository, and the ''Browse Source'' toolbar item will not be displayed.
     101You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded:
     104trac.versioncontrol.* = disabled
     107For some version control systems, it is possible to specify not only the path to the repository, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The Subversion backend for Trac supports this. For other types, check the corresponding plugin's documentation.
     109Example of a configuration for a Subversion repository used as the default repository:
    78112repository_type = svn
    82 スコープを絞った Subversion リポジトリの設定の一例です:
    83 {{{
     116The configuration for a scoped Subversion repository would be:
    85119repository_type = svn
    89 == ディレクトリ構造 ==
     123== Directory Structure
    91 一つのプロジェクトの Environment のディレクトリは通常以下に示すファイルとディレクトリから成り立ちます。
     125An environment directory will usually consist of the following files and directories:
    93  * `README` - Environment について記述したドキュメント。
    94  * `VERSION` - Environment のバージョン識別情報。
    95  * `attachments` - 全ての添付ファイルはここに保存されます。
     127 * `README` - Brief description of the environment.
     128 * `VERSION` - Environment version identifier.
     129 * `files`
     130  * `attachments` - Attachments to wiki pages and tickets.
    96131 * `conf`
    97    * `trac.ini` - メインとなる設定ファイル。詳細は TracIni に記述しています。
     132  * `trac.ini` - Main configuration file. See TracIni.
    98133 * `db`
    99    * `trac.db` - SQLite データベース (SQLite を使用しているならば)
    100  * `plugins` - Environment に固有の [wiki:TracPlugins プラグイン] (Python eggs)
    101  * `templates` - カスタム (プロジェクトに固有の) テンプレート
    102    * `site_css.cs` - カスタム CSS スタイルシート
    103    * `site_footer.cs` - カスタムフッタ
    104    * `site_header.cs` - カスタムヘッダ
    105  * `wiki-macros` - Environment に固有の [wiki:WikiMacros Wiki マクロ]
     134  * `trac.db` - The SQLite database, if you are using SQLite.
     135 * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs.
     136 * `log` - Default directory for log files, if `file` logging is enabled and a relative path is given.
     137 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
     138 * `templates` - Custom Genshi environment-specific templates.
     139  * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
    107   '''Note: Trac Environment のディレクトリとソースコードリポジトリのディレクトリを一緒にしないで下さい。
    108 上記のディレクトリ構造は Subversion リポジトリのディレクトリ構造をざっくりと真似ているだけですが、
    109 2つは同じ場所においては ''いけません'' 。'''
     141=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
     143This is a common beginners' mistake.
     144It happens that the structure for a Trac environment is loosely modelled 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.