Changes between Version 3 and Version 4 of TracEnvironment


Ignore:
Timestamp:
Apr 24, 2017, 10:36:27 AM (2 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v3 v4  
    1 = The Trac Environment =
     1= The Trac Environment
    22
    3 Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
     3[[TracGuideToc]]
     4[[PageOutline(2-5,Contents,pullout)]]
    45
    5 == Creating an Environment ==
     6Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
    67
    7 A new Trac environment is created using  [TracAdmin#initenv trac-admin's initenv]:
    8 {{{
     8== Creating an Environment
     9
     10A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     11{{{#!sh
    912$ trac-admin /path/to/myproject initenv
    1013}}}
    1114
    12 `trac-admin` will ask you for the name of the project and the
    13 database connection string (explained below).
     15`trac-admin` will ask you for the name of the project and the database connection string, see below.
    1416
    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.
     17=== Useful Tips
     18
     19 - 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.
     20
     21 - The user under which the web server runs will require file system write permission to the environment directory and all the files inside. Please remember to set the appropriate permissions. The same applies to the source code repository, 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.
    2022 
    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.
     23 - `initenv` does not create a version control repository for the specified path. If you wish to specify a default repository using optional the arguments to `initenv` you must create the repository first, otherwise you will see a message when initializing the environment: //Warning: couldn't index the default repository//.
    2224
    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]).
     25 - Non-ascii environment paths are not supported.
    2626
    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.
     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].
    2828
    29 == Database Connection Strings ==
     29{{{#!div style="border: 1pt dotted; margin: 1em"
     30**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
    3031
    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.
     32This is a common beginners' mistake.
     33It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
     34}}}
    3735
    38 === SQLite Connection String ===
     36== Database Connection Strings
     37
     38Trac 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.
     39
     40Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     41
     42=== SQLite Connection String
     43
    3944The connection string for an SQLite database is:
    4045{{{
     
    4348where `db/trac.db` is the path to the database file within the Trac environment.
    4449
    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:
     50=== PostgreSQL Connection String
     51
     52If 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:
    5053{{{
    5154postgres://johndoe:letmein@localhost/trac
    5255}}}
    53 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    5456
    55 If PostgreSQL is running on a non-standard port (for example 9342), use:
     57If PostgreSQL is running on a non-standard port, for example 9342, use:
    5658{{{
    5759postgres://johndoe:letmein@localhost:9342/trac
    5860}}}
    5961
    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:
     62On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
    6263{{{
    6364postgres://user:password@/database
    6465}}}
     66
    6567or a specific one:
    6668{{{
     
    6870}}}
    6971
    70 Note that with PostgreSQL you will have to create the database before running
    71 `trac-admin initenv`.
     72Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    7273
    7374See 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
    78 }}}
    79 When 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.
    80 
    81 Under 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'
     75Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
     76{{{#!sh
     77$ createuser -U postgres -E -P tracuser
     78$ createdb -U postgres -O tracuser -E UTF8 trac
    8579}}}
    8680
    87 Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     81When 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, because of Trac's use of unicode. SQL_ASCII also seems to work.
     82
     83Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
     84{{{#!sh
     85$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     86$ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     87}}}
     88
     89Trac uses the `public` schema by default, but you can specify a different schema in the connection string:
    8890{{{
    8991postgres://user:pass@server/database?schema=yourschemaname
    9092}}}
    9193
    92 === MySQL Connection String ===
     94=== MySQL Connection String
    9395
    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:
     96The 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`:
    9897{{{
    9998mysql://johndoe:letmein@localhost:3306/trac
    10099}}}
    101100
    102 == Source Code Repository ==
     101== Source Code Repository
    103102
    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`).
     103Since 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`.
    105104
    106105In 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 {{{
     106You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded:
     107{{{#!ini
    109108[components]
    110109trac.versioncontrol.* = disabled
    111110}}}
    112111
    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.
     112For 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.
    117113
    118114Example of a configuration for a Subversion repository used as the default repository:
    119 {{{
     115{{{#!ini
    120116[trac]
    121117repository_type = svn
     
    124120
    125121The configuration for a scoped Subversion repository would be:
    126 {{{
     122{{{#!ini
    127123[trac]
    128124repository_type = svn
     
    130126}}}
    131127
    132 == Directory Structure ==
     128== Directory Structure
    133129
    134130An environment directory will usually consist of the following files and directories:
    135131
    136132 * `README` - Brief description of the environment.
    137  * `VERSION` - Contains the environment version identifier.
    138  * `attachments` - Attachments to wiki pages and tickets are stored here.
     133 * `VERSION` - Environment version identifier.
     134 * `files`
     135  * `attachments` - Attachments to wiki pages and tickets.
    139136 * `conf`
    140    * `trac.ini` - Main configuration file. See TracIni.
     137  * `trac.ini` - Main configuration file. See TracIni.
    141138 * `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
    148 
    149 '''Caveat:''' ''don't confuse a Trac environment directory with the source code repository directory.''
    150 
    151 This is a common beginners' mistake.
    152 It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory
    153 structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
     139  * `trac.db` - The SQLite database, if you are using SQLite.
     140 * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs.
     141 * `log` - Default directory for log files, if `file` logging is enabled and a relative path is given.
     142 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
     143 * `templates` - Custom Genshi environment-specific templates.
     144  * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
    154145
    155146----