From c964ff60a53ec57c4da02bce9cb7d8ef5cb3f806 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Magdalena=20Grodzi=C5=84ska?= <mag.grodzinska@gmail.com>
Date: Wed, 29 Jan 2020 23:04:51 +0100
Subject: Add flags README

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 46 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index e159904..d4689c3 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@
 
 ## Running
 
-The agent, fetcher, and interpreter take an optional `-Dhostname=<agent's external hostname`
-argument, which defaults to `localhost`.
+The agent, fetcher, and interpreter take optional `-Dflagname=flagvalue`
+argument. Otherwise those values are set to default ones, as described below.
 
 ### Query Signer
     # start rmiregistry
@@ -13,7 +13,16 @@ argument, which defaults to `localhost`.
     # run Query Signer
     ./gradlew runQuerySigner
     
-### API Agent
+Relies on generation of public and private keys by scripts/generate_keys.sh.
+
+Flags:
+
+* java.rmi.server.hostname - RMI registry hostname, default: localhost
+* querySignerHostname - query signer public RMI API hostname, default: localhost
+* publicKeyFilename - path to public key file, relative to root of project, default: build/tmp/query_signer.pub
+* privateKeyFilename - path to private key file, relative to root of project, default: build/tmp/query_signer
+    
+### Agent
 
     # start rmiregistry
     ./scripts/registry
@@ -22,13 +31,34 @@ argument, which defaults to `localhost`.
 
 Relies on keys generated during query signer setup.
 
+Flags:
+
+* java.rmi.server.hostname - RMI registry hostname, default: localhost
+* freshnessPeriod - data refresh period, default: 60 * 1000
+* queryPeriod - query rerun period, default: 5 * 1000
+* gossipPeriod - gossiping period, default: 5 * 1000
+* hostname - public UDP server hostname, default: hostname
+* port - public UDP port, default: 5999
+* timeout - UDP server timeout, default: 5 * 1000
+* bufsize - UDP message buffer size, default: 512
+* zoneSelectionStrategy - zone selection strategy for gossiping, default: RandomUniform
+    available options: RoundRobinExp, RoundRobinUniform, RandomExp, RandomUniform
+* zonePath - zone pathname of agent, default: /uw/violet07
+* publicKeyFilename - path to public key file, relative to root of project, default: build/tmp/query_signer.pub
+
 ### Client
 
     ./gradlew runClient
 
-Relies on a running agent.
+Exposes a web application on `localhost:8082`.
+
+Relies on a running agent with fetcher.
 
-Exposes a web application on `localhost:8080`.
+Flags:
+
+* hostname - agent RMI API hostname, default: localhost
+* zonePath - zone pathname of agent, default: /uw/violet07
+* querySignerHostname - query signer RMI API hostname, default: localhost
 
 ### Fetcher
 
@@ -36,6 +66,17 @@ Exposes a web application on `localhost:8080`.
 
 Sends system information to an agent.
 
+Relies on a running agent.
+
+Flags:
+
+* hostname - agent RMI API hostname, default: localhost
+* zonePath - zone pathname of agent, default: /uw/violet07
+* ownAddr - public IP address or domain name of agent/fetcher machine
+* fallbackContacts - initialize fallback contacts, default: {}, example:
+
+    -DfallbackContacts=\{\"/uw/violet07\":[192,168,0,11]}
+
 ### Interpreter
 
     ./gradlew runInterpreter
-- 
cgit v1.2.3