Changes between Version 5 and Version 6 of TracEnvironment
- Timestamp:
- Jan 12, 2016, 11:21:52 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracEnvironment
v5 v6 1 = The Trac Environment 1 = The Trac Environment = 2 2 3 [[TracGuideToc]] 4 [[PageOutline]] 3 Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”. 5 4 6 Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment. 5 == Creating an Environment == 7 6 8 == Creating an Environment 9 10 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]: 11 {{{#!sh 7 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]: 8 {{{ 12 9 $ trac-admin /path/to/myproject initenv 13 10 }}} 14 11 15 `trac-admin` will ask you for the name of the project and the database connection string, see below. 12 `trac-admin` will ask you for the name of the project and the 13 database connection string (explained below). 16 14 17 === Useful Tips 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. 20 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. 18 22 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. 23 - Non-ascii environment paths are not supported 22 24 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. 24 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]. 25 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]). 28 26 29 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. 30 28 31 == Database Connection Strings 29 == Database Connection Strings == 32 30 33 Trac 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. 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. 34 37 35 Note 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 38 === SQLite Connection String === 39 39 The connection string for an SQLite database is: 40 40 {{{ … … 43 43 where `db/trac.db` is the path to the database file within the Trac environment. 44 44 45 === PostgreSQL Connection String 46 47 If 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: 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: 48 50 {{{ 49 51 postgres://johndoe:[email protected]/trac 50 52 }}} 53 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.'' 51 54 52 If PostgreSQL is running on a non-standard port , for example 9342, use:55 If PostgreSQL is running on a non-standard port (for example 9342), use: 53 56 {{{ 54 57 postgres://johndoe:[email protected]:9342/trac 55 58 }}} 56 59 57 On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable: 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: 58 62 {{{ 59 63 postgres://user:[email protected]/database 60 64 }}} 61 62 65 or a specific one: 63 66 {{{ … … 65 68 }}} 66 69 67 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`. 70 Note that with PostgreSQL you will have to create the database before running 71 `trac-admin initenv`. 68 72 69 73 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL]. 70 Generally, 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 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' 74 85 }}} 75 86 76 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, because of Trac's use of unicode. SQL_ASCII also seems to work. 77 78 Under 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 84 Trac uses the `public` schema by default, but you can specify a different schema in the connection string: 87 Trac uses the `public` schema by default but you can specify a different schema in the connection string: 85 88 {{{ 86 89 postgres://user:[email protected]/database?schema=yourschemaname 87 90 }}} 88 91 89 === MySQL Connection String 92 === MySQL Connection String === 90 93 91 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`: 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: 92 98 {{{ 93 99 mysql://johndoe:[email protected]:3306/trac 94 100 }}} 95 101 96 == Source Code Repository 102 == Source Code Repository == 97 103 98 Since 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`.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`). 99 105 100 106 In 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. 101 You can also explicitly disable the `trac.versioncontrol.*` components , which are otherwise still loaded:102 {{{ #!ini107 You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded) 108 {{{ 103 109 [components] 104 110 trac.versioncontrol.* = disabled 105 111 }}} 106 112 107 For 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. 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. 108 117 109 118 Example of a configuration for a Subversion repository used as the default repository: 110 {{{ #!ini119 {{{ 111 120 [trac] 112 121 repository_type = svn … … 115 124 116 125 The configuration for a scoped Subversion repository would be: 117 {{{ #!ini126 {{{ 118 127 [trac] 119 128 repository_type = svn … … 121 130 }}} 122 131 123 == Directory Structure 132 == Directory Structure == 124 133 125 134 An environment directory will usually consist of the following files and directories: 126 135 127 136 * `README` - Brief description of the environment. 128 * `VERSION` - Environment version identifier. 129 * `files` 130 * `attachments` - Attachments to wiki pages and tickets. 137 * `VERSION` - Contains the environment version identifier. 138 * `attachments` - Attachments to wiki pages and tickets are stored here. 131 139 * `conf` 132 * `trac.ini` - Main configuration file. See TracIni.140 * `trac.ini` - Main configuration file. See TracIni. 133 141 * `db` 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 enabledand 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.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 140 148 141 149 === Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat 142 150 143 151 This is a common beginners' mistake. 144 It 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. 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. 145 154 146 155 ----