summaryrefslogtreecommitdiffstats
path: root/docs/release/configguide
diff options
context:
space:
mode:
authorUlas Kozat <ulas.kozat@gmail.com>2017-03-29 12:27:29 -0700
committerUlas Kozat <ulas.kozat@gmail.com>2017-03-29 12:31:44 -0700
commit41f6d348f527bda798c5de061d9c53d149a294b6 (patch)
tree94a0014c6d2fe6b36f37ff460647e7f196f5b010 /docs/release/configguide
parent5618748c7fdc28db5c4c91244e87e3fd3886adc7 (diff)
JIRA 23: Update documentation
Change-Id: I11e9ec7f0684b4ebcae8fba0fdfb50c73a5d0bf2 Signed-off-by: Ulas Kozat <ulas.kozat@gmail.com>
Diffstat (limited to 'docs/release/configguide')
-rw-r--r--docs/release/configguide/featureconfig.rst35
-rw-r--r--docs/release/configguide/index.rst13
2 files changed, 48 insertions, 0 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst
new file mode 100644
index 0000000..acbe6ba
--- /dev/null
+++ b/docs/release/configguide/featureconfig.rst
@@ -0,0 +1,35 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Domino Configuration
+====================
+Domino Server and Clients can be configured via (i) passing command line options
+(see API documentation) and (ii) the configuration file "domino_conf.py" under the
+main directory.
+
+* The default file for logging is set as none and log level set as "WARNING".
+
+Domino Server
+-------------
+* The default server unique user ID is set as 0 in the configuration file.
+
+* The default TCP port for RPC calls is set as 9090 in the configuration file.
+
+* The default database file for Domino Server is set as "dominoserver.db" under the main directory
+
+* The default folder for keeping published TOSCA files and pushed parts is set as "toscafiles" in the configuration file via variable TOSCADIR.
+
+* The default log level (WARNING) can be changed by passing the flags --log or -l followed by a log level, e.g., ERROR, WARNING, INFO, or DEBUG.
+
+Domino Client
+-------------
+* The default mode of CLI is non-interactive (i.e., Domino CLI Utility is used). Passing --iac=TRUE would begin the client in interactive mode.
+
+* The default log level (WARNING) can be changed by passing the flags --log or -l followed by a log level, e.g., ERROR, WARNING, INFO, or DEBUG.
+
+* The default Domino Server IP is set as "localhost". This can be overwritten at the time of launching DominoClient via the option flags -i or --ipaddr followed by the IP address of the actual server hosting the Domino Server.
+
+* The default Domino Client TCP port for RPC calls is set as 9091 in the configuration file. It can be overwritten when the DominoClient is launched by passing the flags --port or -p followed by the port number.
+
+* The default folder for keeping preceived TOSCA files is set as "toscafiles" in the configuration file via variable TOSCA_RX_DIR.
+
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644
index 0000000..9cc5c6c
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _domino-configguide:
+
+*************
+Configuration
+*************
+
+.. toctree::
+ :maxdepth: 2
+
+ featureconfig.rst