Changes from Version 1 of TracEnvironment

Show
Ignore:
Author:
trac (IP: 127.0.0.1)
Timestamp:
10/01/07 16:23:00 (10 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v0 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/projectenv 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.'' 
     21 
     22== Database Connection Strings == 
     23 
     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. 
     30 
     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(Just to remind you, if you don't have a sudo/su setup, you just need to do the createdb and psql statements. That threw me the first couple of times I read this.) 
     61 
     62== Source Code Repository == 
     63 
     64You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion, 
     65which is the default), then the ''path'' where the repository is located. 
     66 
     67If you don't want to use Trac with a source code repository, simply leave the ''path'' empty 
     68(the ''type'' information doesn't matter, then). 
     69 
     70For some systems, it is possible to specify not only the path to the repository, 
     71but also a ''scope'' within the repository. Trac will then only show information 
     72related to the files and changesets below that scope. The Subversion backend for 
     73Trac supports this; for other types, check the corresponding plugin's documentation. 
     74 
     75Example of a configuration for a Subversion repository: 
     76{{{ 
     77[trac] 
     78repository_type = svn 
     79repository_dir = /path/to/your/repository 
     80}}} 
     81 
     82The configuration for a scoped Subversion repository would be: 
     83{{{ 
     84[trac] 
     85repository_type = svn 
     86repository_dir = /path/to/your/repository/scope/within/repos 
     87}}} 
     88 
     89== Directory Structure == 
     90 
     91An environment directory will usually consist of the following files and directories: 
     92 
     93 * `README` - Brief description of the environment. 
     94 * `VERSION` - Contains the environment version identifier. 
     95 * `attachments` - Attachments to wiki pages and tickets are stored here. 
     96 * `conf` 
     97   * `trac.ini` - Main configuration file. See TracIni. 
     98 * `db` 
     99   * `trac.db` - The SQLite database (if you're using SQLite). 
     100 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs) 
     101 * `templates` - Custom environment-specific templates. 
     102   * `site_css.cs` - Custom CSS rules. 
     103   * `site_footer.cs` - Custom page footer. 
     104   * `site_header.cs` - Custom page header. 
     105 * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros]. 
     106 
     107  '''Note: don't confuse a Trac environment directory with the source code repository directory. 
     108It happens that the above structure is loosely modelled after the Subversion repository directory  
     109structure, but they are not and ''must not'' be located at the same place.''' 
     110 
     111---- 
     112See also: TracAdmin, TracBackup, TracIni, TracGuide