Changes between Initial Version and Version 1 of TracEnvironment


Ignore:
Timestamp:
02/24/2006 09:48:37 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v1 v1  
     1= Trac Storage - The Environment = 
     2 
     3Trac uses a directory structure and a database for storing project data. 
     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 where your subversion 
     14repository is located. 
     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 
     19repository, although Trac will only require read access as long as you're 
     20not using the BDB file system.'' 
     21 
     22== Database Connection Strings == 
     23 
     24Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and 
     25[http://www.postgresql.org/ PostgreSQL] as database backends.  The default 
     26is to use SQLite, which is probably sufficient for most projects. The database file 
     27is then stored in the environment directory, and can easily be 
     28[wiki:TracBackup backed up] together with the rest of the environment. 
     29 
     30The connection string for an embedded SQLite database is: 
     31{{{ 
     32sqlite:db/trac.db 
     33}}} 
     34 
     35If you want to use PostgreSQL instead, you'll have to use a different 
     36connection string. For example, to connect to a database on the same 
     37machine called `trac`, that allows access to the user `johndoe` with 
     38the password `letmein`, use: 
     39{{{ 
     40postgres://johndoe:letmein@localhost/trac 
     41}}} 
     42 
     43If PostgreSQL is running on a non-standard port (for example 9342), use: 
     44{{{ 
     45postgres://johndoe:letmein@localhost:9342/trac 
     46}}} 
     47 
     48Note that with PostgreSQL you will have to create the database before running 
     49`trac-admin initenv`. 
     50 
     51== Directory Structure == 
     52 
     53An environment directory will usually consist of the following files and directories: 
     54 
     55 * `README` - Brief description of the environment. 
     56 * `VERSION` - Contains the environment version identifier. 
     57 * `attachments` - Attachments to wiki pages and tickets are stored here. 
     58 * `conf` 
     59   * `trac.ini` - Main configuration file. See TracIni. 
     60 * `db` 
     61   * `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]. 
     68 
     69---- 
     70See also: TracAdmin, TracBackup, TracIni, TracGuide