Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
05/09/10 05:59:49 (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracEnvironment

    v1 v2  
    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
    12 [wiki:TracAdmin trac-admin] will ask you for the name of the project, the
    13 database connection string (explained below), and the type and path to
    14 your source code repository.
     12[wiki:TracAdmin trac-admin] will ask you for the name of the project and the
     13database connection string (explained below).
    1514
    16 ''Note: The web server user will require file system write permission to
     15''Note: The user under which the web server runs will require file system write permission to
    1716the environment directory and all the files inside. Please remember to set
    18 the appropriate permissions. The same applies to the Subversion repository
    19 Trac is eventually using, although Trac will only require read access as long
    20 as you're not using the BDB file system.''
     17the appropriate permissions. The same applies to the source code repository,
     18although the user under which Trac runs will only require write access to a Subversion repository created with the BDB file system
     19; for other repository types, check the corresponding plugin's documentation.
     20Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]).''
     21
     22''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.''
    2123
    2224== Database Connection Strings ==
    2325
    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.
     26Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
     27[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
     28support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
     29to use SQLite, which is probably sufficient for most projects. The database
     30file is then stored in the environment directory, and can easily be
     31[wiki:TracBackup backed up] together with the rest of the environment.
    3032
    31 The connection string for an embedded SQLite database is:
     33=== SQLite Connection String ===
     34The connection string for an SQLite database is:
    3235{{{
    3336sqlite:db/trac.db
    3437}}}
     38where `db/trac.db` is the path to the database file within the Trac environment.
    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 ==
    6398
    64 You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
    65 which is the default), then the ''path'' where the repository is located.
     99Since 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`).
    66100
    67 If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
    68 (the ''type'' information doesn't matter, then).
     101In 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.
     102You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)
     103{{{
     104[components]
     105trac.versioncontrol.* = disabled
     106}}}
    69107
    70 For some systems, it is possible to specify not only the path to the repository,
     108For some version control systems, it is possible to specify not only the path to the repository,
    71109but also a ''scope'' within the repository. Trac will then only show information
    72110related to the files and changesets below that scope. The Subversion backend for
    73111Trac supports this; for other types, check the corresponding plugin's documentation.
    74112
    75 Example of a configuration for a Subversion repository:
     113Example of a configuration for a Subversion repository used as the default repository:
    76114{{{
    77115[trac]
     
    98136 * `db`
    99137   * `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].
     138 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(since 0.11)'''''
     139 * `log` - default directory for log files, if logging is turned on and a relative path is given.
     140 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10])
     141 * `templates` - Custom Genshi environment-specific templates. '''''(since 0.11)'''''
     142   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
    106143
    107   '''Note: don't confuse a Trac environment directory with the source code repository directory.
    108 It happens that the above structure is loosely modelled after the Subversion repository directory
    109 structure, but they are not and ''must not'' be located at the same place.'''
     144'''Caveat:''' ''don't confuse a Trac environment directory with the source code repository directory.''
     145
     146This is a common beginners' mistake.
     147It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory
     148structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
    110149
    111150----
    112151See also: TracAdmin, TracBackup, TracIni, TracGuide
     152