Changes between Version 4 and Version 5 of TracEnvironment


Ignore:
Timestamp:
May 5, 2015, 2:14:41 PM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v4 v5  
    1 = The Trac Environment =
     1= The Trac Environment
     2[[TracGuideToc]]
     3[[PageOutline]]
    24
    3 Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
     5Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
    46
    5 == Creating an Environment ==
     7== Creating an Environment
    68
    7 A new Trac environment is created using  [wiki:TracAdmin trac-admin]:
    8 {{{
     9A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     10{{{#!sh
    911$ trac-admin /path/to/myproject initenv
    1012}}}
    1113
    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`trac-admin` will ask you for the name of the project and the database connection string, see below.
    1515
    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]).''
     16=== Useful Tips
    2217
    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.''
     18 - 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.
    2419
    25 == Database Connection Strings ==
     20 - The user under which the web server runs will require file system write permission to
     21 the environment directory and all the files inside. Please remember to set
     22 the appropriate permissions. The same applies to the source code repository,
     23 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.
     24 
     25 - `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.
    2626
    27 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
    28 [http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
    29 support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
    30 to use SQLite, which is probably sufficient for most projects. The database
    31 file is then stored in the environment directory, and can easily be
    32 [wiki:TracBackup backed up] together with the rest of the environment.
     27 - Non-ascii environment paths are not supported.
     28 
     29 - Also, it seems that project names with spaces can be problematic for authentication, see [trac:#7163].
    3330
    34 === Embedded SQLite Connection String ===
    35 The connection string for an embedded SQLite database is:
     31 - 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.
     32
     33== Database Connection Strings
     34
     35Trac supports [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] database backends. The default is SQLite, which is probably sufficient for most projects. The database file is then stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment.
     36
     37Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     38
     39=== SQLite Connection String
     40The connection string for an SQLite database is:
    3641{{{
    3742sqlite:db/trac.db
    3843}}}
     44where `db/trac.db` is the path to the database file within the Trac environment.
    3945
    40 === PostgreSQL Connection String ===
    41 If you want to use PostgreSQL or MySQL instead, you'll have to use a
    42 different connection string. For example, to connect to a PostgreSQL
    43 database on the same machine called `trac`, that allows access to the
    44 user `johndoe` with the password `letmein`, use:
     46=== PostgreSQL Connection String
     47If you want to use PostgreSQL instead, you'll have to use a different connection string. For example, to connect to a PostgreSQL database on the same machine called `trac` for user `johndoe` with the password `letmein` use:
    4548{{{
    4649postgres://johndoe:letmein@localhost/trac
    4750}}}
    48 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    4951
    50 If PostgreSQL is running on a non-standard port (for example 9342), use:
     52If PostgreSQL is running on a non-standard port, for example 9342, use:
    5153{{{
    5254postgres://johndoe:letmein@localhost:9342/trac
    5355}}}
    5456
    55 On UNIX, you might want to select a UNIX socket for the transport,
    56 either the default socket as defined by the PGHOST environment variable:
     57On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
    5758{{{
    5859postgres://user:password@/database
    … …  
    6364}}}
    6465
    65 Note that with PostgreSQL you will have to create the database before running
    66 `trac-admin initenv`.
     66Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    6767
    6868See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
    69 Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
    70 {{{
    71 createuser -U postgres -E -P tracuser
    72 createdb -U postgres -O tracuser -E UTF8 trac
     69Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
     70{{{#!sh
     71$ createuser -U postgres -E -P tracuser
     72$ createdb -U postgres -O tracuser -E UTF8 trac
    7373}}}
    7474When running `createuser` you will be prompted for the password for the user 'tracuser'. This new user will not be a superuser, will not be allowed to create other databases and will not be allowed to create other roles. These privileges are not needed to run a trac instance. If no password is desired for the user, simply remove the `-P` and `-E` options from the `createuser` command.  Also note that the database should be created as UTF8. LATIN1 encoding causes errors trac's use of unicode in trac.  SQL_ASCII also seems to work.
    7575
    7676Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
    77 {{{
    78 sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
    79 sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     77{{{#!sh
     78$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     79$ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
    8080}}}
    8181
    82 Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     82Trac uses the `public` schema by default, but you can specify a different schema in the connection string:
    8383{{{
    8484postgres://user:pass@server/database?schema=yourschemaname
    8585}}}
    8686
    87 === MySQL Connection String ===
     87=== MySQL Connection String
    8888
    89 If you want to use MySQL instead, you'll have to use a
    90 different connection string. For example, to connect to a MySQL
    91 database on the same machine called `trac`, that allows access to the
    92 user `johndoe` with the password `letmein`, the mysql connection string is:
     89The format of the MySQL connection string is similar to those for PostgreSQL, with the `postgres` scheme being replaced by `mysql`. For example, to connect to a MySQL database on the same machine called `trac` for user `johndoe` with password `letmein`, the MySQL connection string is:
    9390{{{
    9491mysql://johndoe:letmein@localhost:3306/trac
    9592}}}
    9693
    97 == Source Code Repository ==
     94== Source Code Repository
    9895
    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.
     96Since Trac 0.12, a single 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, such as `type`, `url`, `description`.
    10197
    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).
     98In 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.
     99You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded.
     100{{{#!ini
     101[components]
     102trac.versioncontrol.* = disabled
     103}}}
    104104
    105 For some systems, it is possible to specify not only the path to the repository,
    106 but also a ''scope'' within the repository. Trac will then only show information
    107 related to the files and changesets below that scope. The Subversion backend for
    108 Trac supports this; for other types, check the corresponding plugin's documentation.
     105For some version control systems, it is possible to specify not only the path to the repository, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The Subversion backend for Trac supports this. For other types, check the corresponding plugin's documentation.
    109106
    110 Example of a configuration for a Subversion repository:
    111 {{{
     107Example of a configuration for a Subversion repository used as the default repository:
     108{{{#!ini
    112109[trac]
    113110repository_type = svn
    … …  
    116113
    117114The configuration for a scoped Subversion repository would be:
    118 {{{
     115{{{#!ini
    119116[trac]
    120117repository_type = svn
    … …  
    122119}}}
    123120
    124 == Directory Structure ==
     121== Directory Structure
    125122
    126123An environment directory will usually consist of the following files and directories:
    127124
    128125 * `README` - Brief description of the environment.
    129  * `VERSION` - Contains the environment version identifier.
     126 * `VERSION` - Environment version identifier.
    130127 * `attachments` - Attachments to wiki pages and tickets are stored here.
    131128 * `conf`
    132    * `trac.ini` - Main configuration file. See TracIni.
     129  * `trac.ini` - Main configuration file. See TracIni.
    133130 * `db`
    134    * `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)'''''
    136  * `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)'''''
    139    * `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)''' ''
     131  * `trac.db` - The SQLite database, if you are using SQLite.
     132 * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs.
     133 * `log` - Default directory for log files, if logging is turned on and a relative path is given.
     134 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
     135 * `templates` - Custom Genshi environment-specific templates.
     136  * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
    145137
    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.'''
     138=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
     139
     140This is a common beginners' mistake.
     141It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory
     142structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
    149143
    150144----