Changes between Version 2 and Version 3 of TracEnvironment

Jan 30, 2009, 2:03:57 PM (8 years ago)



  • TracEnvironment

    v2 v3  
    55== Creating an Environment ==
    7 A new Trac environment is created using [wiki:TracAdmin trac-admin]:
     7A new Trac environment is created using  [wiki:TracAdmin trac-admin]:
    9 $ trac-admin /path/to/projectenv initenv
     9$ trac-admin /path/to/myproject initenv
    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]).''
    2223== Database Connection Strings ==
    24 Since version 0.9, Trac supports both [ SQLite],
    25 [ PostgreSQL] and [ 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.
     25Since version 0.9, Trac supports both [ SQLite] and
     26[ PostgreSQL] database backends.  Preliminary
     27support for [ MySQL] was added in 0.10.  The default is
     28to use SQLite, which is probably sufficient for most projects. The database
     29file is then stored in the environment directory, and can easily be
     30[wiki:TracBackup backed up] together with the rest of the environment.
     32=== Embedded SQLite Connection String ===
    3133The connection string for an embedded SQLite database is:
     38=== PostgreSQL Connection String ===
    3639If you want to use PostgreSQL or MySQL instead, you'll have to use a
    3740different connection string. For example, to connect to a PostgreSQL
     46''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    4448If PostgreSQL is running on a non-standard port (for example 9342), use:
     53On UNIX, you might want to select a UNIX socket for the transport,
     54either the default socket as defined by the PGHOST environment variable:
     58or a specific one:
    4963Note that with PostgreSQL you will have to create the database before running
    5064`trac-admin initenv`.
    52 And make sure PostgreSQl DB name is "trac". What worked for me:
    53 And didn't work uppercase trac-user-name
     66See the [ PostgreSQL documentation] for detailed instructions on how to administer [ PostgreSQL].
     67Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
    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';
     69createuser -U postgres -E -P tracuser
     70createdb -U postgres -O tracuser -E UTF8 trac
     72When 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.
     74Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     76sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     77sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
    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.)
     80Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     85=== MySQL Connection String ===
     87If you want to use MySQL instead, you'll have to use a
     88different connection string. For example, to connect to a MySQL
     89database on the same machine called `trac`, that allows access to the
     90user `johndoe` with the password `letmein`, the mysql connection string is:
    6295== Source Code Repository ==
    98131 * `db`
    99132   * `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.
     133 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(0.11 only)'''''
     134 * `log` - default directory for log files, if logging is turned on and a relative path is given.
     135 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10])
     136 * `templates` - Custom ClearSilver environment-specific templates. '''''(0.10 only)'''''
    102137   * `site_css.cs` - Custom CSS rules.
    103138   * `site_footer.cs` - Custom page footer.
    104139   * `site_header.cs` - Custom page header.
    105  * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros].
     140 * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)'''''
     141   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
     142 * `wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''''(0.10 only)'''''
    107144  '''Note: don't confuse a Trac environment directory with the source code repository directory.