summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNick Hilliard <nick@foobar.org>2015-09-30 16:23:54 +0100
committerNick Hilliard <nick@foobar.org>2015-09-30 16:23:54 +0100
commitc6cd643a871ea4bd9ba98635adc94c2c793c7173 (patch)
tree5c5e4266e6d9126ef05de5b8fc7389386f07de52 /README.md
parent576a0b1df455d14f4bde0d21c63a1a498248e485 (diff)
Add documentation note about API URI
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index f6ce764..795a741 100644
--- a/README.md
+++ b/README.md
@@ -353,6 +353,20 @@ nodiff/$FQDN--show_version
nodiff/$FQDN--show_inventory
```
+### RESTful API and Web Interface
+
+The RESTful API and Web Interface is enabled by configuring the `rest:` parameter in the config file. This parameter can optionally contain a relative URI.
+
+```
+# Listen on http://127.0.0.1:8888/
+rest: 127.0.0.1:8888
+```
+
+```
+# Listen on http://10.0.0.1:8000/oxidized/
+rest: 10.0.0.1:8000/oxidized
+```
+
### Advanced Configuration
Below is an advanced example configuration. You will be able to (optinally) override options per device. The router.db format used is ```hostname:model:username:password:enable_password```. Hostname and model will be the only required options, all others override the global configuration sections.