Changes between Version 2 and Version 3 of TracEnvironment


Ignore:
Timestamp:
Jun 6, 2013, 4:39:51 AM (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v2 v3  
    1 = Trac Storage - The Environment =
     1= The Trac Environment =
    22
    3 Trac uses a directory structure and a database for storing project data.
     3Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
    44
    55== Creating an Environment ==
    66
    7 A new Trac environment is created using [wiki:TracAdmin trac-admin]:
     7A new Trac environment is created using  [TracAdmin#initenv trac-admin's initenv]:
    88{{{
    9 $ trac-admin /path/to/projectenv initenv
     9$ trac-admin /path/to/myproject initenv
    1010}}}
    1111
    12 [wiki:TracAdmin trac-admin] will ask you for the name of the project, the
    13 database connection string (explained below), and where your subversion
    14 repository is located.
     12`trac-admin` will ask you for the name of the project and the
     13database connection string (explained below).
    1514
    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
    19 repository, although Trac will only require read access as long as you're
    20 not using the BDB file system.''
     15=== Some Useful Tips
     16 - The user under which the web server runs 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 source code repository,
     19 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.
     20 
     21 - `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.
     22
     23 - Non-ascii environment paths are not supported
     24 
     25 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]).
     26
     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] before being able to use it.
    2128
    2229== Database Connection Strings ==
    2330
    2431Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
    25 [http://www.postgresql.org/ PostgreSQL] as database backends.  The default
    26 is to use SQLite, which is probably sufficient for most projects. The database file
    27 is then stored in the environment directory, and can easily be
     32[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
     33support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
     34to use SQLite, which is probably sufficient for most projects. The database
     35file is then stored in the environment directory, and can easily be
    2836[wiki:TracBackup backed up] together with the rest of the environment.
    2937
    30 The connection string for an embedded SQLite database is:
     38=== SQLite Connection String ===
     39The connection string for an SQLite database is:
    3140{{{
    3241sqlite:db/trac.db
    3342}}}
     43where `db/trac.db` is the path to the database file within the Trac environment.
    3444
    35 If you want to use PostgreSQL instead, you'll have to use a different
    36 connection string. For example, to connect to a database on the same
    37 machine called `trac`, that allows access to the user `johndoe` with
    38 the password `letmein`, use:
     45=== PostgreSQL Connection String ===
     46If you want to use PostgreSQL or MySQL instead, you'll have to use a
     47different connection string. For example, to connect to a PostgreSQL
     48database on the same machine called `trac`, that allows access to the
     49user `johndoe` with the password `letmein`, use:
    3950{{{
    4051postgres://johndoe:letmein@localhost/trac
    4152}}}
     53''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    4254
    4355If PostgreSQL is running on a non-standard port (for example 9342), use:
     
    4658}}}
    4759
     60On UNIX, you might want to select a UNIX socket for the transport,
     61either the default socket as defined by the PGHOST environment variable:
     62{{{
     63postgres://user:password@/database
     64}}}
     65or a specific one:
     66{{{
     67postgres://user:password@/database?host=/path/to/socket/dir
     68}}}
     69
    4870Note that with PostgreSQL you will have to create the database before running
    4971`trac-admin initenv`.
     72
     73See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     74Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
     75{{{
     76createuser -U postgres -E -P tracuser
     77createdb -U postgres -O tracuser -E UTF8 trac
     78}}}
     79When 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.
     80
     81Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     82{{{
     83sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     84sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     85}}}
     86
     87Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     88{{{
     89postgres://user:pass@server/database?schema=yourschemaname
     90}}}
     91
     92=== MySQL Connection String ===
     93
     94If you want to use MySQL instead, you'll have to use a
     95different connection string. For example, to connect to a MySQL
     96database on the same machine called `trac`, that allows access to the
     97user `johndoe` with the password `letmein`, the mysql connection string is:
     98{{{
     99mysql://johndoe:letmein@localhost:3306/trac
     100}}}
     101
     102== Source Code Repository ==
     103
     104Since 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`).
     105
     106In 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.
     107You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)
     108{{{
     109[components]
     110trac.versioncontrol.* = disabled
     111}}}
     112
     113For some version control systems, it is possible to specify not only the path to the repository,
     114but also a ''scope'' within the repository. Trac will then only show information
     115related to the files and changesets below that scope. The Subversion backend for
     116Trac supports this; for other types, check the corresponding plugin's documentation.
     117
     118Example of a configuration for a Subversion repository used as the default repository:
     119{{{
     120[trac]
     121repository_type = svn
     122repository_dir = /path/to/your/repository
     123}}}
     124
     125The configuration for a scoped Subversion repository would be:
     126{{{
     127[trac]
     128repository_type = svn
     129repository_dir = /path/to/your/repository/scope/within/repos
     130}}}
    50131
    51132== Directory Structure ==
     
    60141 * `db`
    61142   * `trac.db` - The SQLite database (if you're using SQLite).
    62  * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs)
    63  * `templates` - Custom environment-specific templates.
    64    * `site_css.cs` - Custom CSS rules.
    65    * `site_footer.cs` - Custom page footer.
    66    * `site_header.cs` - Custom page header.
    67  * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros].
     143 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)''
     144 * `log` - default directory for log files, if logging is turned on and a relative path is given.
     145 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10])
     146 * `templates` - Custom Genshi environment-specific templates. ''(since 0.11)''
     147   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
     148
     149=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
     150
     151This is a common beginners' mistake.
     152It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory
     153structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
    68154
    69155----