Changes between Version 4 and Version 5 of TracEnvironment
- Timestamp:
- 12/30/16 22:35:22 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracEnvironment
v4 v5 4 4 [[PageOutline(2-5,Contents,pullout)]] 5 5 6 Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment. 6 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`. 7 10 8 11 == Creating an Environment 9 12 10 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: 11 14 {{{#!sh 12 15 $ trac-admin /path/to/myproject initenv 13 16 }}} 14 17 15 `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]. 16 19 17 20 === Useful Tips … … 25 28 - Non-ascii environment paths are not supported. 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].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. 28 31 29 32 {{{#!div style="border: 1pt dotted; margin: 1em" … … 31 34 32 35 This is a common beginners' mistake. 33 It happens that the structure for a Trac environment is loosely model led 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 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. 34 37 }}} 35 38 36 39 == Database Connection Strings 37 40 38 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. 39 42 40 43 Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded. … … 50 53 === PostgreSQL Connection String 51 54 52 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: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: 53 56 {{{ 54 57 postgres://johndoe:letmein@localhost/trac … … 69 72 postgres://user:password@/database?host=/path/to/socket/dir 70 73 }}} 71 72 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.73 74 74 75 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL]. … … 94 95 === MySQL Connection String 95 96 96 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`: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`: 97 98 {{{ 98 99 mysql://johndoe:letmein@localhost:3306/trac … … 101 102 == Source Code Repository 102 103 103 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. 104 105 105 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. 106 You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded: 107 {{{#!ini 108 [components] 109 trac.versioncontrol.* = disabled 110 }}} 111 112 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 114 Example of a configuration for a Subversion repository used as the default repository: 115 {{{#!ini 116 [trac] 117 repository_type = svn 118 repository_dir = /path/to/your/repository 119 }}} 120 121 The configuration for a scoped Subversion repository would be: 122 {{{#!ini 123 [trac] 124 repository_type = svn 125 repository_dir = /path/to/your/repository/scope/within/repos 126 }}} 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. 127 107 128 108 == Directory Structure 129 109 130 An environment directory will usually consistof the following files and directories:110 An environment consists of the following files and directories: 131 111 132 112 * `README` - Brief description of the environment.
