summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Ackley <jason@ackley.net>2018-04-24 10:15:45 -0500
committerJason Ackley <jason@ackley.net>2018-04-24 10:15:45 -0500
commit7d450963907a76b26c47082b5c482a093ba3a533 (patch)
tree4442735df0e0ba87cfa3e3c5aff7536f3b4bb33c
parente383a573e6c11f7366ce52774e191f7272db114f (diff)
A few Outputs.md textual cleanups
misc clarity items
-rw-r--r--docs/Outputs.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/Outputs.md b/docs/Outputs.md
index 92c672c..fab3bf8 100644
--- a/docs/Outputs.md
+++ b/docs/Outputs.md
@@ -14,7 +14,7 @@ output:
This uses the rugged/libgit2 interface. So you should remember that normal Git hooks will not be executed.
-For a single repositories for all devices:
+For a single repository containing all devices:
```yaml
output:
@@ -25,7 +25,7 @@ output:
repo: "/var/lib/oxidized/devices.git"
```
-And for groups repositories:
+And for group-based repositories:
```yaml
output:
@@ -68,7 +68,7 @@ output:
This uses the gem git and system git-crypt interfaces. Have a look at [GIT-Crypt](https://www.agwa.name/projects/git-crypt/) documentation to know how to install it.
Additionally to user and email informations, you have to provide the users ID that can be a key ID, a full fingerprint, an email address, or anything else that uniquely identifies a public key to GPG (see "HOW TO SPECIFY A USER ID" in the gpg man page).
-For a single repositories for all devices:
+For a single repository containing all devices:
```yaml
output:
@@ -82,7 +82,7 @@ output:
- "<user@example.com>"
```
-And for groups repositories:
+And for group-based repositories:
```yaml
output:
@@ -130,8 +130,9 @@ Please note that user list is only updated once at creation.
## Output: Http
-POST a config to the specified URL
+The HTTP output will POST a config to the specified HTTP URL. Basic username/password authentication is supported.
+Example HTTP output configuration:
```yaml
output:
default: http
@@ -185,4 +186,4 @@ which will result in the following layout
diff/$FQDN--show_running_config
nodiff/$FQDN--show_version
nodiff/$FQDN--show_inventory
-``` \ No newline at end of file
+```