summaryrefslogtreecommitdiffstats
path: root/doc/plugins/version/git.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/version/git.txt')
-rw-r--r--doc/plugins/version/git.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/plugins/version/git.txt b/doc/plugins/version/git.txt
index 621c64127..1b538f475 100644
--- a/doc/plugins/version/git.txt
+++ b/doc/plugins/version/git.txt
@@ -3,3 +3,16 @@
===
Git
===
+
+Why use the Git plugin
+======================
+
+The Git plugin is useful if you would like to track changes to your bcfg2 repository using a `Git <http://git-scm.com/>`_ backend. Currently, It enables you to get revision information out of your repository for reporting purposes. Future plans are to commit changes to the repo which are made by the server.
+
+How to enable the Git plugin
+============================
+
+The Git plugin uses `Dulwich <http://samba.org/~jelmer/dulwich/>`_ to interface with git repositories. Therefore, you will need to install Dulwich on the bcfg2 server first. Once installed, simply add Git to your plugins line in /etc/bcfg2.conf::
+
+ [server]
+ plugins = Base,Bundler,Cfg,...,Git