Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
02/07/11 15:18:47 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v1 v2  
    55== Creating an Environment == 
    66 
    7 A new Trac environment is created using  [wiki:TracAdmin trac-admin]: 
     7A new Trac environment is created using  [TracAdmin#initenv trac-admin's initenv]: 
    88{{{ 
    99$ trac-admin /path/to/myproject initenv 
    1010}}} 
    1111 
    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 
     13database connection string (explained below). 
    1514 
    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. 
    2222 
    23 ''Note: "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.'' 
     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. 
    2428 
    2529== Database Connection Strings == 
    … …  
    3236[wiki:TracBackup backed up] together with the rest of the environment. 
    3337 
    34 === Embedded SQLite Connection String === 
    35 The connection string for an embedded SQLite database is: 
     38=== SQLite Connection String === 
     39The connection string for an SQLite database is: 
    3640{{{ 
    3741sqlite:db/trac.db 
    3842}}} 
     43where `db/trac.db` is the path to the database file within the Trac environment. 
    3944 
    4045=== PostgreSQL Connection String === 
    … …  
    97102== Source Code Repository == 
    98103 
    99 You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion, 
    100 which is the default), then the ''path'' where the repository is located. 
     104Since 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`). 
    101105 
    102 If you don't want to use Trac with a source code repository, simply leave the ''path'' empty 
    103 (the ''type'' information doesn't matter, then). 
     106In 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. 
     107You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded) 
     108{{{ 
     109[components] 
     110trac.versioncontrol.* = disabled 
     111}}} 
    104112 
    105 For some systems, it is possible to specify not only the path to the repository, 
     113For some version control systems, it is possible to specify not only the path to the repository, 
    106114but also a ''scope'' within the repository. Trac will then only show information 
    107115related to the files and changesets below that scope. The Subversion backend for 
    108116Trac supports this; for other types, check the corresponding plugin's documentation. 
    109117 
    110 Example of a configuration for a Subversion repository: 
     118Example of a configuration for a Subversion repository used as the default repository: 
    111119{{{ 
    112120[trac] 
    … …  
    133141 * `db` 
    134142   * `trac.db` - The SQLite database (if you're using SQLite). 
    135  * `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)'' 
    136144 * `log` - default directory for log files, if logging is turned on and a relative path is given. 
    137  * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [trac:milestone:0.10 0.10]) 
    138  * `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)'' 
    139147   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance 
    140  * ''`templates` - Custom [trac:ClearSilver ClearSilver] environment-specific templates. '''(0.10 only)''' '' 
    141    * ''`site_css.cs` - Custom CSS rules.'' 
    142    * ''`site_footer.cs` - Custom page footer.'' 
    143    * ''`site_header.cs` - Custom page header.'' 
    144  * ''`wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''(0.10 only)''' '' 
    145148 
    146   '''Note: don't confuse a Trac environment directory with the source code repository directory. 
    147 It happens that the above structure is loosely modelled after the Subversion repository directory  
    148 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 
     151This is a common beginners' mistake. 
     152It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory  
     153structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place. 
    149154 
    150155----