Changes between Version 3 and Version 4 of TracEnvironment

Timestamp:

Jul 17, 2018, 2:12:25 PM (6 years ago)

Author:

trac

Comment:

--

TracEnvironment

@@ -1 @@
-= The Trac Environment =
+= The Trac Environment
 
-Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
+[[TracGuideToc]]
+[[PageOutline(2-5,Contents,pullout)]]
 
-== Creating an Environment ==
+Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
 
-A new Trac environment is created using  [TracAdmin#initenv trac-admin's initenv]:
-{{{
+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`.
+
+== Creating an Environment
+
+A new Trac environment is created using the [TracAdmin#initenv initenv] command:
+{{{#!sh
 $ trac-admin /path/to/myproject initenv
 }}}
 
-`trac-admin` will ask you for the name of the project and the
-database connection string (explained below).
+`trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
 
-=== Some Useful Tips
- - 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. 
+=== Useful Tips
+
+ - 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.
+
+ - 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. 
  
- - `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.
+ - `initenv` does not create a version control repository for the specified path. If you wish to specify a default repository using the optional 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//.
 
- - Non-ascii environment paths are not supported
- 
- - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]).
+ - Non-ascii environment paths are not supported.
 
- - 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.
+ - 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 in the inherited configuration, or in a configuration file using the `--config` option. See TracAdmin#FullCommandReference for more information.
 
-== Database Connection Strings ==
+{{{#!div style="border: 1pt dotted; margin: 1em;"
+**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
 
-Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
-[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
-support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
-to use 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.
+This is a common beginners' mistake.
+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.
+}}}
 
-=== SQLite Connection String ===
+== Database Connection Strings
+
+You 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.
+
+Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be [http://meyerweb.com/eric/tools/dencoder/ URL encoded].
+{{{#!sh
+$ python -c "import urllib; print urllib.quote('password@:/123', '')"
+password%40%3A%2F123
+}}}
+
+=== SQLite Connection String
+
 The connection string for an SQLite database is:
 {{{
@@ -43 +54 @@
 where `db/trac.db` is the path to the database file within the Trac environment.
 
-=== PostgreSQL Connection String ===
-If you want to use PostgreSQL or MySQL instead, you'll have to use a
-different connection string. For example, to connect to a PostgreSQL
-database on the same machine called `trac`, that allows access to the
-user `johndoe` with the password `letmein`, use:
+=== PostgreSQL Connection String
+
+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:
 {{{
 postgres://johndoe:letmein@localhost/trac
 }}}
-''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
 
-If PostgreSQL is running on a non-standard port (for example 9342), use:
+If PostgreSQL is running on a non-standard port, for example 9342, use:
 {{{
 postgres://johndoe:letmein@localhost:9342/trac
 }}}
 
-On UNIX, you might want to select a UNIX socket for the transport,
-either the default socket as defined by the PGHOST environment variable:
+On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
 {{{
 postgres://user:password@/database
 }}}
+
 or a specific one:
 {{{
@@ -68 +76 @@
 }}}
 
-Note that with PostgreSQL you will have to create the database before running
-`trac-admin initenv`.
-
 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
-Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
-{{{
-createuser -U postgres -E -P tracuser
-createdb -U postgres -O tracuser -E UTF8 trac
-}}}
-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.
-
-Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
-{{{
-sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
-sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
+Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
+{{{#!sh
+$ createuser -U postgres -E -P tracuser
+$ createdb -U postgres -O tracuser -E UTF8 trac
 }}}
 
-Trac uses the `public` schema by default but you can specify a different schema in the connection string:
+When 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.
+
+Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
+{{{#!sh
+$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
+$ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
+}}}
+
+Trac uses the `public` schema by default, but you can specify a different schema in the connection string:
 {{{
 postgres://user:pass@server/database?schema=yourschemaname
 }}}
 
-=== MySQL Connection String ===
+=== MySQL Connection String
 
-If you want to use MySQL instead, you'll have to use a
-different connection string. For example, to connect to a MySQL
-database on the same machine called `trac`, that allows access to the
-user `johndoe` with the password `letmein`, the mysql connection string is:
+The 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`:
 {{{
 mysql://johndoe:letmein@localhost:3306/trac
 }}}
 
-== Source Code Repository ==
+== Source Code Repository
 
-Since version 0.12, a single Trac 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 (like `type`, `url`, `description`).
+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.
 
-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.
-You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)
-{{{
-[components]
-trac.versioncontrol.* = disabled
-}}}
+There are several 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.
 
-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.
+== Directory Structure
 
-Example of a configuration for a Subversion repository used as the default repository:
-{{{
-[trac]
-repository_type = svn
-repository_dir = /path/to/your/repository
-}}}
-
-The configuration for a scoped Subversion repository would be:
-{{{
-[trac]
-repository_type = svn
-repository_dir = /path/to/your/repository/scope/within/repos
-}}}
-
-== Directory Structure ==
-
-An environment directory will usually consist of the following files and directories:
+An environment consists of the following files and directories:
 
  * `README` - Brief description of the environment.
- * `VERSION` - Contains the environment version identifier.
- * `attachments` - Attachments to wiki pages and tickets are stored here.
+ * `VERSION` - Environment version identifier.
+ * `files`
+  * `attachments` - Attachments to wiki pages and tickets.
  * `conf`
-   * `trac.ini` - Main configuration file. See TracIni.
+  * `trac.ini` - Main [TracIni configuration file].
  * `db`
-   * `trac.db` - The SQLite database (if you're using SQLite).
- * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)''
- * `log` - default directory for log files, if logging is turned on and a relative path is given.
- * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10])
- * `templates` - Custom Genshi environment-specific templates. ''(since 0.11)''
-   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
-
-=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
-
-This is a common beginners' mistake.
-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.
+  * `trac.db` - The SQLite database, if you are using SQLite.
+ * `htdocs` - Directory containing web resources, which can be referenced in templates using the path `/chrome/site/...`.
+ * `log` - Default directory for log files when `file` logging is enabled and a relative path is given.
+ * `plugins` - Environment-specific [wiki:TracPlugins plugins].
+ * `templates` - Custom Genshi environment-specific templates.
+  * `site.html` - Method to [TracInterfaceCustomization#SiteAppearance customize] the site header, footer, and style.
 
 ----
-See also: TracAdmin, TracBackup, TracIni, TracGuide
+See also: TracAdmin, TracBackup, TracIni