Changes between Version 3 and Version 4 of Trac Repository Admin


Ignore:
Timestamp:
Aug 19, 2021, 11:03:25 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Trac Repository Admin

    v3 v4  
    55
    66 * Enable the repository connector(s) for the version control system(s) that you will use.
    7  * Add repositories through the //Repositories// admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini].
    8  * 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.
    9  * Make sure the user under which your hooks are run has write access to the Trac environment, or use a tool like `sudo` to temporarily elevate privileges.
     7 * Add repositories through the //Repositories// admin page, using `trac-admin` or by editing the `[repositories]` section of [[wiki:TracIni#repositories-section|trac.ini]].
     8 * Synchronize the repositories with the cache, if using cached repositories.
     9 * Configure your repository hooks to synchronize the repository. Alternatively you can synchronize on every request or disable the use of cached repositories, both of which have performance drawbacks and reduced functionality, but are easier to configure.
    1010
    1111== Enabling the components
     
    1313Support for version control systems is provided by optional components distributed with Trac, which are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them.
    1414
    15 The version control systems can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the //Plugins// admin panel.
     15The version control systems can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components through the //Plugins// admin page.
    1616
    1717{{{#!ini
     
    2424
    2525== Specifying repositories #Repositories
    26 Trac supports multiple repositories per environment, and the repositories may be for different version control system types. Each repository must be defined in a repository configuration provider, the two supported by default are the [#ReposDatabase database store] and the [#ReposTracIni trac.ini configuration file]. A repository should not be defined in multiple configuration providers.
    27 
    28 It is possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking links to the old name.
    29 
    30 A number of attributes can be associated with each repository. The attributes define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported:
     26
     27Trac supports multiple repositories per environment, and the repositories may be for different version control systems. Each repository must be defined in a repository configuration provider. Repository providers included with Trac are the [#ReposDatabase database store], the [#ReposTracIni trac.ini configuration file] and the [#ReposGitWeb GitWeb configuration file]. Additional providers are available as plugins.
     28
     29You can define your repositories through a mix of providers, but each repository should only be defined in a single provider. The repository names must be unique across all providers and duplicate names are discarded.
     30
     31It is possible to define aliases of repositories that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking links to the old name.
     32
     33=== Default Repository
     34
     35Trac's repositories are listed in the Repository Index when navigating to //Browse Source//. The default repository is displayed first, followed by the Repository Index. TracLinks without a repository name in the path specification (e.g. `[1]` rather than `[1/repos1]`) refer to the default repository. !TracLinks for repositories other than the default must include the repository name in the path specification.
     36
     37From the Repository Admin page, the default repository is specified by leaving the //Name// attribute empty. From the command line, the default repository is specified using the string `(default)` or `""`. In TracIni, the default repository is specified by leaving the `{name}` empty for each `{name}.{attribute}` option (e.g. `.dir = /path/to/dir`).
     38
     39=== Repository Attributes
     40
     41There are a number of attributes that can be specified for each repository, and additional attributes may be available through plugins. A repository `name` and one of the `alias` or `dir` attributes are mandatory. All others are optional.
     42
     43The following attributes are supported:
    3144
    3245||='''Attribute''' =||='''Description''' =||
    3346||`alias` ||\
    34 ||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. ||
     47||Defines 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. ||
     48|| `cached` ||\
     49|| For a version control system that support caching, specifies that repository caching should be used. Defaults to `true` for version control systems that support caching. ||
    3550||`description` ||\
    3651||The text specified in the `description` attribute is displayed below the top-level entry for the repository in the source browser. It supports WikiFormatting. ||
    3752||`dir` ||\
    38 ||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. ||
    39 ||`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. ||
    40 ||`sync_per_request`||When set to `true` the repository will be synced on every request. This is not recommended, instead a post-commit hook should be configured to provide [#ExplicitSync explicit synchronization] and `sync_per_request` should be set to `false`.||
    41 ||`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. ||
    42 ||`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. ||
    43 
    44 A repository `name` and one of `alias` or `dir` attributes are mandatory. All others are optional.
    45 
    46 For some version control systems, it is possible to specify not only the path to the repository in the `dir` attribute, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The Subversion backend for Trac supports this. For other types, check the corresponding plugin's documentation.
    47 
    48 After adding a repository, the cache for that repository must be re-synchronized once with the `trac-admin $ENV repository resync` command.
    49 
    50  `repository resync <repos>`::
    51    Re-synchronize Trac with a repository.
    52 
     53||The `dir` attribute specifies the location of the repository in the filesystem. The `alias` and `dir` attributes are mutually exclusive. ||
     54||`hidden` ||\
     55|| 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. ||
     56||`sync_per_request`||\
     57|| When set to `true` the repository will be synchronized on every request (implicit synchronization). This is generally not recommended. See [#Synchronization repository synchronization] for a comparison of explicit and implicit synchronization. The attribute defaults to `false`. ||
     58||`type` ||\
     59|| The `type` attribute specifies the version control system used by the repository. Trac provides support for Subversion and Git, and plugins add support for several other systems. If `type` is not specified, it defaults to the value of the `[versioncontrol]` [wiki:TracIni#versioncontrol-default_repository_type-option default_repository_type] option. ||
     60||`url` ||\
     61|| 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. ||
     62
     63=== Scoped Repository
     64
     65For some version control systems, it is possible to specify not only the path to the repository in the `dir` attribute, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The scope is specified by appending a path that is relative to the repository root. The Subversion backend for Trac supports this.
     66
     67For example, assume a repository at filesystem path `/var/svn/repos1` with several directories at the root of the repository: `/proj1`, `/proj2`, etc. The following configuration would scope the repository to `/proj1`:
     68{{{#!ini
     69proj1.dir = /var/svn/repos1/proj1
     70proj1.type = svn
     71}}}
     72
     73For other repository types, check the corresponding plugin's documentation.
     74
     75=== In the database #ReposDatabase
     76Repositories can also be specified in the database, using either the //Repositories// admin page under //Version Control//, or the `trac-admin $ENV repository` commands.
     77
     78The 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.
     79
     80The following [wiki:TracAdmin trac-admin] commands can be used to perform repository operations from the command line.
     81
     82 `repository add <repos> <dir> [type]`::
     83   Add a repository `<repos>` located at `<dir>`, and optionally specify its type.
     84
     85 `repository alias <name> <target>`::
     86   Create an alias `<name>` for the repository `<target>`.
     87
     88 `repository remove <repos>`::
     89   Remove the repository `<repos>`.
     90
     91 `repository set <repos> <key> <value>`::
     92   Set the attribute `<key>` to `<value>` for the repository `<repos>`.
     93
     94Note that the default repository has an empty name, so it will 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.
    5395
    5496=== In `trac.ini` #ReposTracIni
    5597Repositories 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.
    5698
    57 The 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.
     99The main advantage of specifying repositories in `trac.ini` is that they can be inherited from a [wiki:TracIni#GlobalConfiguration global configuration]. Cached repositories defined in `trac.ini` at the time of [TracEnvironment#SourceCodeRepository environment initialization] will be automatically synchronized if the repository's connector is enabled. One drawback is that due to limitations in the `ConfigParser` class used to parse `trac.ini`, the repository name is always lowercase.
    58100
    59101The 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.
     
    75117Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
    76118
    77 === In the database #ReposDatabase
    78 Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the `trac-admin $ENV repository` commands.
    79 
    80 The 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.
    81 
    82 The following [wiki:TracAdmin trac-admin] commands can be used to perform repository operations from the command line.
    83 
    84  `repository add <repos> <dir> [type]`::
    85    Add a repository `<repos>` located at `<dir>`, and optionally specify its type.
    86 
    87  `repository alias <name> <target>`::
    88    Create an alias `<name>` for the repository `<target>`.
    89 
    90  `repository remove <repos>`::
    91    Remove the repository `<repos>`.
    92 
    93  `repository set <repos> <key> <value>`::
    94    Set the attribute `<key>` to `<value>` for the repository `<repos>`.
    95 
    96 Note 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.
     119=== In !GitWeb #ReposGitWeb
     120
     121[https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb GitWeb] is a CGI script that comes with Git for web-based visualization of repositories. Trac can read the gitweb-formatted `project.lists` file. The configuration is done through the `[gitweb-repositories]` section of [[TracIni#gitweb-repositories-section|trac.ini]].
    97122
    98123== Repository caching
    99124
    100 The Subversion and Git repository connectors support caching, which improves the performance browsing the repository, viewing logs and viewing changesets. Cached repositories must be [#Synchronization synchronized]; either explicit or implicit synchronization can be used. When searching changesets, only cached repositories are searched.
    101 
    102 Subversion repositories are cached unless the type is `direct-svnfs`. Git repositories are cached when `[git]` [wiki:TracIni#git-section cached_repository] is `true`.
     125Caching improves the performance browsing the repository, viewing logs and viewing changesets. Cached repositories must be [#Synchronization synchronized], using either explicit or implicit synchronization. When searching changesets, only cached repositories are searched.
     126
     127Repositories that support caching are cached by default. The Subversion and Git backends support caching. The [trac:TracMercurial Mercurial plugin] does not yet support caching ([trac:#8417]). To disable caching, set the `cached` attribute to `false`.
     128
     129After adding a cached repository, the cache must be populated with the `trac-admin $ENV repository resync` command.
     130
     131 `repository resync <repos>`::
     132   Re-synchronize Trac with a repository.
    103133
    104134== Repository synchronization #Synchronization
    105 Prior 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.
    106 
    107 There 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.
    108 
    109 === Mercurial Repositories
    110 Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.
     135
     136Either explicit or implicit synchronization can be used. Implicit synchronization is easier to configure, but may result in noticeably worse performance. The changeset added and modified events can't be triggered with implicit synchronization, so the [#Automaticchangesetreferencesintickets commit ticket updater] won't be available.
    111137
    112138=== Explicit synchronization #ExplicitSync
    113 This is the preferred method of repository synchronization. It requires setting the `sync_per_request` attribute to `false`, 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.
     139
     140This is the preferred method of repository synchronization. It requires 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.
    114141
    115142 `changeset added <repos> <rev> [...]`::
     
    119146   Notify Trac that metadata on one or more changesets in a repository has been modified.
    120147
    121 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    122 
    123 Note 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.
     148The `<repos>` argument can be either a repository name (use `"(default)"` for the default repository) or the path to the repository.
     149
     150Note 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#Settinguptheplugincache TracPlugins] for more information.
    124151
    125152==== Subversion
     153
     154===== Using `trac-svn-hook`
     155
     156In a Unix environment, the simplest way to configure explicit synchronization is by using the [trac:source:branches/1.4-stable/contrib/trac-svn-hook contrib/trac-svn-hook] script. `trac-svn-hook` starts `trac-admin` asynchronously to avoid slowing the commit and log editing operations. The script comes with a number of safety checks and usage advice. Output is written to a log file with prefix `svn-hooks-` in the environment `log` directory, which can make configuration issues easier to debug.
     157
     158There's no equivalent `trac-svn-hook.bat` for Windows yet, but the script can be run by Cygwin's bash. The documentation header of `trac-svn-hook` contains a Cygwin configuration example.
     159
     160Follow the help in the documentation header of the script to configure `trac-svn-hook`. You'll need to minimally set the `TRAC_ENV` variable, and may also need to set `TRAC_PATH` and `TRAC_LD_LIBRARY_PATH` for a non-standard installation or a virtual environment.
     161
     162Configuring the hook environment variables is even easier in Subversion 1.8 and later using the [http://svnbook.red-bean.com/en/1.8/svn.reposadmin.create.html#svn.reposadmin.hooks.configuration hook script environment] configuration. Rather than directly editing `trac-svn-hook` to set the environment variables, or exporting them from the hook that invokes `trac-svn-hook`, they can be configured through the repository `conf/hooks-env` file.
     163
     164Here is an example, using a Python virtual environment at `/usr/local/venv`:
     165{{{#!ini
     166[default]
     167TRAC_ENV=/var/trac/project-1
     168TRAC_PATH=/usr/local/venv/bin
     169}}}
     170
     171===== Writing Your Own Hook Script
    126172
    127173The 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`):
     
    131177/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
    132178}}}
    133 Note: Check with `whereis trac-admin`, whether `trac-admin` is really installed under `/usr/bin/` or maybe under `/usr/local/bin/` and adapt the path.
     179Adapt the path to the actual location of `trac-admin`.
    134180On Windows (`post-commit.cmd`):
    135181{{{#!bat
     
    150196The 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`.
    151197
    152 Note 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.
    153 
    154 See 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.
     198See the [http://svnbook.red-bean.com/en/1.7/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 configuration.
    155199
    156200==== Git
    157201
    158 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-commit` file in your git repo (note: this will do nothing if you only update the repo by pushing to it):
    159 {{{#!sh
    160 #!/bin/sh
    161 REV=$(git rev-parse HEAD)
    162 trac-admin /path/to/env changeset added <repos> $REV
    163 }}}
    164 
    165 Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo:
    166 {{{#!sh
    167 #!/bin/sh
    168 tracenv=/path/to/env     # change with your Trac environment's path
    169 repos=                   # change with your repository's name
     202[https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks Git hooks] can be used in the same way for explicit syncing of Git repositories.
     203
     204If your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo:
     205{{{#!sh
     206#!/bin/sh
     207tracenv=/path/to/env  # set to your Trac environment's path
     208repos=                # set to your repository's name
    170209while read oldrev newrev refname; do
    171210    if [ "$oldrev" = 0000000000000000000000000000000000000000 ]; then
     
    176215done
    177216}}}
    178 
    179 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
     217The `repos` variable is the repository name (use `"(default)"` for the default repository).
     218
     219Alternatively, 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 repository:
     220{{{#!sh
     221#!/bin/sh
     222tracenv=/path/to/env  # set to your Trac environment's path
     223repos=                # set to your repository's name
     224REV=$(git rev-parse HEAD)
     225trac-admin "$tracenv" changeset added "$repos" $REV
     226}}}
     227The `post-commit` hook will do nothing if you only update the repository by pushing to it.
     228
     229Be sure to set the hook scripts as executable.
    180230
    181231==== Mercurial
     
    198248
    199249=== Per-request synchronization #PerRequestSync
    200 If the post-commit hooks are not available, the environment can be set up for per-request synchronization. In that case, the `sync_per_request` attribute for each repository in the database and in [wiki:TracIni#trac-section trac.ini] must be set to `false`.
    201 
    202 Note that in this case, the changeset listener extension point is not called, and therefore plugins using it will not work correctly.
    203 
    204 == Automatic changeset references in tickets
    205 
    206 You can automatically add a reference to the changeset as a ticket comment whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
     250If the post-commit hooks are not available, the environment can be set up for per-request synchronization. The `sync_per_request` attribute for each repository in the database and in [wiki:TracIni#trac-section trac.ini] must be set to `true`.
     251
     252Note that in this case, the changeset listener extension point is not called, and therefore plugins that depend on the changeset added and modified events won't work correctly. For example, automatic changeset references cannot be used with implicit synchronization.
     253
     254== Automatic changeset references in tickets #CommitTicketUpdater
     255
     256You can automatically add a reference to the changeset as a ticket comment whenever changes are committed to the repository. The description of the commit needs to contain one of the following patterns:
    207257 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
    208258 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
    209259
    210 This functionality requires installing a post-commit hook as described in [#ExplicitSync], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the //Plugins// admin panel.
     260This functionality requires installing a post-commit hook as described in [#ExplicitSync explicit synchronization], and enabling the optional commit updater components through the //Plugins// admin panel or by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini]:
    211261{{{#!ini
    212262tracopt.ticket.commit_updater.* = enabled
     
    218268=== My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook
    219269
    220 You 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.
     270You must now use the optional components from `tracopt.ticket.commit_updater.*`, which you can activate through the //Plugins// admin page, or by directly modifying the [TracIni#components-section "[components]"] section in the trac.ini. Be sure to use [#ExplicitSync explicit synchronization].
     271
     272See [trac:CommitTicketUpdater#Troubleshooting] for more troubleshooting tips.
     273
     274=== Git control files missing
     275
     276If your repository is not browseable and you find a message in the log that looks like:
     277{{{
     2782017-08-08 10:49:17,339 Trac[PyGIT] ERROR: GIT control files missing in '/path/to/git-repository'
     2792017-08-08 10:49:17,339 Trac[git_fs] ERROR: GitError: GIT control files not found, maybe wrong directory?
     280}}}
     281
     282First check that the path to your repository is correct. If the path is correct, you may have a permission problem whereby the web server cannot access the repository. You can use Git to verify the repository. On a Debian-like Linux OS, the following command should help:
     283{{{#!sh
     284$ sudo -u www-data git --git-dir=/path/to/git-repository fsck
     285}}}
     286
     287On other platforms you may need to modify the command to use the user under which the webserver runs.