Pushmi - Subversion repository replication tool
pushmi mirror /var/db/my-local-mirror http://master.repository/svn pushmi sync /var/db/my-local-mirror
Pushmi provides a mechanism for bidirectionally synchronizing Subversion repositories. The main difference between Pushmi and other replication tools is that Pushmi makes the "slave" repositories writable by normal Subversion clients.
- Install and run memcached
We use memcached for better atomic locking for mirrors, as the subversion revision properties used for locking in SVK is insufficient in terms of atomicity.
You need to start memcached on the
authproxy_portport specified in pushmi.conf. For exmaple:
memcached -p 7123 -dP /var/run/memcached.pid
- Set up your local repository
Create /etc/pushmi.conf and setup username and password. See t/pushmi.conf for example.
pushmi mirror /var/db/my-local-mirror http://master.repository/svn
- Bring the mirror up-to-date.
pushmi sync --nowait /var/db/my-local-mirror
Configure a cron job to run this command every 5 minutes.
- Configure your local svn
Set up your svn server to serve /var/db/my-local-mirror at
For your existing Subversion checkouts, you may now switch to the slave using this command:
svn switch --relocate http://master.repository/svn http://slave.repository/svn
From there, you can use normal
svn commands to work with your checkout.
- Setup auto-verify
You can optionally enable auto-verify after every commit by setting revision property
pushmi:auto-verifyon revision 0 for the repository, Which can also be done with:
pushmi verify --enable /path/to/repository
You will also need to specify the full path of verify-mirror utility in the
When the repository is in inconsistent state, users will be advised to switch back to the master repository when trying to commit. The inconsistent state is denoted by the
pushmi:inconsistentrevision property on revision 0, and can be cleared with:
pushmi verify --correct /path/to/repository
The above section describes the minimum setup without authentication and authorisation.
- For svn:// access
You can we svn:// access for Pushmi, but there are some limitations for it as of the current implementation. First of all it will have to be using the shared credential when committing to the master. So you will need to make sure the user is allowed to write to the master. And as a side-effect, the commits via the slave will be committed by the shared user on the master. You can however use some post-commit hook or other means to set the
svn:authorrevision property afterwards. You will need to make sure
use_shared_commitis enabled, and if you are using svn+ssh://, make sure the user pushmi runs as has the correct ssh key to commit to the master.
- For authz_svn-controlled master repository
You need to use an external mechanism to replicate the authz file and add a
AuthzSVNAccessFiledirective in the slave's slave
httpd.conf, along with whatever authentication modules and configurations. You will need additional directives in
# replace with your auth settings AuthName "Subversion repository for projectX" AuthType Basic Require valid-user # here are the additional config required for pushmi PerlSetVar PushmiConfig /etc/pushmi.conf PerlAuthenHandler Pushmi::Apache::AuthCache
- For public-read master repository
You can defer the auth* to the master on write. Put the additional config in
PerlSetVar SVNPath /var/db/my-local-mirror PerlSetVar Pushmi /usr/local/bin/pushmi PerlSetVar PushmiConfig /etc/pushmi.conf PerlLoadModule Apache::AuthenHook # for apache 2.2 <LimitExcept GET PROPFIND OPTIONS REPORT> AuthName "Subversion repository for projectX" AuthType Basic Require valid-user # for apache 2.0 PerlAuthenHandler Pushmi::Apache::AuthCommit # for apache 2.2 AuthBasicProvider Pushmi::Apache::RelayProvider </LimitExcept>
pushmi looks for /etc/pushmi.conf or wherever
PUSHMI_CONFIG in environment points to. Available options are:
The credential to use for mirroring.
The credential to use for mirroring.
The port memcached is running on.
If pushmi should use the cached subversion authentication info.
passwordfor committing to master.
Path to verify-mirror.
Some mirror-related options are configurable in svk, in your ~/.subversion/config's
The size in bytes that pipelined sync should leave the textdelta in a tempfile. Default is 2m.
The max number of revisions that pipelined sync should keep in memory when it is still busy writing to local repository.
Copyright 2006-2007 Best Practical Solutions, LLC.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
To inquire about commercial support, please contact firstname.lastname@example.org.
Chia-liang Kao <email@example.com<gt>
2 POD Errors
The following errors were encountered while parsing the POD:
- Around line 65:
'=item' outside of any '=over'
- Around line 83:
You forgot a '=back' before '=head1'