summaryrefslogtreecommitdiffstats
path: root/infra/northbound/restconf/asciidoc/Readme.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'infra/northbound/restconf/asciidoc/Readme.adoc')
-rw-r--r--infra/northbound/restconf/asciidoc/Readme.adoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/infra/northbound/restconf/asciidoc/Readme.adoc b/infra/northbound/restconf/asciidoc/Readme.adoc
new file mode 100644
index 000000000..957949ab3
--- /dev/null
+++ b/infra/northbound/restconf/asciidoc/Readme.adoc
@@ -0,0 +1,14 @@
+= restconf
+
+Provides modules and configuration for RESTCONF northbound interface.
+
+* To start RESTCONF HTTP use
+ ** "restconf-http-enabled": "true"
+* To start RESTCONF HTTPS use
+ ** "restconf-https-enabled": "true"
+* To disable RESTCONF start use
+ ** "restconf-http-enabled": "false"
+ ** "restconf-https-enabled": "false"
+* To disable RESTCONF fully
+ ** comment/remove io.fd.honeycomb.northbound.restconf.RestconfModule
+from distribution module configuration \ No newline at end of file