Changes between Version 3 and Version 4 of TracEnvironment
- Timestamp:
- Apr 4, 2012, 2:28:20 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracEnvironment
v3 v4 5 5 == Creating an Environment == 6 6 7 A new Trac environment is created using [ TracAdmin#initenv trac-admin's initenv]:7 A new Trac environment is created using [wiki:TracAdmin trac-admin]: 8 8 {{{ 9 9 $ trac-admin /path/to/myproject initenv 10 10 }}} 11 11 12 `trac-admin` will ask you for the name of the project and the 13 database connection string (explained below). 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. 14 15 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 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. 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]).'' 28 22 29 23 == Database Connection Strings == … … 36 30 [wiki:TracBackup backed up] together with the rest of the environment. 37 31 38 === SQLite Connection String ===39 The connection string for an SQLite database is:32 === Embedded SQLite Connection String === 33 The connection string for an embedded SQLite database is: 40 34 {{{ 41 35 sqlite:db/trac.db 42 36 }}} 43 where `db/trac.db` is the path to the database file within the Trac environment.44 37 45 38 === PostgreSQL Connection String === … … 102 95 == Source Code Repository == 103 96 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`). 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. 105 99 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 }}} 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). 112 102 113 For some version controlsystems, it is possible to specify not only the path to the repository,103 For some systems, it is possible to specify not only the path to the repository, 114 104 but also a ''scope'' within the repository. Trac will then only show information 115 105 related to the files and changesets below that scope. The Subversion backend for 116 106 Trac supports this; for other types, check the corresponding plugin's documentation. 117 107 118 Example of a configuration for a Subversion repository used as the default repository:108 Example of a configuration for a Subversion repository: 119 109 {{{ 120 110 [trac] … … 141 131 * `db` 142 132 * `trac.db` - The SQLite database (if you're using SQLite). 143 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''( since 0.11)'''''133 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(0.11 only)''''' 144 134 * `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)'''''135 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [trac:milestone:0.10 0.10]) 136 * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)''''' 147 137 * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance 138 * ''`templates` - Custom [trac:ClearSilver ClearSilver] environment-specific templates. '''(0.10 only)''' '' 139 * ''`site_css.cs` - Custom CSS rules.'' 140 * ''`site_footer.cs` - Custom page footer.'' 141 * ''`site_header.cs` - Custom page header.'' 142 * ''`wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''(0.10 only)''' '' 148 143 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. 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.''' 154 147 155 148 ---- 156 149 See also: TracAdmin, TracBackup, TracIni, TracGuide 157 150 158