Changes between Version 4 and Version 5 of TracEnvironment
- Timestamp:
- Jan 5, 2017, 12:12:59 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracEnvironment
v4 v5 1 1 = The Trac Environment 2 2 3 [[TracGuideToc]] 3 [[PageOutline ]]4 [[PageOutline(2-5,Contents,pullout)]] 4 5 5 6 Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment. 7 Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''. 8 9 Trac supports [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] databases. With PostgreSQL and MySQL you have to create the database before running `trac-admin initenv`. 6 10 7 11 == Creating an Environment 8 12 9 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:13 A new Trac environment is created using the [TracAdmin#initenv initenv] command: 10 14 {{{#!sh 11 15 $ trac-admin /path/to/myproject initenv 12 16 }}} 13 17 14 `trac-admin` will ask you for the name of the project and the database connection string, see below.18 `trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string]. 15 19 16 20 === Useful Tips … … 18 22 - 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 23 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. 24 - 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. 24 25 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.26 - `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//. 26 27 27 28 - Non-ascii environment paths are not supported. 28 29 - Also, it seems that project names with spaces can be problematic for authentication, see [trac:#7163].30 29 31 - 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 - TracPlugins located in a [TracIni#inherit-section shared plugins folder] that is defined in an [TracIni#GlobalConfiguration inherited configuration] are not loaded during creation, and hence, if they need to create extra tables for example, you'll need to [TracUpgrade#UpgradetheTracEnvironment upgrade the environment]. Alternatively you can avoid the need to upgrade the environment by specifying a configuration file at the time the environment is created, using the `--config` option. See TracAdmin#FullCommandReference for more information. 31 32 {{{#!div style="border: 1pt dotted; margin: 1em" 33 **Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//. 34 35 This is a common beginners' mistake. 36 It happens that the structure for a Trac environment is loosely modeled 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. 37 }}} 32 38 33 39 == Database Connection Strings 34 40 35 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 thenstored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment.41 You will need to specify a database connection string at the time the environment is created. The default is SQLite, which is probably sufficient for most projects. The SQLite database file is stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment. 36 42 37 43 Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded. 38 44 39 45 === SQLite Connection String 46 40 47 The connection string for an SQLite database is: 41 48 {{{ … … 45 52 46 53 === PostgreSQL Connection String 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: 54 55 The connection string for PostgreSQL is a bit more complex. For example, to connect to a PostgreSQL database named `trac` on `localhost` for user `johndoe` and password `letmein`, use: 48 56 {{{ 49 57 postgres://johndoe:letmein@localhost/trac … … 59 67 postgres://user:password@/database 60 68 }}} 69 61 70 or a specific one: 62 71 {{{ 63 72 postgres://user:password@/database?host=/path/to/socket/dir 64 73 }}} 65 66 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.67 74 68 75 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL]. … … 72 79 $ createdb -U postgres -O tracuser -E UTF8 trac 73 80 }}} 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.75 81 76 Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user. For example: 82 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. 83 84 Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user: 77 85 {{{#!sh 78 86 $ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' … … 87 95 === MySQL Connection String 88 96 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:97 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 `localhost` named `trac` for user `johndoe` with password `letmein`: 90 98 {{{ 91 99 mysql://johndoe:letmein@localhost:3306/trac … … 94 102 == Source Code Repository 95 103 96 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 A single environment can be connected to more than one repository. However, by default Trac is not connected to any source code repository, and the ''Browse Source'' navigation item will not be displayed. 97 105 98 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. 99 You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded. 100 {{{#!ini 101 [components] 102 trac.versioncontrol.* = disabled 103 }}} 104 105 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. 106 107 Example of a configuration for a Subversion repository used as the default repository: 108 {{{#!ini 109 [trac] 110 repository_type = svn 111 repository_dir = /path/to/your/repository 112 }}} 113 114 The configuration for a scoped Subversion repository would be: 115 {{{#!ini 116 [trac] 117 repository_type = svn 118 repository_dir = /path/to/your/repository/scope/within/repos 119 }}} 106 There are many different ways to connect repositories to an environment, see TracRepositoryAdmin. A single repository can be specified when the environment is created by passing the optional arguments `repository_type` and `repository_dir` to the `initenv` command. 120 107 121 108 == Directory Structure 122 109 123 An environment directory will usually consistof the following files and directories:110 An environment consists of the following files and directories: 124 111 125 112 * `README` - Brief description of the environment. 126 113 * `VERSION` - Environment version identifier. 127 * `attachments` - Attachments to wiki pages and tickets are stored here. 114 * `files` 115 * `attachments` - Attachments to wiki pages and tickets. 128 116 * `conf` 129 117 * `trac.ini` - Main configuration file. See TracIni. 130 118 * `db` 131 119 * `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 onand a relative path is given.120 * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs. 121 * `log` - Default directory for log files, if `file` logging is enabled and a relative path is given. 134 122 * `plugins` - Environment-specific [wiki:TracPlugins plugins]. 135 123 * `templates` - Custom Genshi environment-specific templates. 136 124 * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance. 137 125 138 === Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat139 140 This is a common beginners' mistake.141 It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory142 structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.143 144 126 ---- 145 127 See also: TracAdmin, TracBackup, TracIni, TracGuide