Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
Jun 23, 2015, 6:04:32 PM (9 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
     17 - Place your environment's directory on a filesystem which supports sub-second timestamps, as Trac monitors the timestamp of its configuration files and changes happening on a filesystem with too coarse-grained timestamp resolution may go undetected in Trac < 1.0.2 (this is also true for the location of authentication files when using TracStandalone).
     18
     19 - The user under which the web server runs will require file system write permission to
     20 the environment directory and all the files inside. Please remember to set
     21 the appropriate permissions. The same applies to the source code repository,
     22 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.
     23 
     24 - `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.
     25
     26 - Non-ascii environment paths are not supported
     27 
     28 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]).
     29
     30 - 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.
    2231
    2332== Database Connection Strings ==
    … …  
    3039[wiki:TracBackup backed up] together with the rest of the environment.
    3140
    32 === Embedded SQLite Connection String ===
    33 The connection string for an embedded SQLite database is:
     41Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     42
     43=== SQLite Connection String ===
     44The connection string for an SQLite database is:
    3445{{{
    3546sqlite:db/trac.db
    3647}}}
     48where `db/trac.db` is the path to the database file within the Trac environment.
    3749
    3850=== PostgreSQL Connection String ===
    … …  
    4456postgres://johndoe:letmein@localhost/trac
    4557}}}
    46 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    4758
    4859If PostgreSQL is running on a non-standard port (for example 9342), use:
    … …  
    8596=== MySQL Connection String ===
    8697
    87 If you want to use MySQL instead, you'll have to use a
    88 different connection string. For example, to connect to a MySQL
    89 database on the same machine called `trac`, that allows access to the
     98The format of the MySQL connection string is similar to the examples presented for PostgreSQL, with the `postgres` schema being replaced by `mysql`. For example, to connect to a MySQL
     99database on the same machine called `trac`, allowing access to the
    90100user `johndoe` with the password `letmein`, the mysql connection string is:
    91101{{{
    … …  
    95105== Source Code Repository ==
    96106
    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.
     107Since 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`).
    99108
    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).
     109In 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.
     110You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)
     111{{{
     112[components]
     113trac.versioncontrol.* = disabled
     114}}}
    102115
    103 For some systems, it is possible to specify not only the path to the repository,
     116For some version control systems, it is possible to specify not only the path to the repository,
    104117but also a ''scope'' within the repository. Trac will then only show information
    105118related to the files and changesets below that scope. The Subversion backend for
    106119Trac supports this; for other types, check the corresponding plugin's documentation.
    107120
    108 Example of a configuration for a Subversion repository:
     121Example of a configuration for a Subversion repository used as the default repository:
    109122{{{
    110123[trac]
    … …  
    131144 * `db`
    132145   * `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)'''''
     146 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)''
    134147 * `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 [milestone:0.10])
    136  * `templates` - Custom 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)'''''
     148 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10])
     149 * `templates` - Custom Genshi environment-specific templates. ''(since 0.11)''
    141150   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
    142  * `wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''''(0.10 only)'''''
    143151
    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.'''
     152=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
     153
     154This is a common beginners' mistake.
     155It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory
     156structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
    147157
    148158----