Last change on this file since 28798 was 26484, checked in by obi, 6 years ago

File size: 13.5 KB
Line
2[[PageOutline(2-3)]]
3
4== Quick start == #QuickStart
5
6 * Manage repositories in the "Repository" admin panel, with trac-admin or in the [repositories] section of [wiki:TracIni#repositories-section trac.ini].
7 * Set up a call to trac-admin $ENV changeset added$REPO $REV in the post-commit hook of each repository. Additionally, add a call to trac-admin$ENV changeset modified $REPO$REV in the post-revprop-change hook of repositories allowing revision property changes.
8 * Set the [trac] repository_sync_per_request option to an empty value to disable per-request syncing.
9 * Make sure the user under which your Subversion hooks are run has write access to the Trac environment, or use a tool like sudo to temporarily elevate privileges.
10
11== Specifying repositories == #Repositories
12Starting with 0.12, Trac can handle more than one repository per environment. The pre-0.12 way of specifying the repository with the repository_dir and repository_type options in the [trac] section of [wiki:TracIni trac.ini] is still supported, but two new mechanisms allow including additional repositories into an environment.
13
14It is also possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking all the links to the old name.
15
16A number of attributes can be associated with each repository, which define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported:
17
18||='''Attribute''' =||='''Description''' =||
19||alias ||\
20||A repository having an alias attribute is an alias to a real repository. All TracLinks referencing the alias resolve to the aliased repository. Note that multiple indirection is not supported, so an alias must always point to a real repository. The alias and dir attributes are mutually exclusive. ||
21||description ||\
22||The text specified in the description attribute is displayed below the top-level entry for the repository in the source browser. It supports WikiFormatting. ||
23||dir ||\
24||The dir attribute specifies the location of the repository in the filesystem. It corresponds to the value previously specified in the option [trac] repository_dir. The alias and dir attributes are mutually exclusive. ||
25||hidden ||When set to true, the repository is hidden from the repository index page in the source browser. Browsing the repository is still possible, and links referencing the repository remain valid. ||
26||type ||The type attribute sets the type of version control system used by the repository. Trac supports Subversion and Git out-of-the-box, and plugins add support for many other systems. If type is not specified, it defaults to the value of the [trac] repository_type option. ||
27||url ||The url attribute specifies the root URL to be used for checking out from the repository. When specified, a "Repository URL" link is added to the context navigation links in the source browser, that can be copied into the tool used for creating the working copy. ||
28
29A repository name and one of alias or dir attributes are mandatory. All others are optional.
30
31After adding a repository, the cache for that repository must be re-synchronized once with the trac-admin $ENV repository resync command. 32 33 repository resync <repos>:: 34 Re-synchronize Trac with a repository. 35 36 37=== In trac.ini === #ReposTracIni 38Repositories and repository attributes can be specified in the [repositories] section of [wiki:TracIni#repositories-section trac.ini]. Every attribute consists of a key structured as {name}.{attribute} and the corresponding value separated with an equal sign (=). The name of the default repository is empty. 39 40The main advantage of specifying repositories in trac.ini is that they can be inherited from a global configuration (see the [wiki:TracIni#GlobalConfiguration global configuration] section of TracIni). One drawback is that, due to limitations in the ConfigParser class used to parse trac.ini, the repository name is always all-lowercase. 41 42The following example defines two Subversion repositories named project and lib, and an alias to project as the default repository. This is a typical use case where a Trac environment previously had a single repository (the project repository), and was converted to multiple repositories. The alias ensures that links predating the change continue to resolve to the project repository. 43{{{ 44#!ini 45[repositories] 46project.dir = /var/repos/project 47project.description = This is the ''main'' project repository. 48project.type = svn 49project.url = http://example.com/svn/project 50project.hidden = true 51 52lib.dir = /var/repos/lib 53lib.description = This is the secondary library code. 54lib.type = svn 55lib.url = http://example.com/svn/lib 56 57.alias = project 58}}} 59Note that name.alias = target makes name an alias for the target repo, not the other way around. 60 61=== In the database === #ReposDatabase 62Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the trac-admin$ENV repository commands.
63
64The admin panel shows the list of all repositories defined in the Trac environment. It allows adding repositories and aliases, editing repository attributes and removing repositories. Note that repositories defined in trac.ini are displayed but cannot be edited.
65
66The following [wiki:TracAdmin trac-admin] commands can be used to perform repository operations from the command line.
67
68 repository add <repos> <dir> [type]::
69   Add a repository <repos> located at <dir>, and optionally specify its type.
70
71 repository alias <name> <target>::
72   Create an alias <name> for the repository <target>.
73
74 repository remove <repos>::
75   Remove the repository <repos>.
76
77 repository set <repos> <key> <value>::
78   Set the attribute <key> to <value> for the repository <repos>.
79
80Note that the default repository has an empty name, so it will likely need to be quoted when running trac-admin from a shell. Alternatively, the name "(default)" can be used instead, for example when running trac-admin in interactive mode.
81
82
83== Repository synchronization == #Synchronization
84Prior to 0.12, Trac synchronized its cache with the repository on every HTTP request. This approach is not very efficient and not practical anymore with multiple repositories. For this reason, explicit synchronization through post-commit hooks was added.
85
86There is also new functionality in the form of a repository listener extension point ''(IRepositoryChangeListener)'' that is triggered by the post-commit hook when a changeset is added or modified, and can be used by plugins to perform actions on commit.
87
88=== Mercurial Repositories ===
89Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.
90
91=== Explicit synchronization === #ExplicitSync
92This is the preferred method of repository synchronization. It requires setting the [trac]  repository_sync_per_request option in [wiki:TracIni#trac-section trac.ini] to an empty value, and adding a call to trac-admin in the post-commit hook of each repository. Additionally, if a repository allows changing revision metadata, a call to trac-admin must be added to the post-revprop-change hook as well.
93
94 changeset added <repos> <rev> [...]::
95   Notify Trac that one or more changesets have been added to a repository.
96
97 changeset modified <repos> <rev> [...]::
98   Notify Trac that metadata on one or more changesets in a repository has been modified.
99
100The <repos> argument can be either a repository name (use "(default)" for the default repository) or the path to the repository.
101
102Note that you may have to set the environment variable PYTHON_EGG_CACHE to the same value as was used for the web server configuration before calling trac-admin, if you changed it from its default location. See [wiki:TracPlugins Trac Plugins] for more information.
103
104The following examples are complete post-commit and post-revprop-change scripts for Subversion. They should be edited for the specific environment, marked executable (where applicable) and placed in the hooks directory of each repository. On Unix (post-commit):
105{{{#!sh
106#!/bin/sh
107export PYTHON_EGG_CACHE="/path/to/dir"
108/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
109}}}
110Note: Ubuntu doesn't seem to like /usr/bin/trac-admin, so just use:
111{{{#!sh
112#!/bin/sh
113export PYTHON_EGG_CACHE="/path/to/dir"
114trac-admin /path/to/env/ changeset added "$1" "$2"
115}}}
116On Windows (post-commit.cmd):
117{{{#!application/x-dos-batch
119}}}
120
121The post-revprop-change hook for Subversion is very similar. On Unix (post-revprop-change):
122{{{#!sh
123#!/bin/sh
124export PYTHON_EGG_CACHE="/path/to/dir"
125/usr/bin/trac-admin /path/to/env changeset modified "$1" "$2"
126}}}
127On Windows (post-revprop-change.cmd):
128{{{#!application/x-dos-batch
129@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
130}}}
131
132The Unix variants above assume that the user running the Subversion commit has write access to the Trac environment, which is the case in the standard configuration where both the repository and Trac are served by the web server. If you access the repository through another means, for example svn+ssh://, you may have to run trac-admin with different privileges, for example by using sudo.
133
134Note that calling trac-admin in your Subversion hooks can slow down the commit and log editing operations on the client side. You might want to use the [trac:source:trunk/contrib/trac-svn-hook contrib/trac-svn-hook] script which starts trac-admin in an asynchronous way. The script also comes with a number of safety checks and usage advices which should make it easier to set up and test your hooks. There's no equivalent trac-svn-hook.bat for Windows yet, but the script can be run by Cygwin's bash.
135
137
138Git hooks can be used in the same way for explicit syncing of git repositories. Add the following to .git/hooks/post-commit:
139{{{#!sh
140REV=$(git rev-parse HEAD) 141trac-admin /path/to/env changeset added <my-repository>$REV
142}}}
143
144For Mercurial, add the following entries to the .hgrc file of each repository accessed by Trac (if [trac:TracMercurial] is installed in a Trac plugins directory, download [trac:source:mercurial-plugin/tracext/hg/hooks.py hooks.py] and place it somewhere accessible):
145{{{#!ini
146[hooks]
147; If mercurial-plugin is installed globally
150
151; If mercurial-plugin is installed in a Trac plugins directory
154
155[trac]
156env = /path/to/env
158}}}
159
160=== Per-request synchronization === #PerRequestSync
161If the post-commit hooks are not available, the environment can be set up for per-request synchronization. In that case, the [trac] repository_sync_per_request option in [wiki:TracIni#trac-section trac.ini] must be set to a comma-separated list of repository names to be synchronized.
162
163Note that in this case, the changeset listener extension point is not called, and therefore plugins using it will not work correctly.
164
165
166== Migration from a single-repository setup (Subversion) == #Migration
167The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
168
169 1. Remove the default repository specification from the [trac] repository_dir option.
170 1. Add the main repository as a named repository.
171 1. Re-synchronize the main repository.
172 1. Set up post-commit and post-revprop-change hooks on the "main" repository, and set [trac] repository_sync_per_request to an empty value.
173 1. Add an alias to the main repository as the default repository (by leaving out the the name, e.g. .alias = main). This ensures that all links predating the migration still resolve to the main repository.
174 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed.
175
176== Migration from a single-repository setup (Mercurial) == #MigrationMercurial
177The following procedure illustrates a typical migration from a Mercurial single-repository setup to multiple repositories. Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:ticket:9485 #9485] for more information.
178
180 1. Remove the default repository specification from the [trac] repository_dir option.
182 1. Add an alias to the main repository as the default repository (by leaving out the the name, e.g. .alias = main). This ensures that all links predating the migration still resolve to the main repository.
189You must now use the optional components from tracopt.ticket.commit_updater.*, which you can activate through the Plugins panel in the Administrative part of the web interface, or by directly modifying the [TracIni#components-section "[components]"] section in the trac.ini. Be sure to use [#ExplicitSync explicit synchronization] as explained above.