Changes between Version 3 and Version 4 of TracEnvironment


Ignore:
Timestamp:
11/06/10 11:32:42 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v3 v4  
    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 
     
    1818the appropriate permissions. The same applies to the Subversion repository  
    1919Trac is eventually using, although Trac will only require read access as long  
    20 as you're not using the BDB file system.'' 
     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 
    24 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite], 
    25 [http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] as 
    26 database backends.  The default is to use SQLite, which is probably sufficient 
    27 for most projects. The database file is then stored in the environment 
    28 directory, and can easily be [wiki:TracBackup backed up] together with the 
    29 rest of the environment. 
     27Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and 
     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  
     32[wiki:TracBackup backed up] together with the rest of the environment. 
    3033 
     34=== Embedded SQLite Connection String === 
    3135The connection string for an embedded SQLite database is: 
    3236{{{ 
     
    3438}}} 
    3539 
     40=== PostgreSQL Connection String === 
    3641If you want to use PostgreSQL or MySQL instead, you'll have to use a 
    3742different connection string. For example, to connect to a PostgreSQL 
     
    4146postgres://johndoe:letmein@localhost/trac 
    4247}}} 
     48''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.'' 
    4349 
    4450If PostgreSQL is running on a non-standard port (for example 9342), use: 
     
    4753}}} 
    4854 
     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 
    4965Note that with PostgreSQL you will have to create the database before running 
    5066`trac-admin initenv`. 
    5167 
    52 And make sure PostgreSQl DB name is "trac". What worked for me: 
    53 And didn't work uppercase trac-user-name 
     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`. 
    5470{{{ 
    55 sudo su - postgres -c createdb trac 
    56 sudo su - postgres -c psql trac 
    57 CREATE USER trac-user-name WITH PASSWORD 'trac-pass-name'; 
     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' 
    5880}}} 
    5981 
    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.) 
     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}}} 
    6196 
    6297== Source Code Repository == 
     
    98133 * `db` 
    99134   * `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]. 
     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)''' '' 
    106145 
    107146  '''Note: don't confuse a Trac environment directory with the source code repository directory.