Changes between Version 5 and Version 6 of TracEnvironment


Ignore:
Timestamp:
Sep 10, 2014, 10:00:04 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v5 v6  
    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 and the
     12`trac-admin` will ask you for the name of the project and the
    1313database connection string (explained below).
    1414
    15 ''Note: The web server user will require file system write permission to
    16 the environment directory and all the files inside. Please remember to set
    17 the appropriate permissions. The same applies to the Subversion repository
    18 Trac is eventually using, although Trac will only require read access as long
    19 as you're not using the BDB file system. Also, it seems that project names
    20 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.
    2122
    22 ''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.
    2328
    2429== Database Connection Strings ==
     
    3136[wiki:TracBackup backed up] together with the rest of the environment.
    3237
    33 === Embedded SQLite Connection String ===
    34 The connection string for an embedded SQLite database is:
     38=== SQLite Connection String ===
     39The connection string for an SQLite database is:
    3540{{{
    3641sqlite:db/trac.db
    3742}}}
     43where `db/trac.db` is the path to the database file within the Trac environment.
    3844
    3945=== PostgreSQL Connection String ===
     
    96102== Source Code Repository ==
    97103
    98 Since version 0.12, one Trac environment can be tied to more than one repository. There are many different ways to add repositories to an environment, see TracRepositoryAdmin. This page also details the various attributes that can be set on a repository (like `type`, `url`, `description`).
     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`).
    99105
    100 If you don't want to use Trac with any source code repository, at creation time simply leave the ''path'' empty
    101 (the ''type'' information doesn't matter in this case). Then you also need to disable the `trac.versioncontrol.*` components:
     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)
    102108{{{
    103109[components]
     
    105111}}}
    106112
    107 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,
    108114but also a ''scope'' within the repository. Trac will then only show information
    109115related to the files and changesets below that scope. The Subversion backend for
     
    135141 * `db`
    136142   * `trac.db` - The SQLite database (if you're using SQLite).
    137  * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(since 0.11)'''''
     143 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)''
    138144 * `log` - default directory for log files, if logging is turned on and a relative path is given.
    139145 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10])
    140  * `templates` - Custom Genshi environment-specific templates. '''''(since 0.11)'''''
     146 * `templates` - Custom Genshi environment-specific templates. ''(since 0.11)''
    141147   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
    142148
    143 '''Caveat:''' ''don't confuse a Trac environment directory with the source code repository directory.''
     149=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
    144150
    145151This is a common beginners' mistake.
     
    149155----
    150156See also: TracAdmin, TracBackup, TracIni, TracGuide
    151