Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
09/26/06 13:01:24 (18 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v1 v2  
    1 = Trac Storage - The Environment = 
    2 Trac uses a directory structure and an embedded [http://www.sqlite.org/ SQLite] database as storage. 
     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”. 
    34 
    45== Creating an Environment == 
    5 A new Trac environment is created using [wiki:TracAdmin trac-admin], like: 
    66 
     7A new Trac environment is created using [wiki:TracAdmin trac-admin]: 
    78{{{ 
    89$ trac-admin /path/to/projectenv initenv 
    910}}} 
    1011 
    11 [wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and 
    12 where it can find the trac templates directory (the default value should work for a typical install). 
     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. 
    1315 
    14 '''Note:''' The web server user will require file system write permission to the environment 
    15 directory and all the files inside. '''Remember to set the appropriate permissions.'' 
     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.'' 
    1621 
    17 The same applies for the subversion repository files (unless using the [http://svn.collab.net/repos/svn/trunk/notes/fsfs FSFS Subversion backend], something we highly recommend.  
     22== Database Connection Strings == 
    1823 
     24Since version 0.9, Trac supports both [http://sqlite.org/ SQLite], 
     25[http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] as 
     26database backends.  The default is to use SQLite, which is probably sufficient 
     27for most projects. The database file is then stored in the environment 
     28directory, and can easily be [wiki:TracBackup backed up] together with the 
     29rest of the environment. 
    1930 
     31The connection string for an embedded SQLite database is: 
     32{{{ 
     33sqlite:db/trac.db 
     34}}} 
     35 
     36If you want to use PostgreSQL or MySQL instead, you'll have to use a 
     37different connection string. For example, to connect to a PostgreSQL 
     38database on the same machine called `trac`, that allows access to the 
     39user `johndoe` with the password `letmein`, use: 
     40{{{ 
     41postgres://johndoe:letmein@localhost/trac 
     42}}} 
     43 
     44If PostgreSQL is running on a non-standard port (for example 9342), use: 
     45{{{ 
     46postgres://johndoe:letmein@localhost:9342/trac 
     47}}} 
     48 
     49Note that with PostgreSQL you will have to create the database before running 
     50`trac-admin initenv`. 
     51 
     52And make sure PostgreSQl DB name is "trac". What worked for me: 
     53And didn't work uppercase trac-user-name 
     54{{{ 
     55sudo su - postgres -c createdb trac 
     56sudo su - postgres -c psql trac 
     57CREATE USER trac-user-name WITH PASSWORD 'trac-pass-name'; 
     58}}} 
     59 
     60== Source Code Repository == 
     61 
     62You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion, 
     63which is the default), then the ''path'' where the repository is located. 
     64 
     65If you don't want to use Trac with a source code repository, simply leave the ''path'' empty 
     66(the ''type'' information doesn't matter, then). 
     67 
     68For some systems, it is possible to specify not only the path to the repository, 
     69but also a ''scope'' within the repository. Trac will then only show information 
     70related to the files and changesets below that scope. The Subversion backend for 
     71Trac supports this; for other types, check the corresponding plugin's documentation. 
     72 
     73Example of a configuration for a Subversion repository: 
     74{{{ 
     75[trac] 
     76repository_type = svn 
     77repository_dir = /path/to/your/repository 
     78}}} 
     79 
     80The configuration for a scoped Subversion repository would be: 
     81{{{ 
     82[trac] 
     83repository_type = svn 
     84repository_dir = /path/to/your/repository/scope/within/repos 
     85}}} 
    2086 
    2187== Directory Structure == 
    22 {{{ 
    23  EnvDir 
    24    |-- README 
    25    |-- VERSION 
    26    |-- attachments 
    27    |   |-- ticket 
    28    |   `-- wiki 
    29    |-- conf 
    30    |   `-- trac.ini 
    31    |-- db 
    32    |   `-- trac.db 
    33    |-- log 
    34    |   `-- trac.log 
    35    |-- templates 
    36    |   |-- site_css.cs 
    37    |   |-- site_footer.cs 
    38    |   `-- site_header.cs 
    39    `-- wiki-macros 
    40 }}} 
    4188 
    42  * '''README''' - Brief description of the environment. 
    43  * '''VERSION''' - Contains the environment version identifier. 
    44  * '''attachments''' - All attached files go in here. 
    45    * '''ticket''' - Ticket attachments. 
    46    * '''wiki''' - Wiki attachments. 
    47  * '''conf''' 
    48    * '''trac.ini''' - Main configuration file. See TracIni. 
    49  * '''db''' 
    50    * '''trac.db''' - SQLite database. 
    51  * '''templates''' - Custom (environment-specific) templates. 
    52    * '''site_css.cs''' - Custom CSS stylesheet. 
    53    * '''site_footer.cs''' - Custom footer. 
    54    * '''site_header.cs''' - Custom header. 
    55  * '''wiki-macros''' - Environment-specific WikiMacros. 
     89An environment directory will usually consist of the following files and directories: 
     90 
     91 * `README` - Brief description of the environment. 
     92 * `VERSION` - Contains the environment version identifier. 
     93 * `attachments` - Attachments to wiki pages and tickets are stored here. 
     94 * `conf` 
     95   * `trac.ini` - Main configuration file. See TracIni. 
     96 * `db` 
     97   * `trac.db` - The SQLite database (if you're using SQLite). 
     98 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs) 
     99 * `templates` - Custom environment-specific templates. 
     100   * `site_css.cs` - Custom CSS rules. 
     101   * `site_footer.cs` - Custom page footer. 
     102   * `site_header.cs` - Custom page header. 
     103 * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros]. 
     104 
     105  '''Note: don't confuse a Trac environment directory with the source code repository directory. 
     106It happens that the above structure is loosely modelled after the Subversion repository directory  
     107structure, but they are not and ''must not'' be located at the same place.''' 
    56108 
    57109---- 
    58 See also: TracBackup, TracIni, TracGuide 
     110See also: TracAdmin, TracBackup, TracIni, TracGuide