Changes between Initial Version and Version 1 of TracEnvironment


Ignore:
Timestamp:
06/30/10 08:21:11 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v1 v1  
     1= The Trac Environment =
     2
     3Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
     4
     5== Creating an Environment ==
     6
     7A new Trac environment is created using  [wiki:TracAdmin trac-admin]:
     8{{{
     9$ trac-admin /path/to/myproject initenv
     10}}}
     11
     12[wiki:TracAdmin trac-admin] will ask you for the name of the project, the
     13database connection string (explained below), and the type and path to
     14your source code repository.
     15
     16''Note: The web server user will require file system write permission to
     17the environment directory and all the files inside. Please remember to set
     18the appropriate permissions. The same applies to the Subversion repository
     19Trac is eventually using, although Trac will only require read access as long
     20as you're not using the BDB file system. Also, it seems that project names
     21with spaces can be problematic for authentication (see [trac:#7163]).''
     22
     23== Database Connection Strings ==
     24
     25Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
     26[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
     27support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
     28to use SQLite, which is probably sufficient for most projects. The database
     29file is then stored in the environment directory, and can easily be
     30[wiki:TracBackup backed up] together with the rest of the environment.
     31
     32=== Embedded SQLite Connection String ===
     33The connection string for an embedded SQLite database is:
     34{{{
     35sqlite:db/trac.db
     36}}}
     37
     38=== PostgreSQL Connection String ===
     39If you want to use PostgreSQL or MySQL instead, you'll have to use a
     40different connection string. For example, to connect to a PostgreSQL
     41database on the same machine called `trac`, that allows access to the
     42user `johndoe` with the password `letmein`, use:
     43{{{
     44postgres://johndoe:letmein@localhost/trac
     45}}}
     46''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
     47
     48If PostgreSQL is running on a non-standard port (for example 9342), use:
     49{{{
     50postgres://johndoe:letmein@localhost:9342/trac
     51}}}
     52
     53On UNIX, you might want to select a UNIX socket for the transport,
     54either the default socket as defined by the PGHOST environment variable:
     55{{{
     56postgres://user:password@/database
     57}}}
     58or a specific one:
     59{{{
     60postgres://user:password@/database?host=/path/to/socket/dir
     61}}}
     62
     63Note that with PostgreSQL you will have to create the database before running
     64`trac-admin initenv`.
     65
     66See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     67Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
     68{{{
     69createuser -U postgres -E -P tracuser
     70createdb -U postgres -O tracuser -E UTF8 trac
     71}}}
     72When 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.
     73
     74Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     75{{{
     76sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     77sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     78}}}
     79
     80Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     81{{{
     82postgres://user:pass@server/database?schema=yourschemaname
     83}}}
     84
     85=== MySQL Connection String ===
     86
     87If you want to use MySQL instead, you'll have to use a
     88different connection string. For example, to connect to a MySQL
     89database on the same machine called `trac`, that allows access to the
     90user `johndoe` with the password `letmein`, the mysql connection string is:
     91{{{
     92mysql://johndoe:letmein@localhost:3306/trac
     93}}}
     94
     95== Source Code Repository ==
     96
     97You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
     98which is the default), then the ''path'' where the repository is located.
     99
     100If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
     101(the ''type'' information doesn't matter, then).
     102
     103For some systems, it is possible to specify not only the path to the repository,
     104but also a ''scope'' within the repository. Trac will then only show information
     105related to the files and changesets below that scope. The Subversion backend for
     106Trac supports this; for other types, check the corresponding plugin's documentation.
     107
     108Example of a configuration for a Subversion repository:
     109{{{
     110[trac]
     111repository_type = svn
     112repository_dir = /path/to/your/repository
     113}}}
     114
     115The configuration for a scoped Subversion repository would be:
     116{{{
     117[trac]
     118repository_type = svn
     119repository_dir = /path/to/your/repository/scope/within/repos
     120}}}
     121
     122== Directory Structure ==
     123
     124An environment directory will usually consist of the following files and directories:
     125
     126 * `README` - Brief description of the environment.
     127 * `VERSION` - Contains the environment version identifier.
     128 * `attachments` - Attachments to wiki pages and tickets are stored here.
     129 * `conf`
     130   * `trac.ini` - Main configuration file. See TracIni.
     131 * `db`
     132   * `trac.db` - The SQLite database (if you're using SQLite).
     133 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(0.11 only)'''''
     134 * `log` - default directory for log files, if logging is turned on and a relative path is given.
     135 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10])
     136 * `templates` - Custom ClearSilver environment-specific templates. '''''(0.10 only)'''''
     137   * `site_css.cs` - Custom CSS rules.
     138   * `site_footer.cs` - Custom page footer.
     139   * `site_header.cs` - Custom page header.
     140 * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)'''''
     141   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
     142 * `wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''''(0.10 only)'''''
     143
     144  '''Note: don't confuse a Trac environment directory with the source code repository directory.
     145It happens that the above structure is loosely modelled after the Subversion repository directory
     146structure, but they are not and ''must not'' be located at the same place.'''
     147
     148----
     149See also: TracAdmin, TracBackup, TracIni, TracGuide