Changes between Version 2 and Version 3 of TracEnvironment


Ignore:
Timestamp:
Feb 5, 2015, 2:57:06 PM (4 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v2 v3  
    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  [TracAdmin#initenv trac-admin's initenv]:
    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 `trac-admin` will ask you for the name of the project and the
    13 database connection string (explained below).
     14`trac-admin` will ask you for the name of the project and the database connection string, see below.
    1415
    15 === Some Useful Tips
     16=== Useful Tips
    1617
    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 - 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.
    1819
    1920 - The user under which the web server runs will require file system write permission to
     
    2425 - `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.
    2526
    26  - Non-ascii environment paths are not supported
     27 - Non-ascii environment paths are not supported.
    2728 
    28  - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]).
     29 - Also, it seems that project names with spaces can be problematic for authentication, see [trac:#7163].
    2930
    3031 - 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.
    3132
    32 == Database Connection Strings ==
     33== Database Connection Strings
    3334
    34 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
    35 [http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
    36 support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
    37 to use SQLite, which is probably sufficient for most projects. The database
    38 file is then stored in the environment directory, and can easily be
    39 [wiki:TracBackup backed up] together with the rest of the environment.
     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.
    4036
    4137Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
    4238
    43 === SQLite Connection String ===
     39=== SQLite Connection String
    4440The connection string for an SQLite database is:
    4541{{{
     
    4844where `db/trac.db` is the path to the database file within the Trac environment.
    4945
    50 === PostgreSQL Connection String ===
    51 If you want to use PostgreSQL or MySQL instead, you'll have to use a
    52 different connection string. For example, to connect to a PostgreSQL
    53 database on the same machine called `trac`, that allows access to the
    54 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:
    5548{{{
    5649postgres://johndoe:letmein@localhost/trac
    5750}}}
    5851
    59 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:
    6053{{{
    6154postgres://johndoe:letmein@localhost:9342/trac
    6255}}}
    6356
    64 On UNIX, you might want to select a UNIX socket for the transport,
    65 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:
    6658{{{
    6759postgres://user:password@/database
     
    7264}}}
    7365
    74 Note that with PostgreSQL you will have to create the database before running
    75 `trac-admin initenv`.
     66Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    7667
    7768See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
    78 Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
    79 {{{
    80 createuser -U postgres -E -P tracuser
    81 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
    8273}}}
    8374When 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.
    8475
    8576Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
    86 {{{
    87 sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
    88 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'
    8980}}}
    9081
    91 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:
    9283{{{
    9384postgres://user:pass@server/database?schema=yourschemaname
    9485}}}
    9586
    96 === MySQL Connection String ===
     87=== MySQL Connection String
    9788
    98 The 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
    99 database on the same machine called `trac`, allowing access to the
    100 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:
    10190{{{
    10291mysql://johndoe:letmein@localhost:3306/trac
    10392}}}
    10493
    105 == Source Code Repository ==
     94== Source Code Repository
    10695
    107 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`).
     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`.
    10897
    10998In 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.
    110 You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)
    111 {{{
     99You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded.
     100{{{#!ini
    112101[components]
    113102trac.versioncontrol.* = disabled
    114103}}}
    115104
    116 For some version control systems, it is possible to specify not only the path to the repository,
    117 but also a ''scope'' within the repository. Trac will then only show information
    118 related to the files and changesets below that scope. The Subversion backend for
    119 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.
    120106
    121107Example of a configuration for a Subversion repository used as the default repository:
    122 {{{
     108{{{#!ini
    123109[trac]
    124110repository_type = svn
     
    127113
    128114The configuration for a scoped Subversion repository would be:
    129 {{{
     115{{{#!ini
    130116[trac]
    131117repository_type = svn
     
    133119}}}
    134120
    135 == Directory Structure ==
     121== Directory Structure
    136122
    137123An environment directory will usually consist of the following files and directories:
    138124
    139125 * `README` - Brief description of the environment.
    140  * `VERSION` - Contains the environment version identifier.
     126 * `VERSION` - Environment version identifier.
    141127 * `attachments` - Attachments to wiki pages and tickets are stored here.
    142128 * `conf`
    143    * `trac.ini` - Main configuration file. See TracIni.
     129  * `trac.ini` - Main configuration file. See TracIni.
    144130 * `db`
    145    * `trac.db` - The SQLite database (if you're using SQLite).
    146  * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)''
    147  * `log` - default directory for log files, if logging is turned on and a relative path is given.
    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)''
    150    * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
     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.
    151137
    152138=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat