Changes between Version 2 and Version 3 of TracEnvironment


Ignore:
Timestamp:
2023-04-20T18:47:43Z (12 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracEnvironment

    v2 v3  
    1 = The Trac Environment =
     1= The Trac Environment
    22
    3 Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
     3[[TracGuideToc]]
     4[[PageOutline(2-5,Contents,pullout)]]
    45
    5 == Creating an Environment ==
     6Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
    67
    7 A new Trac environment is created using  [wiki:TracAdmin trac-admin]:
    8 {{{
     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
     10== Creating an Environment
     11
     12A new Trac environment is created using the [TracAdmin#initenv initenv] command:
     13{{{#!sh
    914$ trac-admin /path/to/myproject initenv
    1015}}}
    1116
    12 [wiki:TracAdmin trac-admin] will ask you for the name of the project, the
    13 database connection string (explained below), and the type and path to
    14 your source code repository.
     17`trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
    1518
    16 ''Note: The web server user will require file system write permission to
    17 the environment directory and all the files inside. Please remember to set
    18 the appropriate permissions. The same applies to the Subversion repository
    19 Trac is eventually using, although Trac will only require read access as long
    20 as you're not using the BDB file system.''
     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.
    2120
    22 == Database Connection Strings ==
     21=== Useful Tips
    2322
    24 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
    25 [http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
    26 support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
    27 to use SQLite, which is probably sufficient for most projects. The database
    28 file is then stored in the environment directory, and can easily be
    29 [wiki:TracBackup backed up] together with the rest of the environment.
     23 - 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.
    3024
    31 === Embedded SQLite Connection String ===
    32 The connection string for an embedded SQLite database is:
     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.
     26
     27 - Non-ascii environment paths are not supported.
     28
     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.
     30
     31{{{#!div style="border: 1pt dotted; margin: 1em;"
     32**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
     33
     34This is a common beginners' mistake.
     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.
     36}}}
     37
     38== Database Connection Strings
     39
     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.
     41
     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}}}
     47
     48=== SQLite Connection String
     49
     50The connection string for an SQLite database is:
    3351{{{
    3452sqlite:db/trac.db
    3553}}}
     54where `db/trac.db` is the path to the database file within the Trac environment.
    3655
    37 === PostgreSQL Connection String ===
    38 If you want to use PostgreSQL or MySQL instead, you'll have to use a
    39 different connection string. For example, to connect to a PostgreSQL
    40 database on the same machine called `trac`, that allows access to the
    41 user `johndoe` with the password `letmein`, use:
     56See [trac:DatabaseBackend#SQLite] for more information.
     57
     58=== PostgreSQL Connection String
     59
     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:
    4261{{{
    4362postgres://johndoe:letmein@localhost/trac
    4463}}}
    45 ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    4664
    47 If PostgreSQL is running on a non-standard port (for example 9342), use:
     65If PostgreSQL is running on a non-standard port, for example 9342, use:
    4866{{{
    4967postgres://johndoe:letmein@localhost:9342/trac
    5068}}}
    5169
    52 On UNIX, you might want to select a UNIX socket for the transport,
    53 either the default socket as defined by the PGHOST environment variable:
     70On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
    5471{{{
    5572postgres://user:password@/database
    5673}}}
     74
    5775or a specific one:
    5876{{{
    … …  
    6078}}}
    6179
    62 Note that with PostgreSQL you will have to create the database before running
    63 `trac-admin initenv`.
    64 
    65 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
    66 Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
    67 {{{
    68 createuser -U postgres -E -P tracuser
    69 createdb -U postgres -O tracuser -E UTF8 trac
    70 }}}
    71 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 trac's use of unicode in trac.  SQL_ASCII also seems to work.
    72 
    73 Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
    74 {{{
    75 sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
    76 sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     80See the [https://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [https://www.postgresql.org/ PostgreSQL].
     81Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
     82{{{#!sh
     83$ createuser -U postgres -E -P tracuser
     84$ createdb -U postgres -O tracuser -E UTF8 trac
    7785}}}
    7886
    79 Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     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.
     88
     89Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
     90{{{#!sh
     91$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     92$ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     93}}}
     94
     95Trac uses the `public` schema by default, but you can specify a different schema in the connection string:
    8096{{{
    8197postgres://user:pass@server/database?schema=yourschemaname
    8298}}}
    8399
    84 === MySQL Connection String ===
     100=== MySQL Connection String
    85101
    86 If you want to use MySQL instead, you'll have to use a
    87 different connection string. For example, to connect to a MySQL
    88 database on the same machine called `trac`, that allows access to the
    89 user `johndoe` with the password `letmein`, the mysql connection string is:
     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`:
    90103{{{
    91104mysql://johndoe:letmein@localhost:3306/trac
    92105}}}
    93106
    94 == Source Code Repository ==
     107=== Changing Database Backend
    95108
    96 You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
    97 which is the default), then the ''path'' where the repository is located.
     109The TracAdmin `convert_db` command allows migrating between SQLite, MySQL and PostgreSQL databases.
    98110
    99 If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
    100 (the ''type'' information doesn't matter, then).
     111[[TracAdminHelp(convert_db)]]
    101112
    102 For some systems, it is possible to specify not only the path to the repository,
    103 but also a ''scope'' within the repository. Trac will then only show information
    104 related to the files and changesets below that scope. The Subversion backend for
    105 Trac supports this; for other types, check the corresponding plugin's documentation.
     113== Deleting a Trac Environment
    106114
    107 Example of a configuration for a Subversion repository:
    108 {{{
    109 [trac]
    110 repository_type = svn
    111 repository_dir = /path/to/your/repository
     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
     117== Source Code Repository
     118
     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.
     120
     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
    112135}}}
    113136
    114 The configuration for a scoped Subversion repository would be:
    115 {{{
    116 [trac]
    117 repository_type = svn
    118 repository_dir = /path/to/your/repository/scope/within/repos
    119 }}}
     137== Directory Structure
    120138
    121 == Directory Structure ==
    122 
    123 An environment directory will usually consist of the following files and directories:
     139An environment consists of the following files and directories:
    124140
    125141 * `README` - Brief description of the environment.
    126  * `VERSION` - Contains the environment version identifier.
    127  * `attachments` - Attachments to wiki pages and tickets are stored here.
     142 * `VERSION` - Environment version identifier.
     143 * `files`
     144  * `attachments` - Attachments to wiki pages and tickets.
    128145 * `conf`
    129    * `trac.ini` - Main configuration file. See TracIni.
     146  * `trac.ini` - Main [TracIni configuration file].
    130147 * `db`
    131    * `trac.db` - The SQLite database (if you're using SQLite).
    132  * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10])
    133  * `templates` - Custom environment-specific templates.
    134    * `site_css.cs` - Custom CSS rules.
    135    * `site_footer.cs` - Custom page footer.
    136    * `site_header.cs` - Custom page header.
    137  * `wiki-macros` - Environment-specific [wiki:TracWikiMacros Wiki macros].
    138 
    139   '''Note: don't confuse a Trac environment directory with the source code repository directory.
    140 It happens that the above structure is loosely modelled after the Subversion repository directory
    141 structure, but they are not and ''must not'' be located at the same place.'''
     148  * `trac.db` - The SQLite database, if you are using SQLite.
     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.
     151 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
     152 * `templates` - Custom Genshi environment-specific templates.
     153  * `site.html` - Method to [TracInterfaceCustomization#SiteAppearance customize] the site header, footer, and style.
    142154
    143155----
    144 See also: TracAdmin, TracBackup, TracIni, TracGuide
     156See also: TracAdmin, TracBackup, TracIni