Changes between Version 5 and Version 6 of TracEnvironment

Timestamp:

Jan 28, 2010, 4:25:36 AM (14 years ago)

Author:

trac

Comment:

--

TracEnvironment

@@ -1 @@
-= Trac Environment =
+= The Trac Environment =
 
-Trac はプロジェクトのデータを保存するために、ディレクトリ構造とデータベースを使用します。このディレクトリを "Environment" と呼びます。
+Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
 
-== Environment の作成 ==
+== Creating an Environment ==
 
-新しい Trac Environment を作成するには、 [wiki:TracAdmin trac-admin] コマンドを使用します:
+A new Trac environment is created using  [wiki:TracAdmin trac-admin]:
 {{{
-$ trac-admin /path/to/projectenv initenv
+$ trac-admin /path/to/myproject initenv
 }}}
 
-[wiki:TracAdmin trac-admin] はあなたに、プロジェクトの名前、
-データベースに接続するための文字列 (以下に説明します) 、
-ソースコードリポジトリの種類とパスを尋ねてきます。
+[wiki:TracAdmin trac-admin] will ask you for the name of the project, the
+database connection string (explained below), and the type and path to
+your source code repository.
 
-''Note: Environment のディレクトリ配下は、 Web サーバの実行ユーザに書き込みパーミッションを
-与える必要があります。適切なパーミッションの付与を忘れないようにしてください。
-書き込みパーミッションの付与は、 Trac が最終的に使用している Subversion のリポジトリにも当てはまります。
-ただし、あなたが Subversion リポジトリに Barkley DB のファイルシステムを使用していないならば、 
-Trac は読み取りパーミッションしか必要としません。''
+''Note: The web server user 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 Subversion repository 
+Trac is eventually using, although Trac will only require read access as long 
+as you're not using the BDB file system. Also, it seems that project names
+with spaces can be problematic for authentication (see [trac:#7163]).''
 
-== データベースに接続するための文字列 ==
+== Database Connection Strings ==
 
-バージョン 0.9 以降の Trac では [http://sqlite.org/ SQLite],
-[http://www.postgresql.org/ PostgreSQL] と [http://mysql.com/ MySQL] をバックエンドのデータベースとして
-利用可能になりました。通常では SQLite を使用します。たぶんほとんどのプロジェクトにとっては SQLite で十分です。
-データベースファイルは Environment のディレクトリに保存されます。そして、
-[wiki:TracBackup Trac のバックアップ] で Environment の残りの部分 (データベースファイル以外のファイル) 
-と一緒にバックアップすることができます。
+Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
+[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
+support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
+to use 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.
 
-組み込みの SQLite データベースに接続するための文字列は以下の通りです:
+=== Embedded SQLite Connection String ===
+The connection string for an embedded SQLite database is:
 {{{
 sqlite:db/trac.db
 }}}
 
-もしあなたが、 PostgreSQL や MySQL を代わりに使用する場合、
-異なる接続用文字列を使用しなければなりません。 例えば、 PostgreSQL に接続するとき、
-ユーザ名 `johndoe` でパスワード `letmein` で
-ローカルホストの `trac` と呼ばれるデータベースに接続するには以下のように指定します:
+=== PostgreSQL Connection String ===
+If you want to use PostgreSQL or MySQL instead, you'll have to use a
+different connection string. For example, to connect to a PostgreSQL
+database on the same machine called `trac`, that allows access to the
+user `johndoe` with the password `letmein`, use:
 {{{
 postgres://johndoe:letmein@localhost/trac
 }}}
+''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
 
-もし、 PostgreSQL がデフォルト以外のポート番号 (例えば、 9432) で起動しているときはこのようにします:
+If PostgreSQL is running on a non-standard port (for example 9342), use:
 {{{
 postgres://johndoe:letmein@localhost:9342/trac
 }}}
 
-PostgreSQL を使用するとき、 `trac-admin initenv` を実行する前に
-データベースを作成しなければいけません。
-
-PostgreSQL データベースの名前は "trac" にしてください。そのほうが都合がいいです:
-また、 trac-user-name に大文字を使用すると動きません。
+On UNIX, you might want to select a UNIX socket for the transport,
+either the default socket as defined by the PGHOST environment variable:
 {{{
-sudo su - postgres -c createdb trac
-sudo su - postgres -c psql trac
-CREATE USER trac-user-name WITH PASSWORD 'trac-pass-name';
+postgres://user:password@/database
+}}}
+or a specific one:
+{{{
+postgres://user:password@/database?host=/path/to/socket/dir
 }}}
 
-(sudo/su を設定していなければ、手動で createdb と psql を実行する必要があることに留意してください。このドキュメントを読んで最初そのことを理解するまで少し時間がかかりました。 (訳注: この一文は本家サイトの Wiki に寄せられた感想のようです))
+Note that with PostgreSQL you will have to create the database before running
+`trac-admin initenv`.
 
-== ソースコードリポジトリ ==
+See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
+Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
+{{{
+createuser -U postgres -E -P tracuser
+createdb -U postgres -O tracuser -E UTF8 trac
+}}}
+When 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 trac's use of unicode in trac.  SQL_ASCII also seems to work.
 
-最初にリポジトリの ''type'' を指定しなければなりません。 (例 Subversion ならば `svn` 、
-これがデフォルトです)、そしてリポジトリの ''path'' を指定しなければなりません。
+Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
+{{{
+sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
+sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
+}}}
 
-リポジトリなしで、 Trac を使用したいときは、単に ''path'' 部分に何も入力しないままにして下さい。 
-(その場合''type'' の情報は影響しません)
+Trac uses the `public` schema by default but you can specify a different schema in the connection string:
+{{{
+postgres://user:pass@server/database?schema=yourschemaname
+}}}
 
-リポジトリシステムによっては、リポジトリへのパスだけではなく、リポジトリ内の ''scope'' を設定
-することもできます。 Trac はそのスコープ以下に限定したファイルとチェンジセット
-に関連する情報を表示します。 Trac のバックエンドで  Subversion を 使う場合
-このようなことが可能です; 他のリポジトリシステムについては、対応するプラグインのドキュメントで確認して下さい。
+=== MySQL Connection String ===
 
-Subversion リポジトリの設定の一例です:
+If you want to use MySQL instead, you'll have to use a
+different connection string. For example, to connect to a MySQL
+database on the same machine called `trac`, that allows access to the
+user `johndoe` with the password `letmein`, the mysql connection string is:
+{{{
+mysql://johndoe:letmein@localhost:3306/trac
+}}}
+
+== Source Code Repository ==
+
+You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
+which is the default), then the ''path'' where the repository is located.
+
+If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
+(the ''type'' information doesn't matter, then).
+
+For some 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.
+
+Example of a configuration for a Subversion repository:
 {{{
 [trac]
@@ -80 +113 @@
 }}}
 
-スコープを絞った Subversion リポジトリの設定の一例です:
+The configuration for a scoped Subversion repository would be:
 {{{
 [trac]
@@ -87 +120 @@
 }}}
 
-== ディレクトリ構造 ==
+== Directory Structure ==
 
-一つのプロジェクトの Environment のディレクトリは通常以下に示すファイルとディレクトリから成り立ちます。
+An environment directory will usually consist of the following files and directories:
 
- * `README` - Environment について記述したドキュメント。
- * `VERSION` - Environment のバージョン識別情報。
- * `attachments` - 全ての添付ファイルはここに保存されます。
+ * `README` - Brief description of the environment.
+ * `VERSION` - Contains the environment version identifier.
+ * `attachments` - Attachments to wiki pages and tickets are stored here.
  * `conf`
-   * `trac.ini` - メインとなる設定ファイル。詳細は TracIni に記述しています。
+   * `trac.ini` - Main configuration file. See TracIni.
  * `db`
-   * `trac.db` - SQLite データベース (SQLite を使用しているならば)
- * `plugins` - Environment に固有の [wiki:TracPlugins プラグイン] (Python eggs)
- * `templates` - カスタム (プロジェクトに固有の) テンプレート
-   * `site_css.cs` - カスタム CSS スタイルシート
-   * `site_footer.cs` - カスタムフッタ
-   * `site_header.cs` - カスタムヘッダ
- * `wiki-macros` - Environment に固有の [wiki:WikiMacros Wiki マクロ]
+   * `trac.db` - The SQLite database (if you're using SQLite).
+ * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(0.11 only)'''''
+ * `log` - default directory for log files, if logging is turned on and a relative path is given.
+ * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10])
+ * `templates` - Custom ClearSilver environment-specific templates. '''''(0.10 only)'''''
+   * `site_css.cs` - Custom CSS rules.
+   * `site_footer.cs` - Custom page footer.
+   * `site_header.cs` - Custom page header.
+ * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)'''''
+   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
+ * `wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''''(0.10 only)'''''
 
-  '''Note: Trac Environment のディレクトリとソースコードリポジトリのディレクトリを一緒にしないで下さい。
-上記のディレクトリ構造は Subversion リポジトリのディレクトリ構造をざっくりと真似ているだけですが、
-2つは同じ場所においては ''いけません'' 。'''
+  '''Note: don't confuse a Trac environment directory with the source code repository directory.
+It happens that the above structure is loosely modelled after the Subversion repository directory 
+structure, but they are not and ''must not'' be located at the same place.'''
 
 ----