Changes between Version 4 and Version 5 of TracEnvironment


Ignore:
Timestamp:
06/10/18 13:58:01 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v4 v5  
    22
    33[[TracGuideToc]]
    4 [[PageOutline]]
     4[[PageOutline(2-5,Contents,pullout)]]
    55
    66Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
     7Trac 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.
     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
     35This is a common beginners' mistake.
     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.
     37}}}
    3038
    3139== Database Connection Strings
    3240
    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.
     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.
    3442
    3543Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
    … …  
    4553=== PostgreSQL Connection String
    4654
    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:
     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:
    4856{{{
    4957postgres://johndoe:letmein@localhost/trac
    … …  
    6573}}}
    6674
    67 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    68 
    6975See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
    7076Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
    … …  
    7682When 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.
    7783
    78 Under some default configurations (Debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user:
     84Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
    7985{{{#!sh
    8086$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
    … …  
    8995=== MySQL Connection String
    9096
    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`:
     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`:
    9298{{{
    9399mysql://johndoe:letmein@localhost:3306/trac
    … …  
    96102== Source Code Repository
    97103
    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`.
     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.
    99105
    100 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 {{{#!ini
    103 [components]
    104 trac.versioncontrol.* = disabled
    105 }}}
    106 
    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.
    108 
    109 Example of a configuration for a Subversion repository used as the default repository:
    110 {{{#!ini
    111 [trac]
    112 repository_type = svn
    113 repository_dir = /path/to/your/repository
    114 }}}
    115 
    116 The configuration for a scoped Subversion repository would be:
    117 {{{#!ini
    118 [trac]
    119 repository_type = svn
    120 repository_dir = /path/to/your/repository/scope/within/repos
    121 }}}
     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.
    122107
    123108== Directory Structure
    124109
    125 An environment directory will usually consist of the following files and directories:
     110An environment consists of the following files and directories:
    126111
    127112 * `README` - Brief description of the environment.
    … …  
    139124  * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
    140125
    141 === Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
    142 
    143 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.
    145 
    146126----
    147127See also: TracAdmin, TracBackup, TracIni, TracGuide