summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/README.md b/README.md
index 4b22d8f..f7a4fc3 100644
--- a/README.md
+++ b/README.md
@@ -10,12 +10,13 @@
# Install
* early days, but try:
- 1. apt-get install libsqlite3-dev libssl-dev
- 2. gem install oxidized oxidized-web
- 3. oxidized
- 4. vi ~/.config/oxidized/config
- 5. (maybe point to your rancid/router.db or copy it there)
- 6. oxidized
+ 1. apt-get install ruby libsqlite3-dev libssl-dev
+ 2. gem install oxidized
+ 3. gem install oxidized-script oxidized-web # if you don't install oxidized-web, make sure you remove "rest" from your config
+ 4. oxidized
+ 5. vi ~/.config/oxidized/config
+ 6. (maybe point to your rancid/router.db or copy it there)
+ 7. oxidized
# API
## Input
@@ -121,11 +122,12 @@ source:
```
which reads nodes from rancid compatible router.db maps their model names to
model names oxidized expects, stores config in git, will try ssh first then
-telnet, wont crash on changed ssh keys
+telnet, wont crash on changed ssh keys.
+
Hopefully most of them are obvious, log is ignored if Syslog::Logger exists
(>=2.0) and syslog is used instead.
+
System wide configurations can be stored in /etc/oxidized/config, this might be
useful for storing for example source information, if many users are using
oxs/Oxidized::Script, which would allow user specific config only to include
-username+password
-
+username+password.