summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Laszlo <tim.laszlo@gmail.com>2010-12-18 09:55:54 -0600
committerTim Laszlo <tim.laszlo@gmail.com>2010-12-18 09:56:20 -0600
commit67e605b1abcd37cf59af36254b87b61730979aa4 (patch)
treed4931d2e883f6f783a878bb4ac2ed6d5684878ba
parent09c0c0b30dc9b89c3023a1df8fc85c6e70345512 (diff)
downloadbcfg2-67e605b1abcd37cf59af36254b87b61730979aa4.tar.gz
bcfg2-67e605b1abcd37cf59af36254b87b61730979aa4.tar.bz2
bcfg2-67e605b1abcd37cf59af36254b87b61730979aa4.zip
docs: Document Svn2 plugin
-rw-r--r--doc/server/plugins/version/svn2.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/server/plugins/version/svn2.txt b/doc/server/plugins/version/svn2.txt
new file mode 100644
index 000000000..a1f146c85
--- /dev/null
+++ b/doc/server/plugins/version/svn2.txt
@@ -0,0 +1,38 @@
+.. -*- mode: rst -*-
+
+.. _server-plugins-version-svn2:
+
+====
+Svn2
+====
+
+The Svn2 plugin is useful if you would like to track changes to your
+bcfg2 repository using a `Subversion <http://subversion.tigris.org/>`_
+backend. It is a rewrite of the Svn plugin using the native
+`pysvn <http://pysvn.tigris.org/>`_ api.
+
+Currently, It enables you to get revision information out of your
+repository for reporting purposes. Once the plugin is enabled, every time
+a client checks in, it will include the current repository revision in
+the reports/statistics. If any changes are made from the bcfg2-server
+the plugin will commit them back into the repositroy. For example,
+``/usr/sbin/bcfg2-admin pull client Path /some/file`` will update the
+servers repository and commit the changes into svn.
+
+How to enable the Svn2 plugin
+=============================
+
+Simply add Svn2 to your plugins line in ``/etc/bcfg2.conf``::
+
+ [server]
+ plugins = Base,Bundler,Cfg,..,Svn2
+
+Auto Commit feautre
+===================
+
+Svn2 adds the ability to commit changes back into the repository. In
+order for this feature to work the repository should already be under version
+control and the user the bcfg2-server runs as must be able to commit without
+any interaction. For example a file base repository url
+(``file:///path/to/repo``).
+