Changes between Version 2 and Version 3 of TracEnvironment
- Timestamp:
- 02/28/11 14:16:41 (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracEnvironment
v2 v3 5 5 == Creating an Environment == 6 6 7 A new Trac environment is created using [ wiki:TracAdmin trac-admin]: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 [wiki:TracAdmin trac-admin] will ask you for the name of the project, the 13 database connection string (explained below), and the type and path to 14 your source code repository. 12 `trac-admin` will ask you for the name of the project and the 13 database connection string (explained below). 15 14 16 ''Note: The web server user 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 Subversion repository 19 Trac is eventually using, although Trac will only require read access as long 20 as you're not using the BDB file system. Also, it seems that project names 21 with spaces can be problematic for authentication (see [trac:#7163]).'' 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 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 23 - Non-ascii environment paths are not supported 24 25 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]). 26 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. 22 28 23 29 == Database Connection Strings == … … 30 36 [wiki:TracBackup backed up] together with the rest of the environment. 31 37 32 === EmbeddedSQLite Connection String ===33 The connection string for an embeddedSQLite database is:38 === SQLite Connection String === 39 The connection string for an SQLite database is: 34 40 {{{ 35 41 sqlite:db/trac.db 36 42 }}} 43 where `db/trac.db` is the path to the database file within the Trac environment. 37 44 38 45 === PostgreSQL Connection String === … … 95 102 == Source Code Repository == 96 103 97 You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion, 98 which is the default), then the ''path'' where the repository is located. 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`). 99 105 100 If you don't want to use Trac with a source code repository, simply leave the ''path'' empty 101 (the ''type'' information doesn't matter, then). 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 {{{ 109 [components] 110 trac.versioncontrol.* = disabled 111 }}} 102 112 103 For some systems, it is possible to specify not only the path to the repository,113 For some version control systems, it is possible to specify not only the path to the repository, 104 114 but also a ''scope'' within the repository. Trac will then only show information 105 115 related to the files and changesets below that scope. The Subversion backend for 106 116 Trac supports this; for other types, check the corresponding plugin's documentation. 107 117 108 Example of a configuration for a Subversion repository :118 Example of a configuration for a Subversion repository used as the default repository: 109 119 {{{ 110 120 [trac] … … 131 141 * `db` 132 142 * `trac.db` - The SQLite database (if you're using SQLite). 133 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates . '''''(0.11 only)'''''143 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)'' 134 144 * `log` - default directory for log files, if logging is turned on and a relative path is given. 135 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [trac:milestone:0.10 0.10]) 136 * `templates` - Custom [trac:ClearSilver ClearSilver] environment-specific templates. '''''(0.10 only)''''' 137 * `site_css.cs` - Custom CSS rules. 138 * `site_footer.cs` - Custom page footer. 139 * `site_header.cs` - Custom page header. 140 * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)''''' 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)'' 141 147 * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance 142 * `wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''''(0.10 only)'''''143 148 144 '''Note: don't confuse a Trac environment directory with the source code repository directory. 145 It happens that the above structure is loosely modelled after the Subversion repository directory 146 structure, but they are not and ''must not'' be located at the same place.''' 149 '''Caveat:''' ''don't confuse a Trac environment directory with the source code repository directory.'' 150 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. 147 154 148 155 ----