Changes between Version 2 and Version 3 of TracRepositoryAdmin


Ignore:
Timestamp:
Feb 5, 2015, 2:57:06 PM (5 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracRepositoryAdmin

    v2 v3  
    1 = Repository Administration =
     1= Repository Administration
    22[[PageOutline(2-3)]]
    33
    4 == Quick start == #QuickStart
     4== Quick start #QuickStart
    55
    66 * Manage repositories in the "Repository" admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini].
     
    99 * 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.
    1010
    11 == Specifying repositories == #Repositories
     11== Specifying repositories #Repositories
    1212Starting 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.
    1313
     
    3535
    3636
    37 === In `trac.ini` === #ReposTracIni
     37=== In `trac.ini` #ReposTracIni
    3838Repositories 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.
    3939
     
    4141
    4242The 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
     43{{{#!ini
    4544[repositories]
    4645project.dir = /var/repos/project
     
    5958Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
    6059
    61 === In the database === #ReposDatabase
     60=== In the database #ReposDatabase
    6261Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the `trac-admin $ENV repository` commands.
    6362
     
    8180
    8281
    83 == Repository synchronization == #Synchronization
     82== Repository synchronization #Synchronization
    8483Prior 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.
    8584
    8685There 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.
    8786
    88 === Mercurial Repositories ===
     87=== Mercurial Repositories
    8988Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.
    9089
    91 === Explicit synchronization === #ExplicitSync
     90=== Explicit synchronization #ExplicitSync
    9291This 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.
    9392
     
    102101Note 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.
    103102
    104 ==== Subversion ====
     103==== Subversion
    105104
    106105The 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`):
     
    133132See the [http://svnbook.red-bean.com/en/1.5/svn.reposadmin.create.html#svn.reposadmin.create.hooks section about hooks] in the Subversion book for more information. Other repository types will require different hook setups.
    134133
    135 ==== Git ====
    136 
    137 Git hooks can be used in the same way for explicit syncing of Git repositories.  If your git repository is one that gets committed to directly on the machine that hosts trac, add the following to the `hooks/post-receive` file in your git repo (note: this will do nothing if you only update the repo by pushing to it):
     134==== Git
     135
     136Git hooks can be used in the same way for explicit syncing of Git repositories.  If your git repository is one that gets committed to directly on the machine that hosts trac, add the following to the `hooks/post-commit` file in your git repo (note: this will do nothing if you only update the repo by pushing to it):
    138137{{{#!sh
    139138#!/bin/sh
     
    155154The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    156155
    157 ==== Mercurial ====
     156==== Mercurial
    158157
    159158For 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):
     
    173172}}}
    174173
    175 === Per-request synchronization === #PerRequestSync
     174=== Per-request synchronization #PerRequestSync
    176175If 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.
    177176
     
    179178
    180179
    181 == Migration from a single-repository setup (Subversion) == #Migration
     180== Migration from a single-repository setup (Subversion) #Migration
    182181The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
    183182
     
    189188 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed.
    190189
    191 == Migration from a single-repository setup (Mercurial) == #MigrationMercurial
     190== Migration from a single-repository setup (Mercurial) #MigrationMercurial
    192191The 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.
    193192
     
    198197 1. Repeat step 3 to add other "named" repositories as needed.
    199198
    200 == Troubleshooting ==
    201 
    202 === My trac-post-commit-hook doesn't work anymore === #trac-post-commit-hook
     199== Troubleshooting
     200
     201=== My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook
    203202
    204203You 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.