Changes between Version 4 and Version 5 of TracEnvironment


Ignore:
Timestamp:
Feb 26, 2008 5:40:00 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v4 v5  
    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
     
    2222== Database Connection Strings ==
    2323
    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.
     24Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
     25[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
     26support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
     27to use SQLite, which is probably sufficient for most projects. The database
     28file is then stored in the environment directory, and can easily be
     29[wiki:TracBackup backed up] together with the rest of the environment.
    3030
     31=== Embedded SQLite Connection String ===
    3132The connection string for an embedded SQLite database is:
    3233{{{
     
    3435}}}
    3536
     37=== PostgreSQL Connection String ===
    3638If you want to use PostgreSQL or MySQL instead, you'll have to use a
    3739different connection string. For example, to connect to a PostgreSQL
     
    4143postgres://johndoe:letmein@localhost/trac
    4244}}}
     45''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
    4346
    4447If PostgreSQL is running on a non-standard port (for example 9342), use:
     
    4750}}}
    4851
     52On UNIX, you might want to select a UNIX socket for the transport,
     53either the default socket as defined by the PGHOST environment variable:
     54{{{
     55postgres://user:password@/database
     56}}}
     57or a specific one:
     58{{{
     59postgres://user:password@/database?host=/path/to/socket/dir
     60}}}
     61
    4962Note that with PostgreSQL you will have to create the database before running
    5063`trac-admin initenv`.
    5164
    52 And make sure PostgreSQl DB name is "trac". What worked for me:
    53 And didn't work uppercase trac-user-name
     65See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     66Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
    5467{{{
    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';
     68createuser -U postgres -E -P tracuser
     69createdb -U postgres -O tracuser -E UTF8 trac
     70}}}
     71When 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.
     72
     73Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     74{{{
     75sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     76sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
    5877}}}
    5978
    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.)
     79Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     80{{{
     81postgres://user:pass@server/database?schema=yourschemaname
     82}}}
     83
     84=== MySQL Connection String ===
     85
     86If you want to use MySQL instead, you'll have to use a
     87different connection string. For example, to connect to a MySQL
     88database on the same machine called `trac`, that allows access to the
     89user `johndoe` with the password `letmein`, the mysql connection string is:
     90{{{
     91mysql://johndoe:letmein@localhost:3306/trac
     92}}}
    6193
    6294== Source Code Repository ==
     
    98130 * `db`
    99131   * `trac.db` - The SQLite database (if you're using SQLite).
    100  * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs)
     132 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10])
    101133 * `templates` - Custom environment-specific templates.
    102134   * `site_css.cs` - Custom CSS rules.
    103135   * `site_footer.cs` - Custom page footer.
    104136   * `site_header.cs` - Custom page header.
    105  * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros].
     137 * `wiki-macros` - Environment-specific [wiki:TracWikiMacros Wiki macros].
    106138
    107139  '''Note: don't confuse a Trac environment directory with the source code repository directory.