Changes between Version 1 and Version 2 of TracEnvironment


Ignore:
Timestamp:
Feb 7, 2016, 1:07:44 AM (22 months 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  [TracAdmin#initenv trac-admin's initenv]:
    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`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
    17 the 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.''
     15=== Some Useful Tips
     16
     17 - Place your environment's directory on a filesystem which supports sub-second timestamps, as Trac monitors the timestamp of its configuration files and changes happening on a filesystem with too coarse-grained timestamp resolution may go undetected in Trac < 1.0.2 (this is also true for the location of authentication files when using TracStandalone).
     18
     19 - The user under which the web server runs will require file system write permission to
     20 the environment directory and all the files inside. Please remember to set
     21 the appropriate permissions. The same applies to the source code repository,
     22 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.
     23 
     24 - `initenv`, when using an 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.
     25
     26 - Non-ascii environment paths are not supported
     27 
     28 - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]).
     29
     30 - 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.
    2131
    2232== Database Connection Strings ==
    2333
    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.
     34Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
     35[http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
     36support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
     37to use SQLite, which is probably sufficient for most projects. The database
     38file is then stored in the environment directory, and can easily be
     39[wiki:TracBackup backed up] together with the rest of the environment.
    3040
    31 The connection string for an embedded SQLite database is:
     41Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     42
     43=== SQLite Connection String ===
     44The connection string for an SQLite database is:
    3245{{{
    3346sqlite:db/trac.db
    3447}}}
     48where `db/trac.db` is the path to the database file within the Trac environment.
    3549
     50=== PostgreSQL Connection String ===
    3651If you want to use PostgreSQL or MySQL instead, you'll have to use a
    3752different connection string. For example, to connect to a PostgreSQL
     
    4762}}}
    4863
     64On UNIX, you might want to select a UNIX socket for the transport,
     65either the default socket as defined by the PGHOST environment variable:
     66{{{
     67postgres://user:password@/database
     68}}}
     69or a specific one:
     70{{{
     71postgres://user:password@/database?host=/path/to/socket/dir
     72}}}
     73
    4974Note that with PostgreSQL you will have to create the database before running
    5075`trac-admin initenv`.
    5176
    52 And make sure PostgreSQl DB name is "trac". What worked for me:
    53 And didn't work uppercase trac-user-name
     77See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     78Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
    5479{{{
    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';
     80createuser -U postgres -E -P tracuser
     81createdb -U postgres -O tracuser -E UTF8 trac
     82}}}
     83When 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.
     84
     85Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
     86{{{
     87sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     88sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
     89}}}
     90
     91Trac uses the `public` schema by default but you can specify a different schema in the connection string:
     92{{{
     93postgres://user:pass@server/database?schema=yourschemaname
     94}}}
     95
     96=== MySQL Connection String ===
     97
     98The format of the MySQL connection string is similar to the examples presented for PostgreSQL, with the `postgres` schema being replaced by `mysql`. For example, to connect to a MySQL
     99database on the same machine called `trac`, allowing access to the
     100user `johndoe` with the password `letmein`, the mysql connection string is:
     101{{{
     102mysql://johndoe:letmein@localhost:3306/trac
    58103}}}
    59104
    60105== Source Code Repository ==
    61106
    62 You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
    63 which is the default), then the ''path'' where the repository is located.
     107Since 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`).
    64108
    65 If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
    66 (the ''type'' information doesn't matter, then).
     109In 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.
     110You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)
     111{{{
     112[components]
     113trac.versioncontrol.* = disabled
     114}}}
    67115
    68 For some systems, it is possible to specify not only the path to the repository,
     116For some version control systems, it is possible to specify not only the path to the repository,
    69117but also a ''scope'' within the repository. Trac will then only show information
    70118related to the files and changesets below that scope. The Subversion backend for
    71119Trac supports this; for other types, check the corresponding plugin's documentation.
    72120
    73 Example of a configuration for a Subversion repository:
     121Example of a configuration for a Subversion repository used as the default repository:
    74122{{{
    75123[trac]
     
    96144 * `db`
    97145   * `trac.db` - The SQLite database (if you're using SQLite).
    98  * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs)
    99  * `templates` - Custom environment-specific templates.
    100    * `site_css.cs` - Custom CSS rules.
    101    * `site_footer.cs` - Custom page footer.
    102    * `site_header.cs` - Custom page header.
    103  * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros].
     146 * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)''
     147 * `log` - default directory for log files, if logging is turned on and a relative path is given.
     148 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10])
     149 * `templates` - Custom Genshi environment-specific templates. ''(since 0.11)''
     150   * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
    104151
    105   '''Note: don't confuse a Trac environment directory with the source code repository directory.
    106 It happens that the above structure is loosely modelled after the Subversion repository directory
    107 structure, but they are not and ''must not'' be located at the same place.'''
     152=== Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat
     153
     154This is a common beginners' mistake.
     155It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory
     156structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place.
    108157
    109158----