Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
Jan 12, 2010 9:24:17 PM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v1 v2  
    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  [wiki:TracAdmin trac-admin]:
    88{{{
    9 $ trac-admin /path/to/projectenv initenv
     9$ trac-admin /path/to/myproject initenv
    1010}}}
    1111
    1212[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.
     13database connection string (explained below), and the type and path to
     14your source code repository.
    1515
    16   ''Note: The web server user will require file system write permission to
     16''Note: The web server user will require file system write permission to
    1717the 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.''
     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''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.''
    2124
    2225== Database Connection Strings ==
    2326
    2427Since 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
     28[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
     29support for [http://mysql.com/ 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
    2832[wiki:TracBackup backed up] together with the rest of the environment.
    2933
     34=== Embedded SQLite Connection String ===
    3035The connection string for an embedded SQLite database is:
    3136{{{
     
    3338}}}
    3439
    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:
     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:
    3945{{{
    4046postgres://johndoe:letmein@localhost/trac
    4147}}}
     48''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    4249
    4350If PostgreSQL is running on a non-standard port (for example 9342), use:
     
    4653}}}
    4754
     55On UNIX, you might want to select a UNIX socket for the transport,
     56either the default socket as defined by the PGHOST environment variable:
     57{{{
     58postgres://user:password@/database
     59}}}
     60or a specific one:
     61{{{
     62postgres://user:password@/database?host=/path/to/socket/dir
     63}}}
     64
    4865Note that with PostgreSQL you will have to create the database before running
    4966`trac-admin initenv`.
     67
     68See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     69Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
     70{{{
     71createuser -U postgres -E -P tracuser
     72createdb -U postgres -O tracuser -E UTF8 trac
     73}}}
     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.
     75
     76Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     77{{{
     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'
     80}}}
     81
     82Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     83{{{
     84postgres://user:pass@server/database?schema=yourschemaname
     85}}}
     86
     87=== MySQL Connection String ===
     88
     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:
     93{{{
     94mysql://johndoe:letmein@localhost:3306/trac
     95}}}
     96
     97== Source Code Repository ==
     98
     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.
     101
     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).
     104
     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.
     109
     110Example of a configuration for a Subversion repository:
     111{{{
     112[trac]
     113repository_type = svn
     114repository_dir = /path/to/your/repository
     115}}}
     116
     117The configuration for a scoped Subversion repository would be:
     118{{{
     119[trac]
     120repository_type = svn
     121repository_dir = /path/to/your/repository/scope/within/repos
     122}}}
    50123
    51124== Directory Structure ==
     
    60133 * `db`
    61134   * `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].
     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)''' ''
     145
     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.'''
    68149
    69150----