Changes between Version 3 and Version 4 of TracEnvironment


Ignore:
Timestamp:
May 24, 2018, 4:29:30 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v3 v4  
    44[[PageOutline(2-5,Contents,pullout)]]
    55
     6Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
    67Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
     8
     9Trac 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`.
    710
    811== Creating an Environment
    912
    10 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     13A new Trac environment is created using the [TracAdmin#initenv initenv] command:
    1114{{{#!sh
    1215$ trac-admin /path/to/myproject initenv
    1316}}}
    1417
    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].
    1619
    1720=== Useful Tips
     
    2124 - 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.
    2225 
    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.
     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//.
    2427
    2528 - 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].
    2829
    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 - 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.
    3031
    3132{{{#!div style="border: 1pt dotted; margin: 1em"
     
    3334
    3435This is a common beginners' mistake.
    35 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.
     36It 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.
    3637}}}
    3738
    3839== Database Connection Strings
    3940
    40 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.
     41You 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.
    4142
    4243Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     
    5253=== PostgreSQL Connection String
    5354
    54 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:
     55The 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:
    5556{{{
    5657postgres://johndoe:letmein@localhost/trac
     
    7172postgres://user:password@/database?host=/path/to/socket/dir
    7273}}}
    73 
    74 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    7574
    7675See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     
    9695=== MySQL Connection String
    9796
    98 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`:
     97The 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`:
    9998{{{
    10099mysql://johndoe:letmein@localhost:3306/trac
     
    103102== Source Code Repository
    104103
    105 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`.
     104A 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.
    106105
    107 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.
    108 You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded:
    109 {{{#!ini
    110 [components]
    111 trac.versioncontrol.* = disabled
    112 }}}
    113 
    114 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.
    115 
    116 Example of a configuration for a Subversion repository used as the default repository:
    117 {{{#!ini
    118 [trac]
    119 repository_type = svn
    120 repository_dir = /path/to/your/repository
    121 }}}
    122 
    123 The configuration for a scoped Subversion repository would be:
    124 {{{#!ini
    125 [trac]
    126 repository_type = svn
    127 repository_dir = /path/to/your/repository/scope/within/repos
    128 }}}
     106There 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.
    129107
    130108== Directory Structure
    131109
    132 An environment directory will usually consist of the following files and directories:
     110An environment consists of the following files and directories:
    133111
    134112 * `README` - Brief description of the environment.