Changes between Version 11 and Version 12 of TracEnvironment


Ignore:
Timestamp:
Mar 6, 2016, 10:00:38 AM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v11 v12  
    11= The Trac Environment
     2
    23[[TracGuideToc]]
    3 [[PageOutline]]
     4[[PageOutline(2-5,Contents,pullout)]]
    45
    5 Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
     6Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
    67
    78== Creating an Environment
     
    1819 - 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.
    1920
    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.
     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.
    2422 
    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.
     23 - `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.
    2624
    2725 - Non-ascii environment paths are not supported.
     
    3028
    3129 - 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.
     30
     31{{{#!div style="border: 1pt dotted; margin: 1em"
     32**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
     33
     34This is a common beginners' mistake.
     35It 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.
     36}}}
    3237
    3338== Database Connection Strings
     
    3843
    3944=== SQLite Connection String
     45
    4046The connection string for an SQLite database is:
    4147{{{
     
    4551
    4652=== PostgreSQL Connection String
     53
    4754If 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:
    4855{{{
     
    5966postgres://user:password@/database
    6067}}}
     68
    6169or a specific one:
    6270{{{
     
    7280$ createdb -U postgres -O tracuser -E UTF8 trac
    7381}}}
    74 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.
    7582
    76 Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     83When 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.
     84
     85Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
    7786{{{#!sh
    7887$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     
    8796=== MySQL Connection String
    8897
    89 The 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:
     98The 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`:
    9099{{{
    91100mysql://johndoe:letmein@localhost:3306/trac
     
    97106
    98107In 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.
    99 You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded.
     108You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded:
    100109{{{#!ini
    101110[components]
     
    125134 * `README` - Brief description of the environment.
    126135 * `VERSION` - Environment version identifier.
    127  * `attachments` - Attachments to wiki pages and tickets are stored here.
     136 * `files`
     137  * `attachments` - Attachments to wiki pages and tickets.
    128138 * `conf`
    129139  * `trac.ini` - Main configuration file. See TracIni.
    130140 * `db`
    131141  * `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.
     142 * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs.
     143 * `log` - Default directory for log files, if `file` logging is enabled and a relative path is given.
    134144 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
    135145 * `templates` - Custom Genshi environment-specific templates.
    136146  * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
    137147
    138 === Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
    139 
    140 This is a common beginners' mistake.
    141 It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory
    142 structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
    143 
    144148----
    145149See also: TracAdmin, TracBackup, TracIni, TracGuide