cleanup

Author: Andrei-Pozolotin

readme.md

@@ -4,11 +4,11 @@
 helps to create scripts for true multi-node multi-master replication 
 
 plugin listens on mailbox changes and reports them by:
-* writing a marker file `<mail_home>/syncer/<mailbox_guid>`
+* writing a marker file `<mail_home>/syncer/guid/<mailbox_guid>`
 * sending a change event to the pipe `/run/dovecot/syncer/pipe` 
 
 replication scripts then can watch for changes:
-* new files in the `syncer` folder
+* new files in the `syncer/{guid,type}` folder
 * new events in the `syncer/pipe` fifo
 
 and invoke `doveadm sync -g <mailbox_guid>` to multiple replication nodes

test/etc/dovecot/dovecot.conf

@@ -31,33 +31,39 @@ protocol sieve {
     mail_plugins = $mail_plugins syncer
 }
 protocol doveadm {
+    # note: disable in production
     mail_plugins = $mail_plugins syncer
 }
 protocol sieve-filter {
     mail_plugins = $mail_plugins syncer
 }
 
-# configure syncer settings
+# configure syncer_* settings
 plugin {
 
-    # enable plugin messages and marker file content
+    # enable plugin logger messages
     syncer_use_log = yes
 
-    # plugin output folder name inside <mail_home>
+    # plugin output folder inside <mail_home>
     syncer_dir = ~/syncer-test
-    # enable plugin output folder feature
+    
+    # enable plugin output via folder feature
     syncer_use_dir = yes
+    
     # enable content in plugin guid report marker files
     syncer_use_content = yes
 
-    # plugin output fifo pipe
+    # plugin output fifo pipe file
     syncer_pipe = /tmp/dovecot/syncer-pipe/pipe
+    
     # enable plugin output via fifo/pipe feature
     syncer_use_pipe = yes
 
     # TODO
     # syncer_script = /etc/dovecot/syncer-script.sh
 
+    ###
+
     # sieve-filter testing    
     sieve_dir = ~/sieve
     sieve = ~/sieve/active.sieve