From 60a0abc106c568af5bb11f0815bf7289d6477ee6 Mon Sep 17 00:00:00 2001 From: Keshav Varma Date: Sat, 26 Mar 2016 22:52:36 -0400 Subject: [PATCH] Update readme --- README | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README b/README index ca4f952..76d6211 100644 --- a/README +++ b/README @@ -1,3 +1,38 @@ -This package has Vyatta cron configuration templates and scripts. +## VyOS config-sync -See README.md for details. +This replicates the functionality of the commercial version of Vyatta's config-sync for VyOS and community Vyatta editions. + +#### Installation + +Installation + +To compile a debian package yourself, run the following: + + $ https://github.com/keshavdv/vyattta-config-sync/archive/master.zip + $ # Extract, install build dependencies + $ dpkg-buildpackage -us -uc + +#### Issues + +This is *alpha* software! It attempts to follow the same API as the commercial config-sync tool but has a very hacked together implementation. Only use it to sync non-critical sections of config like nat or firewall rules to ensure you don't kick yourself out of the device. + +#### Usage + +Basic synchronization is setup via: + + set system config-sync sync-map slave rule 10 action include + set system config-sync sync-map slave rule 10 location "nat" + + set system config-sync sync-map slave rule 20 action include + set system config-sync sync-map slave rule 20 location "firewall" + + # the local user must be able to SSH to the remote host with the specified username + # with passwordless authentication + set system config-sync remote-router username + set system config-sync remote-router sync-map slave + + commit # Will automatically sync config + + # If you want, you can manually run a sync or view the latest status + run update config-sync + show config-sync status \ No newline at end of file