summaryrefslogtreecommitdiff
path: root/plugins/chrony/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/chrony/README')
-rw-r--r--plugins/chrony/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/chrony/README b/plugins/chrony/README
new file mode 100644
index 00000000..a9f28c24
--- /dev/null
+++ b/plugins/chrony/README
@@ -0,0 +1,24 @@
+CHRONY plugin
+Version: @PROJECT_VERSION@
+
+This plugin will forward the GpsTime property to the CHRONYD daemon.
+
+To enable the CHRONY plugin, run cmake and enable the chrony_plugin option:
+
+cmake -Dchrony_plugin=On ..
+
+To use this plugin, add the following to the "sinks" array in /etc/ambd/config:
+
+{
+ "name" : "chrony",
+ "path" : "@PLUGIN_INSTALL_PATH@/chrony.so",
+}
+
+Configuration Key Definitions:
+
+"name"
+name of plugin. This key is not used by the plugin at this moment.
+
+"path"
+path to plugin on the filesystem.
+