Changes between Version 3 and Version 4 of TracEnvironment
- Timestamp:
- 2015-03-21T12:46:07Z (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracEnvironment
v3 v4 1 = The Trac Environment = 1 = The Trac Environment 2 [[TracGuideToc]] 3 [[PageOutline]] 2 4 3 Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.5 Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment. 4 6 5 == Creating an Environment ==7 == Creating an Environment 6 8 7 A new Trac environment is created using 8 {{{ 9 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]: 10 {{{#!sh 9 11 $ trac-admin /path/to/myproject initenv 10 12 }}} 11 13 12 `trac-admin` will ask you for the name of the project and the 13 database connection string (explained below). 14 `trac-admin` will ask you for the name of the project and the database connection string, see below. 14 15 15 === Some Useful Tips 16 === Useful Tips 17 18 - 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 16 20 - The user under which the web server runs will require file system write permission to 17 21 the environment directory and all the files inside. Please remember to set … … 21 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. 22 26 23 - Non-ascii environment paths are not supported 27 - Non-ascii environment paths are not supported. 24 28 25 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]).29 - Also, it seems that project names with spaces can be problematic for authentication, see [trac:#7163]. 26 30 27 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. 28 32 29 == Database Connection Strings ==33 == Database Connection Strings 30 34 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. 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 then stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment. 37 36 38 === SQLite Connection String === 37 Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded. 38 39 === SQLite Connection String 39 40 The connection string for an SQLite database is: 40 41 {{{ … … 43 44 where `db/trac.db` is the path to the database file within the Trac environment. 44 45 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: 46 === 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: 50 48 {{{ 51 49 postgres://johndoe:letmein@localhost/trac 52 50 }}} 53 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''54 51 55 If PostgreSQL is running on a non-standard port (for example 9342), use:52 If PostgreSQL is running on a non-standard port, for example 9342, use: 56 53 {{{ 57 54 postgres://johndoe:letmein@localhost:9342/trac 58 55 }}} 59 56 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: 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: 62 58 {{{ 63 59 postgres://user:password@/database … … 68 64 }}} 69 65 70 Note that with PostgreSQL you will have to create the database before running 71 `trac-admin initenv`. 66 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`. 72 67 73 68 See 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 tracuser77 createdb -U postgres -O tracuser -E UTF8 trac69 Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`: 70 {{{#!sh 71 $ createuser -U postgres -E -P tracuser 72 $ createdb -U postgres -O tracuser -E UTF8 trac 78 73 }}} 79 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. 80 75 81 76 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'77 {{{#!sh 78 $ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' 79 $ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac' 85 80 }}} 86 81 87 Trac uses the `public` schema by default but you can specify a different schema in the connection string:82 Trac uses the `public` schema by default, but you can specify a different schema in the connection string: 88 83 {{{ 89 84 postgres://user:pass@server/database?schema=yourschemaname 90 85 }}} 91 86 92 === MySQL Connection String ===87 === MySQL Connection String 93 88 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: 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: 98 90 {{{ 99 91 mysql://johndoe:letmein@localhost:3306/trac 100 92 }}} 101 93 102 == Source Code Repository ==94 == Source Code Repository 103 95 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`).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`. 105 97 106 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. 107 You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)108 {{{ 99 You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded. 100 {{{#!ini 109 101 [components] 110 102 trac.versioncontrol.* = disabled 111 103 }}} 112 104 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. 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. 117 106 118 107 Example of a configuration for a Subversion repository used as the default repository: 119 {{{ 108 {{{#!ini 120 109 [trac] 121 110 repository_type = svn … … 124 113 125 114 The configuration for a scoped Subversion repository would be: 126 {{{ 115 {{{#!ini 127 116 [trac] 128 117 repository_type = svn … … 130 119 }}} 131 120 132 == Directory Structure ==121 == Directory Structure 133 122 134 123 An environment directory will usually consist of the following files and directories: 135 124 136 125 * `README` - Brief description of the environment. 137 * `VERSION` - Contains the environment version identifier.126 * `VERSION` - Environment version identifier. 138 127 * `attachments` - Attachments to wiki pages and tickets are stored here. 139 128 * `conf` 140 129 * `trac.ini` - Main configuration file. See TracIni. 141 130 * `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#SiteAppearance131 * `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. 134 * `plugins` - Environment-specific [wiki:TracPlugins plugins]. 135 * `templates` - Custom Genshi environment-specific templates. 136 * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance. 148 137 149 '''Caveat:''' ''don't confuse a Trac environment directory with the source code repository directory.'' 138 === Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat 150 139 151 140 This is a common beginners' mistake.
