Changes between Version 4 and Version 5 of TracEnvironment


Ignore:
Timestamp:
Aug 1, 2023, 3:35:37 PM (16 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v4 v5  
    44[[PageOutline(2-5,Contents,pullout)]]
    55
    6 Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
    76Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
    87
    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`.
     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`.
    109
    1110== Creating an Environment
    … …  
    1817`trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
    1918
     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.
     20
    2021=== Useful Tips
    2122
    2223 - 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.
    2324
    24  - 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.
    25  
    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//.
     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.
    2726
    2827 - Non-ascii environment paths are not supported.
    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.
     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.
    3130
    32 {{{#!div style="border: 1pt dotted; margin: 1em"
     31{{{#!div style="border: 1pt dotted; margin: 1em;"
    3332**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
    3433
    … …  
    3938== Database Connection Strings
    4039
    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.
     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.
    4241
    43 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}}}
    4447
    4548=== SQLite Connection String
    … …  
    5053}}}
    5154where `db/trac.db` is the path to the database file within the Trac environment.
     55
     56See [trac:DatabaseBackend#SQLite] for more information.
    5257
    5358=== PostgreSQL Connection String
    … …  
    7378}}}
    7479
    75 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].
    7681Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
    7782{{{#!sh
    … …  
    8085}}}
    8186
    82 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.
    8388
    8489Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
    … …  
    95100=== MySQL Connection String
    96101
    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`:
     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`:
    98103{{{
    99104mysql://johndoe:letmein@localhost:3306/trac
    100105}}}
    101106
     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
    102117== Source Code Repository
    103118
    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.
     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.
    105120
    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.
     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
     126[components]
     127tracopt.versioncontrol.* = enabled
     128
     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
     135}}}
    107136
    108137== Directory Structure
    … …  
    115144  * `attachments` - Attachments to wiki pages and tickets.
    116145 * `conf`
    117   * `trac.ini` - Main configuration file. See TracIni.
     146  * `trac.ini` - Main [TracIni configuration file].
    118147 * `db`
    119148  * `trac.db` - The SQLite database, if you are using SQLite.
    120  * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs.
    121  * `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.
    122151 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
    123152 * `templates` - Custom Genshi environment-specific templates.
    124   * `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.
    125154
    126155----
    127 See also: TracAdmin, TracBackup, TracIni, TracGuide
     156See also: TracAdmin, TracBackup, TracIni