![(please configure the [header_logo] section in trac.ini)](/trac/original/ideanote/chrome/site/your_project_logo.png){kind=logo}
Changes between Version 2 and Version 3 of TracEnvironment
- Timestamp:
- Sep 19, 2015, 4:39:59 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracEnvironment
v2 v3 1 = T rac Environment = #TracEnvironment1 = The Trac Environment = 2 2 3 Trac はプロジェクトのデータを保存するために、ディレクトリ構造とデータベースを使用します。このディレクトリを "Environment" と呼びます。3 Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”. 4 4 5 == Environment の作成 == #CreatinganEnvironment5 == Creating an Environment == 6 6 7 新しい Trac Environment を作成するには、 [TracAdmin#initenv trac-admin の initenv] を使用します:7 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]: 8 8 {{{ 9 9 $ trac-admin /path/to/myproject initenv 10 10 }}} 11 11 12 `trac-admin` はプロジェクトの名前とデータベースに接続するための文字列13 (後で説明します) を尋ねてきます。 12 `trac-admin` will ask you for the name of the project and the 13 database connection string (explained below). 14 14 15 === Tips === #SomeUsefulTips16 - Environment のディレクトリ配下は、 Web サーバの実行ユーザが書き込み可能でなければなりません。17 適切なパーミッションの付与を忘れないようにしてください。18 同じことがソースコードリポジトリにも当てはまりますが、19 Subversion リポジトリの場合は、ファイルシステムに Barkley DB を使用していない場合は、 Trac は読み取りパーミッションしか必要としません; Subversion以外のリポジトリについては、各々のプラグインを確認してください。15 === Some Useful Tips 16 - The user under which the web server runs will require file system write permission to 17 the environment directory and all the files inside. Please remember to set 18 the appropriate permissions. The same applies to the source code repository, 19 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. 20 20 21 - `initenv` で Subversion リポジトリを使用するように指定されても、 trac-admin コマンドは指定されたリポジトリのパスに対して `svnadmin create` を実行したりしません。新しい Trac enviroment を作るときに、 Subversion リポジトリも新規で作る場合は、 `svnadmin create` は `trac-admin initenv` よりも前に実行しておいてください。 Environment の初期化中にリポジトリが見つからない場合、 "Warning: couldn't index the repository" というメッセージが表示されてしまいます。21 - `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. 22 22 23 - 非 ASCII 文字を含むパスはサポートされていません。23 - Non-ascii environment paths are not supported 24 24 25 - プロジェクト名に空白文字が混じっていると認証で問題が生じることがありますので注意してください (See [http://trac.edgewall.org/ticket/7163 #7163])。25 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]). 26 26 27 - [TracIni#GlobalConfiguration グローバル設定ファイル] に定義した [TracIni#inherit-section 共有するプラグインのディレクトリ] に配置した TracPlugins は Environment の作成時はロードされないようになりました。そのため、データベースのテーブルなどを追加で作成する必要がある場合は [TracUpgrade#UpgradetheTracEnvironment Environment をアップグレード] せねばなりません。27 - 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. 28 28 29 == データベースに接続するための文字列 == #DatabaseConnectionStrings29 == Database Connection Strings == 30 30 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 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and 32 [http://www.postgresql.org/ PostgreSQL] database backends. Preliminary 33 support for [http://mysql.com/ MySQL] was added in 0.10. The default is 34 to use SQLite, which is probably sufficient for most projects. The database 35 file is then stored in the environment directory, and can easily be 36 [wiki:TracBackup backed up] together with the rest of the environment. 37 37 38 === SQLite の接続文字列 === #SQLiteConnectionString39 SQLite データベースに接続するための文字列は以下の通りです:38 === SQLite Connection String === 39 The connection string for an SQLite database is: 40 40 {{{ 41 41 sqlite:db/trac.db 42 42 }}} 43 `db/trac.db` の箇所は Trac Environment のデータベースファイルへのパスを指します。 43 where `db/trac.db` is the path to the database file within the Trac environment. 44 44 45 === PostgreSQL の接続文字列 === #PostgreSQLConnectionString46 PostgreSQL や MySQL を代わりに使用する場合、異なる接続用文字列を 47 使用しなければなりません。 例えば PostgreSQL に接続するとき、 48 ユーザ名 `johndoe` でパスワード `letmein` で 49 同じマシンの `trac` と呼ばれるデータベースに接続するには以下のように指定します:45 === PostgreSQL Connection String === 46 If you want to use PostgreSQL or MySQL instead, you'll have to use a 47 different connection string. For example, to connect to a PostgreSQL 48 database on the same machine called `trac`, that allows access to the 49 user `johndoe` with the password `letmein`, use: 50 50 {{{ 51 51 postgres://johndoe:letmein@localhost/trac 52 52 }}} 53 '' "/" 及び "@" はパスワードの一部として使用出来ないので注意してください''53 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.'' 54 54 55 PostgreSQL がデフォルト以外のポート番号 (例えば、 9432) で起動しているときはこのようにします:55 If PostgreSQL is running on a non-standard port (for example 9342), use: 56 56 {{{ 57 57 postgres://johndoe:letmein@localhost:9342/trac 58 58 }}} 59 59 60 UNIX ホストでは、 UNIX ソケットで接続するように設定できます。 61 この場合、環境変数 PGHOST に定義されたデフォルトソケットを使用します:60 On UNIX, you might want to select a UNIX socket for the transport, 61 either the default socket as defined by the PGHOST environment variable: 62 62 {{{ 63 63 postgres://user:password@/database 64 64 }}} 65 ソケットを特定する場合はこうです:65 or a specific one: 66 66 {{{ 67 67 postgres://user:password@/database?host=/path/to/socket/dir 68 68 }}} 69 69 70 PostgreSQL を使用するとき、 `trac-admin initenv` を実行する前に 71 データベースを作成しなければいけません。 70 Note that with PostgreSQL you will have to create the database before running 71 `trac-admin initenv`. 72 72 73 [http://postgresql.org PostgreSQL] の詳細設定の方法については [http://www.postgresql.org/docs/ PostgreSQL ドキュメント] を参照してください。 74 下記は `tracuser` という名のデータベースユーザ及び `trac` という名のデータベースを作成します。 73 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL]. 74 Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`. 75 75 {{{ 76 76 createuser -U postgres -E -P tracuser 77 77 createdb -U postgres -O tracuser -E UTF8 trac 78 78 }}} 79 `createuser` を実行する時、'tracuser' のパスワードの入力を促されます。この新しいユーザはスーパーユーザではないので、他のデータベースを作ったり、他の role (訳注: PostgreSQL でのユーザ) を作る権限を与えられていません。これらの権限は trac のインスタンスを実行する為には必要ではありません。ユーザにパスワードを付与したくない場合、 `createuser` コマンドから `-P` と `-E` オプションを取り除いてください。また、データベースが UTF8 で作成する必要があることに注意してください。 LATIN1 のエンコードが原因のエラーを引き起こします。 SQL_ASCII でも同様です。 79 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. 80 80 81 デフォルト設定 (debian) の下では、 `postgres` ユーザとして `createuser` と `createdb` スクリプトを実行してください。 例えば:81 Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user. For example: 82 82 {{{ 83 83 sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' … … 85 85 }}} 86 86 87 Trac はデフォルトで `public` スキーマを使用しますが、明示的に違うスキーマを指定することができます:87 Trac uses the `public` schema by default but you can specify a different schema in the connection string: 88 88 {{{ 89 89 postgres://user:pass@server/database?schema=yourschemaname 90 90 }}} 91 91 92 === MySQL の接続文字列 === #MySQLConnectionString92 === MySQL Connection String === 93 93 94 MySQL を代わりに使用したい場合、違う接続文字列を使用します。 95 例えば、同じマシンにある `trac` という MySQL データベースに、 96 `johndoe` というユーザでパスワード `letmein` で接続する場合の 97 MySQL の接続文字列は次の通りです:94 If you want to use MySQL instead, you'll have to use a 95 different connection string. For example, to connect to a MySQL 96 database on the same machine called `trac`, that allows access to the 97 user `johndoe` with the password `letmein`, the mysql connection string is: 98 98 {{{ 99 99 mysql://johndoe:letmein@localhost:3306/trac 100 100 }}} 101 101 102 == ソースコードリポジトリ == #SourceCodeRepository102 == Source Code Repository == 103 103 104 0.12 以降のバージョンでは、一つの Environment から複数のリポジトリに接続できるようになりました。 Environment からリポジトリに接続する方法は沢山あるので、詳細は TracRepositoryAdmin を参照してください。左記のページではリポジトリごとに設定する項目 (`type`, `url`, `description` など) について詳しく解説されています。 104 Since version 0.12, a single Trac 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 (like `type`, `url`, `description`). 105 105 106 Trac 0.12 の `trac-admin` コマンドでは、接続するリポジトリの指定が必須ではなくなりました。デフォルトでは Trac はソースコードリポジトリへの接続を作成せず、メインナビゲーションの ''リポジトリブラウザ'' (英語版では ''Browse Source'') も表示されなくなります。 107 ロードされている `trac.versioncontrol.*` コンポーネントを完全に無効化するには下記設定を行ってください 106 In 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. 107 You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded) 108 108 {{{ 109 109 [components] … … 111 111 }}} 112 112 113 バージョン管理システムによっては、リポジトリへのパスだけではなく、リポジトリ内の ''scope'' を設定することもできます。 114 Trac はそのスコープ以下に限定したファイルとチェンジセットに関連する情報を表示します。 115 Trac のバックエンドに Subversion を 使う場合は、この機能を利用できます; 116 他のリポジトリシステムについては、対応するプラグインのドキュメントで確認して下さい。 113 For some version control systems, it is possible to specify not only the path to the repository, 114 but also a ''scope'' within the repository. Trac will then only show information 115 related to the files and changesets below that scope. The Subversion backend for 116 Trac supports this; for other types, check the corresponding plugin's documentation. 117 117 118 デフォルトリポジトリのみで構成される Subversion リポジトリの設定の一例です:118 Example of a configuration for a Subversion repository used as the default repository: 119 119 {{{ 120 120 [trac] … … 123 123 }}} 124 124 125 スコープを絞った Subversion リポジトリの設定の一例です:125 The configuration for a scoped Subversion repository would be: 126 126 {{{ 127 127 [trac] … … 130 130 }}} 131 131 132 == ディレクトリ構造 == #DirectoryStructure132 == Directory Structure == 133 133 134 プロジェクト Environment のディレクトリは通常、以下に示すファイルとディレクトリから成り立ちます。 134 An environment directory will usually consist of the following files and directories: 135 135 136 * `README` - Environment について記述したドキュメント。137 * `VERSION` - Environment のバージョン識別情報。138 * `attachments` - 全ての添付ファイルはここに保存されます。136 * `README` - Brief description of the environment. 137 * `VERSION` - Contains the environment version identifier. 138 * `attachments` - Attachments to wiki pages and tickets are stored here. 139 139 * `conf` 140 * `trac.ini` - メインとなる設定ファイル。詳細は TracIni に記述しています。140 * `trac.ini` - Main configuration file. See TracIni. 141 141 * `db` 142 * `trac.db` - SQLite データベース (SQLite を使用している場合)143 * `htdocs` - Web のリソースを格納するディレクトリ。 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 に記載142 * `trac.db` - The SQLite database (if you're using SQLite). 143 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)'' 144 * `log` - default directory for log files, if logging is turned on and a relative path is given. 145 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10]) 146 * `templates` - Custom Genshi environment-specific templates. ''(since 0.11)'' 147 * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance 148 148 149 '''要注意:''' ''Trac Environment のディレクトリとソースコードリポジトリのディレクトリを一緒にしないで下さい。'' 149 === Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat 150 150 151 初心者がよくやる誤りです。 152 上記のディレクトリ構造は Subversion リポジトリのディレクトリ構造をざっくりと真似ているだけです。 153 全く関連はありませんので、2つは同じ場所においては ''いけません''。 151 This is a common beginners' mistake. 152 It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory 153 structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place. 154 154 155 155 ---- 156 156 See also: TracAdmin, TracBackup, TracIni, TracGuide 157
