Changes between Initial Version and Version 1 of TracEnvironment

26/01/11 00:10:25 (12 years ago)



  • TracEnvironment

    v1 v1  
     1= The Trac Environment =
     3Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
     5== Creating an Environment ==
     7A new Trac environment is created using  [wiki:TracAdmin trac-admin]:
     9$ trac-admin /path/to/myproject initenv
     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.
     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]).''
     23''Note: "initenv" when using 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.''
     25== Database Connection Strings ==
     27Since version 0.9, Trac supports both [ SQLite] and
     28[ PostgreSQL] database backends.  Preliminary
     29support for [ MySQL] was added in 0.10.  The default is
     30to use SQLite, which is probably sufficient for most projects. The database
     31file is then stored in the environment directory, and can easily be
     32[wiki:TracBackup backed up] together with the rest of the environment.
     34=== Embedded SQLite Connection String ===
     35The connection string for an embedded SQLite database is:
     40=== PostgreSQL Connection String ===
     41If you want to use PostgreSQL or MySQL instead, you'll have to use a
     42different connection string. For example, to connect to a PostgreSQL
     43database on the same machine called `trac`, that allows access to the
     44user `johndoe` with the password `letmein`, use:
     48''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
     50If PostgreSQL is running on a non-standard port (for example 9342), use:
     55On UNIX, you might want to select a UNIX socket for the transport,
     56either the default socket as defined by the PGHOST environment variable:
     60or a specific one:
     65Note that with PostgreSQL you will have to create the database before running
     66`trac-admin initenv`.
     68See the [ PostgreSQL documentation] for detailed instructions on how to administer [ PostgreSQL].
     69Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
     71createuser -U postgres -E -P tracuser
     72createdb -U postgres -O tracuser -E UTF8 trac
     74When 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.
     76Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     78sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     79sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     82Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     87=== MySQL Connection String ===
     89If you want to use MySQL instead, you'll have to use a
     90different connection string. For example, to connect to a MySQL
     91database on the same machine called `trac`, that allows access to the
     92user `johndoe` with the password `letmein`, the mysql connection string is:
     97== Source Code Repository ==
     99You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
     100which is the default), then the ''path'' where the repository is located.
     102If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
     103(the ''type'' information doesn't matter, then).
     105For some systems, it is possible to specify not only the path to the repository,
     106but also a ''scope'' within the repository. Trac will then only show information
     107related to the files and changesets below that scope. The Subversion backend for
     108Trac supports this; for other types, check the corresponding plugin's documentation.
     110Example of a configuration for a Subversion repository:
     113repository_type = svn
     114repository_dir = /path/to/your/repository
     117The configuration for a scoped Subversion repository would be:
     120repository_type = svn
     121repository_dir = /path/to/your/repository/scope/within/repos
     124== Directory Structure ==
     126An environment directory will usually consist of the following files and directories:
     128 * `README` - Brief description of the environment.
     129 * `VERSION` - Contains the environment version identifier.
     130 * `attachments` - Attachments to wiki pages and tickets are stored here.
     131 * `conf`
     132   * `trac.ini` - Main configuration file. See TracIni.
     133 * `db`
     134   * `trac.db` - The SQLite database (if you're using SQLite).
     135 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(0.11 only)'''''
     136 * `log` - default directory for log files, if logging is turned on and a relative path is given.
     137 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [trac:milestone:0.10 0.10])
     138 * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)'''''
     139   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
     140 * ''`templates` - Custom [trac:ClearSilver ClearSilver] environment-specific templates. '''(0.10 only)''' ''
     141   * ''`site_css.cs` - Custom CSS rules.''
     142   * ''`site_footer.cs` - Custom page footer.''
     143   * ''`site_header.cs` - Custom page header.''
     144 * ''`wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''(0.10 only)''' ''
     146  '''Note: don't confuse a Trac environment directory with the source code repository directory.
     147It happens that the above structure is loosely modelled after the Subversion repository directory
     148structure, but they are not and ''must not'' be located at the same place.'''
     151See also: TracAdmin, TracBackup, TracIni, TracGuide