Code

Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
01/28/11 12:52:13 (3 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  [TracAdmin#initenv trac-admin's initenv]: 
    78{{{ 
    8 $ trac-admin /path/to/projectenv initenv 
     9$ trac-admin /path/to/myproject 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`trac-admin` will ask you for the name of the project and the 
     13database connection string (explained below). 
    1314 
    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.'' 
     15=== Some Useful Tips 
     16 - The user under which the web server runs will require file system write permission to  
     17 the environment directory and all the files inside. Please remember to set 
     18 the appropriate permissions. The same applies to the source code repository,  
     19 although the user under which Trac runs will only require write access to a Subversion repository created with the BDB file system; for other repository types, check the corresponding plugin's documentation.  
     20  
     21 - `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. 
    1622 
    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.  
     23 - Non-ascii environment paths are not supported 
     24  
     25 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]). 
    1826 
     27 - TracPlugins located in a [TracIni#inherit-section shared plugins folder] that is defined in an [TracIni#GlobalConfiguration inherited configuration] are currently not loaded during creation, and hence, if they need to create extra tables for example, you'll need to [TracUpgrade#UpgradetheTracEnvironment upgrade the environment] before being able to use it. 
    1928 
     29== Database Connection Strings == 
     30 
     31Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and 
     32[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary 
     33support for [http://mysql.com/ MySQL] was added in 0.10.  The default is 
     34to use SQLite, which is probably sufficient for most projects. The database 
     35file is then stored in the environment directory, and can easily be  
     36[wiki:TracBackup backed up] together with the rest of the environment. 
     37 
     38=== SQLite Connection String === 
     39The connection string for an SQLite database is: 
     40{{{ 
     41sqlite:db/trac.db 
     42}}} 
     43where `db/trac.db` is the path to the database file within the Trac environment. 
     44 
     45=== PostgreSQL Connection String === 
     46If you want to use PostgreSQL or MySQL instead, you'll have to use a 
     47different connection string. For example, to connect to a PostgreSQL 
     48database on the same machine called `trac`, that allows access to the 
     49user `johndoe` with the password `letmein`, use: 
     50{{{ 
     51postgres://johndoe:letmein@localhost/trac 
     52}}} 
     53''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.'' 
     54 
     55If PostgreSQL is running on a non-standard port (for example 9342), use: 
     56{{{ 
     57postgres://johndoe:letmein@localhost:9342/trac 
     58}}} 
     59 
     60On UNIX, you might want to select a UNIX socket for the transport, 
     61either the default socket as defined by the PGHOST environment variable: 
     62{{{ 
     63postgres://user:password@/database 
     64}}} 
     65or a specific one: 
     66{{{ 
     67postgres://user:password@/database?host=/path/to/socket/dir 
     68}}} 
     69 
     70Note that with PostgreSQL you will have to create the database before running 
     71`trac-admin initenv`. 
     72 
     73See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL]. 
     74Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`. 
     75{{{ 
     76createuser -U postgres -E -P tracuser 
     77createdb -U postgres -O tracuser -E UTF8 trac 
     78}}} 
     79When 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. 
     80 
     81Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example: 
     82{{{ 
     83sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' 
     84sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac' 
     85}}} 
     86 
     87Trac uses the `public` schema by default but you can specify a different schema in the connection string: 
     88{{{ 
     89postgres://user:pass@server/database?schema=yourschemaname 
     90}}} 
     91 
     92=== MySQL Connection String === 
     93 
     94If you want to use MySQL instead, you'll have to use a 
     95different connection string. For example, to connect to a MySQL 
     96database on the same machine called `trac`, that allows access to the 
     97user `johndoe` with the password `letmein`, the mysql connection string is: 
     98{{{ 
     99mysql://johndoe:letmein@localhost:3306/trac 
     100}}} 
     101 
     102== Source Code Repository == 
     103 
     104Since version 0.12, a single Trac environment can be connected to more than one repository. There are many different ways to connect repositories to an environment, see TracRepositoryAdmin. This page also details the various attributes that can be set for a repository (like `type`, `url`, `description`). 
     105 
     106In Trac 0.12 `trac-admin` no longer asks questions related to repositories. Therefore, by default Trac is not connected to any source code repository, and the ''Browse Source'' toolbar item will not be displayed. 
     107You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded) 
     108{{{ 
     109[components] 
     110trac.versioncontrol.* = disabled 
     111}}} 
     112 
     113For some version control systems, it is possible to specify not only the path to the repository, 
     114but also a ''scope'' within the repository. Trac will then only show information 
     115related to the files and changesets below that scope. The Subversion backend for 
     116Trac supports this; for other types, check the corresponding plugin's documentation. 
     117 
     118Example of a configuration for a Subversion repository used as the default repository: 
     119{{{ 
     120[trac] 
     121repository_type = svn 
     122repository_dir = /path/to/your/repository 
     123}}} 
     124 
     125The configuration for a scoped Subversion repository would be: 
     126{{{ 
     127[trac] 
     128repository_type = svn 
     129repository_dir = /path/to/your/repository/scope/within/repos 
     130}}} 
    20131 
    21132== 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 }}} 
    41133 
    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. 
     134An environment directory will usually consist of the following files and directories: 
     135 
     136 * `README` - Brief description of the environment. 
     137 * `VERSION` - Contains the environment version identifier. 
     138 * `attachments` - Attachments to wiki pages and tickets are stored here. 
     139 * `conf` 
     140   * `trac.ini` - Main configuration file. See TracIni. 
     141 * `db` 
     142   * `trac.db` - The SQLite database (if you're using SQLite). 
     143 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(since 0.11)''''' 
     144 * `log` - default directory for log files, if logging is turned on and a relative path is given. 
     145 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10]) 
     146 * `templates` - Custom Genshi environment-specific templates. '''''(since 0.11)''''' 
     147   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance 
     148 
     149'''Caveat:''' ''don't confuse a Trac environment directory with the source code repository directory.''  
     150 
     151This is a common beginners' mistake. 
     152It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory  
     153structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place. 
    56154 
    57155---- 
    58 See also: TracBackup, TracIni, TracGuide 
     156See also: TracAdmin, TracBackup, TracIni, TracGuide 
     157