Changes between Version 2 and Version 3 of TracEnvironment


Ignore:
Timestamp:
Aug 1, 2024, 10:29:24 AM (4 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v2 v3  
    66Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
    77
     8Trac supports [https://www.sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL] and [https://www.mysql.com/ MySQL] databases. With PostgreSQL and MySQL you have to create the database before running `trac-admin initenv`.
     9
    810== Creating an Environment
    911
    10 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     12A new Trac environment is created using the [TracAdmin#initenv initenv] command:
    1113{{{#!sh
    1214$ trac-admin /path/to/myproject initenv
    1315}}}
    1416
    15 `trac-admin` will ask you for the name of the project and the database connection string, see below.
     17`trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
     18
     19A base configuration can be specified using the `--inherit` or `--config` options. The `--inherit` option can be specified one or more times to utilize a [TracIni#GlobalConfiguration global configuration]. The options specified in a `--config` file will be used to override the defaults when initializing `trac.ini`. See below for an [#SourceCodeRepository example] of defining repositories in a configuration file.
    1620
    1721=== Useful Tips
    … …  
    1923 - 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.
    2024
    21  - 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.
    22  
    23  - `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//.
     25 - 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.
    2426
    2527 - Non-ascii environment paths are not supported.
    2628
    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].
     29 - TracPlugins located in a [TracIni#inherit-plugins_dir-option shared plugins directory] that is defined in an [TracIni#GlobalConfiguration inherited configuration] are not enabled by default, in contrast to plugins in the environment `plugins` directory. Hence, if they need to create extra tables, for example, the tables will not be created during environment creation and you'll need to [TracUpgrade#UpgradetheTracEnvironment upgrade the environment]. Alternatively you can avoid the need to upgrade the environment by explicitly enabling the plugin(s) in a configuration file using the `--inherit` or `--config` option. See TracAdmin#FullCommandReference for more information.
    2830
    29 {{{#!div style="border: 1pt dotted; margin: 1em"
     31{{{#!div style="border: 1pt dotted; margin: 1em;"
    3032**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
    3133
    3234This is a common beginners' mistake.
    33 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.
     35It 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.
    3436}}}
    3537
    3638== Database Connection Strings
    3739
    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 then stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment.
     40You will need to specify a database connection string at the time the environment is created. The default is SQLite, which is 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.
    3941
    40 Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     42Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be [https://meyerweb.com/eric/tools/dencoder/ URL encoded].
     43{{{#!sh
     44$ python -c "import urllib; print urllib.quote('password@:/123', '')"
     45password%40%3A%2F123
     46}}}
    4147
    4248=== SQLite Connection String
    … …  
    4854where `db/trac.db` is the path to the database file within the Trac environment.
    4955
     56See [trac:DatabaseBackend#SQLite] for more information.
     57
    5058=== PostgreSQL Connection String
    5159
    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:
     60The 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:
    5361{{{
    5462postgres://johndoe:letmein@localhost/trac
    … …  
    7078}}}
    7179
    72 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    73 
    74 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     80See the [https://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [https://www.postgresql.org/ PostgreSQL].
    7581Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
    7682{{{#!sh
    … …  
    7985}}}
    8086
    81 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, because of Trac's use of unicode. SQL_ASCII also seems to work.
     87When running `createuser` you will be prompted for the password for the `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.
    8288
    8389Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
    … …  
    94100=== MySQL Connection String
    95101
    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`:
     102The format of the MySQL connection string is similar to 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`:
    97103{{{
    98104mysql://johndoe:letmein@localhost:3306/trac
    99105}}}
    100106
     107=== Changing Database Backend
     108
     109The TracAdmin `convert_db` command allows migrating between SQLite, MySQL and PostgreSQL databases.
     110
     111[[TracAdminHelp(convert_db)]]
     112
     113== Deleting a Trac Environment
     114
     115The Trac environment can be deleted using standard filesystem utilities to delete the directory that was passed to the `initenv` command. For an environment using SQLite, this will also delete the SQLite database, which resides on-disk in the environment `db` directory. For an environment using PostgreSQL or MySQL, you will need to use the associated database utilities to delete the database.
     116
    101117== Source Code Repository
    102118
    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`.
     119A 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. There are several ways to connect repositories to an environment, see TracRepositoryAdmin.
    104120
    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
     121Repositories can be defined at the time of environment creation by specifying a configuration file to the `initenv` command using the `--config` or `--inherit` options. Cached repositories will be synchronized if the repository connector(s) are enabled. Example:
     122
     123{{{#!sh
     124$ trac-admin $ENV initenv --config=config.ini
     125$ cat config.ini
    108126[components]
    109 trac.versioncontrol.* = disabled
    110 }}}
     127tracopt.versioncontrol.* = enabled
    111128
    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
     129[repositories]
     130.dir = /path/to/default/type/repos
     131repos1.type = git
     132repos1.dir = /path/to/git/repos
     133repos2.type = svn
     134repos2.dir = /path/to/svn/repos
    126135}}}
    127136
    128137== Directory Structure
    129138
    130 An environment directory will usually consist of the following files and directories:
     139An environment consists of the following files and directories:
    131140
    132141 * `README` - Brief description of the environment.
    … …  
    135144  * `attachments` - Attachments to wiki pages and tickets.
    136145 * `conf`
    137   * `trac.ini` - Main configuration file. See TracIni.
     146  * `trac.ini` - Main [TracIni configuration file].
    138147 * `db`
    139148  * `trac.db` - The SQLite database, if you are using SQLite.
    140  * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs.
    141  * `log` - Default directory for log files, if `file` logging is enabled and a relative path is given.
     149 * `htdocs` - Directory containing web resources, which can be referenced in templates using the path `/chrome/site/...`.
     150 * `log` - Default directory for log files when `file` logging is enabled and a relative path is given.
    142151 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
    143152 * `templates` - Custom Genshi environment-specific templates.
    144   * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
     153  * `site.html` - Method to [TracInterfaceCustomization#SiteAppearance customize] the site header, footer, and style.
    145154
    146155----
    147 See also: TracAdmin, TracBackup, TracIni, TracGuide
     156See also: TracAdmin, TracBackup, TracIni