Author: baedke
Date: Fri Sep 19 10:44:37 2014
New Revision: 1626175
URL: http://svn.apache.org/r1626175
Log:
@trivial: updated oak-run readme file adding descriptions of the runmodes
syncmaster and syncslave
Modified:
jackrabbit/oak/trunk/oak-run/README.md
Modified: jackrabbit/oak/trunk/oak-run/README.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/README.md?rev=1626175&r1=1626174&r2=1626175&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/README.md (original)
+++ jackrabbit/oak/trunk/oak-run/README.md Fri Sep 19 10:44:37 2014
@@ -13,6 +13,8 @@ The following runmodes are currently ava
* server : Run the Oak Server.
* console : Start an interactive console.
* explore : Starts a GUI browser based on java swing.
+ * syncmaster : Run a TarMK Cold Standby master
+ * syncslave : Run a TarMK Cold Standby slave
* scalability : Run scalability tests against different Oak repository
fixtures.
* recovery : Run a _lastRev recovery on a MongoMK repository
* help : Print a list of available runmodes
@@ -83,13 +85,40 @@ browsing of an existing oak repository.
$ java -jar oak-run-*.jar explore /path/to/oak/repository [skip-size-check]
+Syncmaster
+-------
+
+The 'syncmaster' mode starts a TarMK Cold Standby master listening on a TCP/IP
port for connecting slaves.
+
+ $ java -jar oak-run-*.jar syncmaster [options] /path/to/TarMK
+
+The following options are available:
+
+ --port 8023 - port to listen at
+ --admissible 127.0.0.1 - admissible client IP range or host name
+ --secure - use secure connections
+
+Syncslave
+-------
+
+The 'syncslave' mode starts a TarMK Cold Standby slave to create or update a
continous backup from a Cold Standby master.
+
+ $ java -jar oak-run-*.jar syncslave [options] /path/to/TarMK
+
+The following options are available:
+
+ --port 8023 - port to connect to
+ --host 127.0.0.1 - host to connect to
+ --secure - use secure connections
+ --interval 5 - schedule the slave to run continously, connecting
every n seconds
+
Compact
-------
The 'compact' mode runs the segment compaction operation on the provided TarMK
repository. To start this mode, use:
- $ java -jar oak-run-*.jar compact /path/to/oak/repository
+ $ java -jar oak-run-*.jar compact /path/to/TarMK
Checkpoints
-----------
