README.md in oxidized-0.25.1 vs README.md in oxidized-0.26.0
- old
+ new
@@ -35,11 +35,11 @@
* [Debian and Ubuntu](#debian-and-ubuntu)
* [CentOS, Oracle Linux, Red Hat Linux](#centos-oracle-linux-red-hat-linux)
* [FreeBSD](#freebsd)
* [Build from Git](#build-from-git)
* [Docker](#running-with-docker)
- * [Installing Ruby 2.1.2 using RVM](#installing-ruby-212-using-rvm)
+ * [Installing Ruby 2.3 using RVM](#installing-ruby-23-using-rvm)
3. [Initial Configuration](#configuration)
4. [Configuration](docs/Configuration.md)
* [Debugging](docs/Configuration.md#debugging)
* [Privileged mode](docs/Configuration.md#privileged-mode)
* [Disabling SSH exec channels](docs/Configuration.md#disabling-ssh-exec-channels)
@@ -84,11 +84,11 @@
```
Install the dependencies:
```shell
-apt-get install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev libicu-dev zlib1g-dev
+apt-get install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev libicu-dev zlib1g-dev g++
```
Finally, install the gems:
```shell
@@ -96,34 +96,38 @@
gem install oxidized-script oxidized-web # If you don't install oxidized-web, ensure "rest" is removed from your Oxidized config.
```
### CentOS, Oracle Linux, Red Hat Linux
-On CentOS 6 / RHEL 6, begin by installing Ruby 2.0 or greater. For Ruby 2.1.2 installation instructions see [Installing Ruby 2.1.2 using RVM](#installing-ruby-212-using-rvm).
+On CentOS 6 and 7 / RHEL 6 and 7, begin by installing Ruby 2.3 or greater. This can be accomplished in one of two ways:
-If you've installed Ruby 2.0 or greater via a 3rd party package rather than the RVM instructions, additional dependencies will be required:
+Install Ruby 2.3 from [SCL](https://www.softwarecollections.org/en/scls/rhscl/rh-ruby23/):
```shell
-yum install make cmake which sqlite-devel openssl-devel libssh2-devel ruby gcc ruby-devel libicu-devel gcc-c++
+yum install centos-release-scl
+yum install rh-ruby23
+scl enable rh-ruby23 bash
```
-RHEL 7 / CentOS 7 will work out of the box with the following package list:
+The following additional packages will be required to build the dependencies:
```shell
yum install make cmake which sqlite-devel openssl-devel libssh2-devel ruby gcc ruby-devel libicu-devel gcc-c++
```
-Now let's install oxidized via Rubygems:
+Alternatively, install Ruby 2.3 by following the instructions at [Installing Ruby 2.3 using RVM](#installing-ruby-23-using-rvm).
+Finally, install oxidized via Rubygems:
+
```shell
gem install oxidized
gem install oxidized-script oxidized-web # if you don't install oxidized-web, make sure you remove "rest" from your config
```
### FreeBSD
-[Use RVM to install Ruby v2.1.2](#installing-ruby-212-using-rvm), then install all required packages and gems:
+[Use RVM to install Ruby v2.3](#installing-ruby-23-using-rvm), then install all required packages and gems:
```shell
pkg install cmake pkgconf
gem install oxidized
gem install oxidized-script oxidized-web
@@ -223,13 +227,13 @@
```shell
docker run -v /etc/oxidized:/root/.config/oxidized -v /path/to/MY-CA.crt:/usr/local/share/ca-certificates/MY-CA.crt -p 8888:8888/tcp -e UPDATE_CA_CERTIFICATES=true -t oxidized/oxidized:latest
```
-### Installing Ruby 2.1.2 using RVM
+### Installing Ruby 2.3 using RVM
-Install Ruby 2.1.2 build dependencies
+Install Ruby 2.3 build dependencies
```shell
yum install curl gcc-c++ patch readline readline-devel zlib zlib-devel
yum install libyaml-devel libffi-devel openssl-devel make cmake
yum install bzip2 autoconf automake libtool bison iconv-devel libssh2-devel libicu-devel
@@ -239,16 +243,16 @@
```shell
curl -L get.rvm.io | bash -s stable
```
-Setup RVM environment and compile and install Ruby 2.1.2 and set it as default
+Setup RVM environment and compile and install Ruby 2.3 and set it as default
```shell
source /etc/profile.d/rvm.sh
-rvm install 2.1.2
-rvm use --default 2.1.2
+rvm install 2.3
+rvm use --default 2.3
```
## Configuration
Oxidized configuration is in YAML format. Configuration files are subsequently sourced from `/etc/oxidized/config` then `~/.config/oxidized/config`. The hashes will be merged, this might be useful for storing source information in a system wide file and user specific configuration in the home directory (to only include a staff specific username and password). Eg. if many users are using `oxs`, see [Oxidized::Script](https://github.com/ytti/oxidized-script).
@@ -284,10 +288,10 @@
## Outputs
Possible outputs are either [File](docs/Configuration.md#output-file), [GIT](docs/Configuration.md#output-git), [GIT-Crypt](docs/Configuration.md#output-git-crypt) and [HTTP](docs/Configuration.md#output-http). The file backend takes a destination directory as argument and will keep a file per device, with most recent running version of a device. The GIT backend (recommended) will initialize an empty GIT repository in the specified path and create a new commit on every configuration change. The GIT-Crypt backend will also initialize a GIT repository but every configuration push to it will be encrypted on the fly by using `git-crypt` tool. Take a look at the [Configuration](docs/Configuration.md) for more details.
-Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if `use_syslog`(requires Ruby >= 2.0) is set to `true`.
+Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if `use_syslog` is set to `true`.
First create the directory where the CSV `output` is going to store device configs and start Oxidized once.
```shell
mkdir -p ~/.config/oxidized/configs