Changes between Version 2 and Version 3 of TracEnvironment


Ignore:
Timestamp:
May 2, 2019, 9:45:05 AM (14 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v2 v3  
    22
    33[[TracGuideToc]]
    4 [[PageOutline(2-5,Contents,pullout)]]
     4[[PageOutline]]
    55
    66Trac 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`.
    107
    118== Creating an Environment
    129
    13 A new Trac environment is created using the [TracAdmin#initenv initenv] command:
     10A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
    1411{{{#!sh
    1512$ trac-admin /path/to/myproject initenv
    1613}}}
    1714
    18 `trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
     15`trac-admin` will ask you for the name of the project and the database connection string, see below.
    1916
    2017=== Useful Tips
     
    2421 - 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.
    2522 
    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//.
     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.
    2724
    2825 - 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].
    2928
    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 }}}
     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.
    3830
    3931== Database Connection Strings
    4032
    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.
     33Trac 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.
    4234
    4335Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     
    5345=== PostgreSQL Connection String
    5446
    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:
     47If 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:
    5648{{{
    5749postgres://johndoe:letmein@localhost/trac
     
    7365}}}
    7466
     67Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
     68
    7569See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
    7670Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
     
    8276When 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.
    8377
    84 Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
     78Under some default configurations (Debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user:
    8579{{{#!sh
    8680$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     
    9589=== MySQL Connection String
    9690
    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`:
     91The 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`:
    9892{{{
    9993mysql://johndoe:letmein@localhost:3306/trac
     
    10296== Source Code Repository
    10397
    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.
     98Since 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`.
    10599
    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.
     100In 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.
     101You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded:
     102{{{#!ini
     103[components]
     104trac.versioncontrol.* = disabled
     105}}}
     106
     107For 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
     109Example of a configuration for a Subversion repository used as the default repository:
     110{{{#!ini
     111[trac]
     112repository_type = svn
     113repository_dir = /path/to/your/repository
     114}}}
     115
     116The configuration for a scoped Subversion repository would be:
     117{{{#!ini
     118[trac]
     119repository_type = svn
     120repository_dir = /path/to/your/repository/scope/within/repos
     121}}}
    107122
    108123== Directory Structure
    109124
    110 An environment consists of the following files and directories:
     125An environment directory will usually consist of the following files and directories:
    111126
    112127 * `README` - Brief description of the environment.
     
    124139  * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
    125140
     141=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
     142
     143This is a common beginners' mistake.
     144It 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
    126146----
    127147See also: TracAdmin, TracBackup, TracIni, TracGuide