Edgewall Software

Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
Dec 10, 2015 6:49:38 AM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v1 v2  
    1 = Trac Storage - The Environment =
     1= The Trac Environment
    22
    3 Trac uses a directory structure and a database for storing project data.
     3[[TracGuideToc]]
     4[[PageOutline]]
    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 [wiki:TracAdmin trac-admin]:
    8 {{{
    9 $ trac-admin /path/to/projectenv initenv
     8== Creating an Environment
     9
     10A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     11{{{#!sh
     12$ trac-admin /path/to/myproject initenv
    1013}}}
    1114
    12 [wiki:TracAdmin trac-admin] will ask you for the name of the project, the
    13 database connection string (explained below), and where your subversion
    14 repository is located.
     15`trac-admin` will ask you for the name of the project and the database connection string, see below.
    1516
    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
    19 repository, although Trac will only require read access as long as you're
    20 not using the BDB file system.''
     17=== Useful Tips
    2118
    22 == Database Connection Strings ==
     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.
    2320
    24 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
    25 [http://www.postgresql.org/ PostgreSQL] as database backends.  The default
    26 is to use SQLite, which is probably sufficient for most projects. The database file
    27 is then stored in the environment directory, and can easily be
    28 [wiki:TracBackup backed up] together with the rest of the environment.
     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.
     22 
     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.
    2924
    30 The connection string for an embedded SQLite database is:
     25 - Non-ascii environment paths are not supported.
     26 
     27 - Also, it seems that project names with spaces can be problematic for authentication, see [trac:#7163].
     28
     29 - 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== Database Connection Strings
     32
     33Trac 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.
     34
     35Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     36
     37=== SQLite Connection String
     38
     39The connection string for an SQLite database is:
    3140{{{
    3241sqlite:db/trac.db
    3342}}}
     43where `db/trac.db` is the path to the database file within the Trac environment.
    3444
    35 If you want to use PostgreSQL instead, you'll have to use a different
    36 connection string. For example, to connect to a database on the same
    37 machine called `trac`, that allows access to the user `johndoe` with
    38 the password `letmein`, use:
     45=== PostgreSQL Connection String
     46
     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:
    3948{{{
    4049postgres://johndoe:letmein@localhost/trac
    4150}}}
    4251
    43 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:
    4453{{{
    4554postgres://johndoe:letmein@localhost:9342/trac
    4655}}}
    4756
    48 Note that with PostgreSQL you will have to create the database before running
    49 `trac-admin initenv`.
     57On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
     58{{{
     59postgres://user:password@/database
     60}}}
    5061
    51 == Directory Structure ==
     62or a specific one:
     63{{{
     64postgres://user:password@/database?host=/path/to/socket/dir
     65}}}
     66
     67Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
     68
     69See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     70Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
     71{{{#!sh
     72$ createuser -U postgres -E -P tracuser
     73$ createdb -U postgres -O tracuser -E UTF8 trac
     74}}}
     75
     76When 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.
     77
     78Under some default configurations (Debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user:
     79{{{#!sh
     80$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     81$ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     82}}}
     83
     84Trac uses the `public` schema by default, but you can specify a different schema in the connection string:
     85{{{
     86postgres://user:pass@server/database?schema=yourschemaname
     87}}}
     88
     89=== MySQL Connection String
     90
     91The 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`:
     92{{{
     93mysql://johndoe:letmein@localhost:3306/trac
     94}}}
     95
     96== Source Code Repository
     97
     98Since 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`.
     99
     100In 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.
     101You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded:
     102{{{#!ini
     103[components]
     104trac.versioncontrol.* = disabled
     105}}}
     106
     107For 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.
     108
     109Example of a configuration for a Subversion repository used as the default repository:
     110{{{#!ini
     111[trac]
     112repository_type = svn
     113repository_dir = /path/to/your/repository
     114}}}
     115
     116The configuration for a scoped Subversion repository would be:
     117{{{#!ini
     118[trac]
     119repository_type = svn
     120repository_dir = /path/to/your/repository/scope/within/repos
     121}}}
     122
     123== Directory Structure
    52124
    53125An environment directory will usually consist of the following files and directories:
    54126
    55127 * `README` - Brief description of the environment.
    56  * `VERSION` - Contains the environment version identifier.
    57  * `attachments` - Attachments to wiki pages and tickets are stored here.
     128 * `VERSION` - Environment version identifier.
     129 * `files`
     130  * `attachments` - Attachments to wiki pages and tickets.
    58131 * `conf`
    59    * `trac.ini` - Main configuration file. See TracIni.
     132  * `trac.ini` - Main configuration file. See TracIni.
    60133 * `db`
    61    * `trac.db` - The SQLite database (if you're using SQLite).
    62  * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs)
    63  * `templates` - Custom environment-specific templates.
    64    * `site_css.cs` - Custom CSS rules.
    65    * `site_footer.cs` - Custom page footer.
    66    * `site_header.cs` - Custom page header.
    67  * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros].
     134  * `trac.db` - The SQLite database, if you are using SQLite.
     135 * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs.
     136 * `log` - Default directory for log files, if `file` logging is enabled and a relative path is given.
     137 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
     138 * `templates` - Custom Genshi environment-specific templates.
     139  * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
     140
     141=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
     142
     143This is a common beginners' mistake.
     144It 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.
    68145
    69146----