Changes between Version 3 and Version 4 of TracEnvironment


Ignore:
Timestamp:
Sep 25, 2015, 8:15:33 AM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v3 v4  
    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
     17
     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.
     19
    1620 - The user under which the web server runs will require file system write permission to
    1721 the environment directory and all the files inside. Please remember to set
    … …  
    2125 - `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.
    2226
    23  - Non-ascii environment paths are not supported
     27 - Non-ascii environment paths are not supported.
    2428 
    25  - 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].
    2630
    2731 - 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.
    2832
    29 == Database Connection Strings ==
     33== Database Connection Strings
    3034
    31 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
    32 [http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
    33 support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
    34 to use SQLite, which is probably sufficient for most projects. The database
    35 file is then stored in the environment directory, and can easily be
    36 [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.
    3736
    38 === SQLite Connection String ===
     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
    3940The connection string for an SQLite database is:
    4041{{{
    … …  
    4344where `db/trac.db` is the path to the database file within the Trac environment.
    4445
    45 === PostgreSQL Connection String ===
    46 If you want to use PostgreSQL or MySQL instead, you'll have to use a
    47 different connection string. For example, to connect to a PostgreSQL
    48 database on the same machine called `trac`, that allows access to the
    49 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:
    5048{{{
    5149postgres://johndoe:letmein@localhost/trac
    5250}}}
    53 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    5451
    55 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:
    5653{{{
    5754postgres://johndoe:letmein@localhost:9342/trac
    5855}}}
    5956
    60 On UNIX, you might want to select a UNIX socket for the transport,
    61 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:
    6258{{{
    6359postgres://user:password@/database
    … …  
    6864}}}
    6965
    70 Note that with PostgreSQL you will have to create the database before running
    71 `trac-admin initenv`.
     66Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    7267
    7368See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
    74 Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
    75 {{{
    76 createuser -U postgres -E -P tracuser
    77 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
    7873}}}
    7974When 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.
    8075
    8176Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
    82 {{{
    83 sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
    84 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'
    8580}}}
    8681
    87 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:
    8883{{{
    8984postgres://user:pass@server/database?schema=yourschemaname
    9085}}}
    9186
    92 === MySQL Connection String ===
     87=== MySQL Connection String
    9388
    94 If you want to use MySQL instead, you'll have to use a
    95 different connection string. For example, to connect to a MySQL
    96 database on the same machine called `trac`, that allows access to the
    97 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:
    9890{{{
    9991mysql://johndoe:letmein@localhost:3306/trac
    10092}}}
    10193
    102 == Source Code Repository ==
     94== Source Code Repository
    10395
    104 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`.
    10597
    10698In 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.
    107 You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)
    108 {{{
     99You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded.
     100{{{#!ini
    109101[components]
    110102trac.versioncontrol.* = disabled
    111103}}}
    112104
    113 For some version control systems, it is possible to specify not only the path to the repository,
    114 but also a ''scope'' within the repository. Trac will then only show information
    115 related to the files and changesets below that scope. The Subversion backend for
    116 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.
    117106
    118107Example of a configuration for a Subversion repository used as the default repository:
    119 {{{
     108{{{#!ini
    120109[trac]
    121110repository_type = svn
    … …  
    124113
    125114The configuration for a scoped Subversion repository would be:
    126 {{{
     115{{{#!ini
    127116[trac]
    128117repository_type = svn
    … …  
    130119}}}
    131120
    132 == Directory Structure ==
     121== Directory Structure
    133122
    134123An environment directory will usually consist of the following files and directories:
    135124
    136125 * `README` - Brief description of the environment.
    137  * `VERSION` - Contains the environment version identifier.
     126 * `VERSION` - Environment version identifier.
    138127 * `attachments` - Attachments to wiki pages and tickets are stored here.
    139128 * `conf`
    140    * `trac.ini` - Main configuration file. See TracIni.
     129  * `trac.ini` - Main configuration file. See TracIni.
    141130 * `db`
    142    * `trac.db` - The SQLite database (if you're using SQLite).
    143  * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)''
    144  * `log` - default directory for log files, if logging is turned on and a relative path is given.
    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)''
    147    * `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.
    148137
    149138=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat