oxidized 0.21.0 → 0.22.0

data/Dockerfile

@@ -1,30 +1,58 @@
-FROM phusion/baseimage:0.9.18
-MAINTAINER Samer Abdel-Hafez <sam@arahant.net>
+# -- stage 1: backport libssh2 1.7.0 from zesty for xenial, as githubrepo hook requires it
+FROM ubuntu:xenial as libssh2-backport
+
+# set up dependencies for the build process
+RUN apt-get -yq update && \
+    apt-get -yq install build-essential chrpath debhelper dh-autoreconf libgcrypt20-dev zlib1g-dev
+
+# build libssh2 1.7.0
+WORKDIR /tmp/libssh2-build
+ADD https://launchpad.net/ubuntu/+archive/primary/+files/libssh2_1.7.0-1ubuntu1.debian.tar.xz .
+ADD https://launchpad.net/ubuntu/+archive/primary/+files/libssh2_1.7.0.orig.tar.gz .
+RUN tar xvf libssh2_1.7.0.orig.tar.gz
+WORKDIR /tmp/libssh2-build/libssh2-1.7.0
+RUN tar xvf ../libssh2_1.7.0-1ubuntu1.debian.tar.xz
+
+WORKDIR /tmp/libssh2-build/libssh2-1.7.0
+ENV DEB_BUILD_OPTIONS nocheck
+RUN dpkg-buildpackage -b
+
+# -- stage 2: build the actual oxidized container
+FROM phusion/baseimage:0.10.0
+LABEL maintainer="Samer Abdel-Hafez <sam@arahant.net>"
+
+# set up dependencies for the build process
+RUN apt-get -yq update && \
+    apt-get -yq install ruby2.3 ruby2.3-dev libsqlite3-dev libssl-dev pkg-config make cmake libssh2-1-dev git g++ libffi-dev ruby-bundler
+
+# upgrade libssh2 to self-built backport from stage 1
+COPY --from=libssh2-backport \
+    /tmp/libssh2-build/libssh2-1_1.7.0-1ubuntu1_amd64.deb \
+    /tmp/libssh2-build/libssh2-1-dev_1.7.0-1ubuntu1_amd64.deb \
+    /tmp/
+RUN dpkg -i /tmp/*.deb
 
-RUN add-apt-repository ppa:brightbox/ruby-ng && \
-	apt-get update && \
-  apt-get install -y ruby2.3 ruby2.3-dev libsqlite3-dev libssl-dev pkg-config make cmake libssh2-1-dev git g++
+# dependencies for hooks
+RUN gem install aws-sdk slack-api xmpp4r cisco_spark
 
-RUN mkdir -p /tmp/oxidized
+# build and install oxidized
 COPY . /tmp/oxidized/
 WORKDIR /tmp/oxidized
 
-RUN gem build oxidized.gemspec
-RUN gem install oxidized-*.gem
+# docker automated build gets shallow copy, but non-shallow copy cannot be unshallowed
+RUN git fetch --unshallow || true
+RUN rake install
 
 # web interface
 RUN gem install oxidized-web --no-ri --no-rdoc
 
-# dependencies for hooks
-RUN gem install aws-sdk
-RUN gem install slack-api
-
+# clean up
+WORKDIR /
 RUN rm -rf /tmp/oxidized
+RUN rm /tmp/*.deb
+RUN apt-get -yq --purge autoremove ruby-dev pkg-config make cmake ruby-bundler
 
-RUN apt-get remove -y ruby-dev pkg-config make cmake
-
-RUN apt-get -y autoremove
-
+# add runit services
 ADD extra/oxidized.runit /etc/service/oxidized/run
 ADD extra/auto-reload-config.runit /etc/service/auto-reload-config/run
 ADD extra/update-ca-certificates.runit /etc/service/update-ca-certificates/run

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,24 +1,34 @@
-# Oxidized [![Build Status](https://travis-ci.org/Shopify/oxidized.svg)](https://travis-ci.org/Shopify/oxidized) [![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized) [![Join the chat at https://gitter.im/oxidized/Lobby](https://badges.gitter.im/oxidized/Lobby.svg)](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# Oxidized
+[![Build Status](https://api.travis-ci.com/ytti/oxidized.svg)](https://travis-ci.com/ytti/oxidized)
+[![codecov.io](https://codecov.io/gh/ytti/oxidized/coverage.svg?branch=master)](https://codecov.io/gh/ytti/oxidized?branch=master)
+[![Code Climate](https://codeclimate.com/github/ytti/oxidized/badges/gpa.svg)](https://codeclimate.com/github/ytti/oxidized)
+[![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized)
+[![Join the chat at https://gitter.im/oxidized/Lobby](https://badges.gitter.im/oxidized/Lobby.svg)](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-> Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!
+Oxidized is a network device configuration backup tool. It's a RANCID replacement!
 
-[WANTED: MAINTAINER](#help-needed)
+Light and extensible, Oxidized supports over 90 operating system types.
 
-Oxidized is a network device configuration backup tool. It's a RANCID replacement!
+Feature highlights:
 
 * Automatically adds/removes threads to meet configured retrieval interval
-* Restful API to move node immediately to head-of-queue (GET/POST /node/next/[NODE])
-* Syslog udp+file example to catch config change event (ios/junos) and trigger config fetch
-  * Will signal ios/junos user who made change, which output modules can use (via POST)
-  * The git output module uses this info - 'git blame' will for each line show who made the change and when
+* Restful API to a move node immediately to head-of-queue (GET/POST /node/next/[NODE])
+* Syslog udp+file example to catch config change events (IOS/JunOS) and trigger a config fetch
+  * Will signal which IOS/JunOS user made the change, can then be used by output modules (via POST)
+  * The `git` output module uses this info - 'git blame' will show who changed each line, and when
 * Restful API to reload list of nodes (GET /reload)
 * Restful API to fetch configurations (/node/fetch/[NODE] or /node/fetch/group/[NODE])
 * Restful API to show list of nodes (GET /nodes)
 * Restful API to show list of version for a node (/node/version[NODE]) and diffs
 
-[Youtube Video: Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h)
+Check out the [Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h) video on YouTube!
+
+> :warning: [Maintainer Wanted!](#help-needed) :warning:
+>
+> Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!
+
+## Index
 
-#### Index
 1. [Supported OS Types](docs/Supported-OS-Types.md)
 2. [Installation](#installation)
     * [Debian](#debian)
@@ -32,31 +42,39 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
     * [Debugging](docs/Configuration.md#debugging)
     * [Privileged mode](docs/Configuration.md#privileged-mode)
     * [Disabling SSH exec channels](docs/Configuration.md#disabling-ssh-exec-channels)
-    * [Sources:](docs/Sources.md)
-        * [Source: CSV](docs/Sources.md#source-csv)
-        * [Source: SQL](docs/Sources.md#source-sql)
-        * [Source: SQLite](docs/Sources.md#source-sqlite)
-        * [Source: Mysql](docs/Sources.md#source-mysql)
-        * [Source: HTTP](docs/Sources.md#source-http)
-    * [Outputs:](docs/Outputs.md)
-        * [Output: GIT](docs/Outputs.md#output-git)
-        * [Output: GIT-Crypt](docs/Outputs.md#output-git-crypt)
-        * [Output: HTTP](docs/Outputs.md#output-http)
-        * [Output: File](docs/Outputs.md#output-file)
-        * [Output types](docs/Outputs.md#output-types)
+    * [Sources](docs/Sources.md)
+      * [Source: CSV](docs/Sources.md#source-csv)
+      * [Source: SQL](docs/Sources.md#source-sql)
+      * [Source: SQLite](docs/Sources.md#source-sqlite)
+      * [Source: Mysql](docs/Sources.md#source-mysql)
+      * [Source: HTTP](docs/Sources.md#source-http)
+    * [Outputs](docs/Outputs.md)
+      * [Output: GIT](docs/Outputs.md#output-git)
+      * [Output: GIT-Crypt](docs/Outputs.md#output-git-crypt)
+      * [Output: HTTP](docs/Outputs.md#output-http)
+      * [Output: File](docs/Outputs.md#output-file)
+      * [Output types](docs/Outputs.md#output-types)
     * [Advanced Configuration](docs/Configuration.md#advanced-configuration)
     * [Advanced Group Configuration](docs/Configuration.md#advanced-group-configuration)
     * [Hooks](docs/Hooks.md)
-5. [Help](#help)
-6. [Ruby API](docs/Ruby-API.md#ruby-api)
+      * [Hook: exec](docs/Hooks.md#hook-type-exec)
+      * [Hook: githubrepo](docs/Hooks.md#hook-type-githubrepo)
+      * [Hook: awssns](docs/Hooks.md#hook-type-awssns)
+      * [Hook: slackdiff](docs/Hooks.md#hook-type-slackdiff)
+      * [Hook: xmppdiff](docs/Hooks.md#hook-type-xmppdiff)
+      * [Hook: ciscosparkdiff](docs/Hooks.md#hook-type-ciscosparkdiff)
+5. [Creating and Extending Models](docs/Creating-Models.md)
+6. [Help](#help)
+7. [Ruby API](docs/Ruby-API.md#ruby-api)
     * [Input](docs/Ruby-API.md#input)
     * [Output](docs/Ruby-API.md#output)
     * [Source](docs/Ruby-API.md#source)
     * [Model](docs/Ruby-API.md#model)
 
-# Installation
+## Installation
+
+### Debian
 
-## Debian
 Install all required packages and gems.
 
 ```shell
@@ -65,8 +83,9 @@ gem install oxidized
 gem install oxidized-script oxidized-web # if you don't install oxidized-web, make sure you remove "rest" from your config
 ```
 
-## CentOS, Oracle Linux, Red Hat Linux
-On CentOS 6 / RHEL 6, install Ruby greater than 1.9.3 (for Ruby 2.1.2 installation instructions see [Installing Ruby 2.1.2 using RVM](#installing-ruby-212-using-rvm)), then install Oxidized dependencies
+### CentOS, Oracle Linux, Red Hat Linux
+
+On CentOS 6 / RHEL 6, install 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)), then install Oxidized dependencies
 
 ```shell
 yum install cmake sqlite-devel openssl-devel libssh2-devel
@@ -85,10 +104,9 @@ gem install oxidized
 gem install oxidized-script oxidized-web
 ```
 
-## FreeBSD
-[Use RVM to install Ruby v2.1.2](#installing-ruby-2.1.2-using-rvm)
+### FreeBSD
 
-Install all required packages and gems.
+[Use RVM to install Ruby v2.1.2](#installing-ruby-212-using-rvm), then install all required packages and gems:
 
 ```shell
 pkg install cmake pkgconf
@@ -96,46 +114,59 @@ gem install oxidized
 gem install oxidized-script oxidized-web
 ```
 
-## Build from Git
+Oxidized is also available via [FreeBSD ports](https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=203374):
+
+```shell
+pkg install rubygem-oxidized rubygem-oxidized-script rubygem-oxidized-web
+```
+
+### Build from Git
+
 ```shell
 git clone https://github.com/ytti/oxidized.git
 cd oxidized/
-gem build *.gemspec
-gem install pkg/*.gem
+gem install bundler
+rake install
 ```
 
-# Running with Docker
+### Running with Docker
 
-clone git repo:
+Currently, Docker Hub automatically builds the master branch as [oxidized/oxidized](https://hub.docker.com/r/oxidized/oxidized/), you can make use of this container or build your own.
 
-```
+To build your own, clone git repo:
+
+```shell
 git clone https://github.com/ytti/oxidized
 ```
 
-build container locally:
+Then, build the container locally (requires docker 17.05.0-ce or higher):
 
-```
+```shell
 docker build -q -t oxidized/oxidized:latest oxidized/
 ```
 
-create config directory in main system:
+Once you've built the container (or chosen to make use of the automatically built container in Docker Hub, which will be downloaded for you by docker on the first `run` command had you not built it), proceed as follows:
 
-```
+Create a configuration directory in the host system:
+
+```shell
 mkdir /etc/oxidized
 ```
 
-run container the first time:
-_Note: this step in only needed for creating Oxidized's configuration file and can be skipped if you already have it
+Run the container for the first time to initialize the config:
 
-```
+_Note: this step in only required for creating the Oxidized configuration file and can be skipped if you already have one._
+
+```shell
 docker run --rm -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest oxidized
 ```
+
 If the RESTful API and Web Interface are enabled, on the docker host running the container
-edit /etc/oxidized/config and modify 'rest: 127.0.0.1:8888' by 'rest: 0.0.0.0:8888'
-this will bind port 8888 to all interfaces then expose port out. [Issue #445](https://github.com/ytti/oxidized/issues/445)
+edit `/etc/oxidized/config` and modify `rest: 127.0.0.1:8888` to `rest: 0.0.0.0:8888`. This will bind port 8888 to all interfaces, and expose the port so that it could be accessed externally. [(Issue #445)](https://github.com/ytti/oxidized/issues/445)
 
-You can also use docker-compose to launch oxidized container:
-```
+Alternatively, you can use docker-compose to launch the oxidized container:
+
+```yaml
 # docker-compose.yml
 # docker-compose file example for oxidized that will start along with docker daemon
 oxidized:
@@ -149,15 +180,15 @@ oxidized:
     - /etc/oxidized:/root/.config/oxidized
 ```
 
-create the `/etc/oxidized/router.db` [See CSV Source for further info](docs/Configuration.md#source-csv)
+Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for further info):
 
-```
+```shell
 vim /etc/oxidized/router.db
 ```
 
-run container again:
+Run container again to start oxidized with your configuration:
 
-```
+```shell
 docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest
 oxidized[1]: Oxidized starting, running as pid 1
 oxidized[1]: Loaded 1 nodes
@@ -167,45 +198,49 @@ Puma 2.13.4 starting...
 * Listening on tcp://0.0.0.0:8888
 ```
 
-If you want to have the config automatically reloaded (e.g. when using a http source that changes)
+If you want to have the config automatically reloaded (e.g. when using a http source that changes):
 
-```
+```shell
 docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -e CONFIG_RELOAD_INTERVAL=3600 -t oxidized/oxidized:latest
 ```
 
-If you need to use an internal CA (e.g. to connect to an private github instance)
+If you need to use an internal CA (e.g. to connect to an private github instance):
 
-```
+```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.1.2 using RVM
 
 Install Ruby 2.1.2 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
 ```
 
 Install RVM
-```
+
+```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
-```
+
+```shell
 source /etc/profile.d/rvm.sh
 rvm install 2.1.2
 rvm use --default 2.1.2
 ```
 
-# Configuration
+## 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).
 
 It is recommended practice to run Oxidized using its own username.  This username can be added using standard command-line tools:
 
-```
+```shell
 useradd oxidized
 ```
 
@@ -215,7 +250,7 @@ To initialize a default configuration in your home directory `~/.config/oxidized
 
 You can set the env variable `OXIDIZED_HOME` to change its home directory.
 
-```
+```shell
 OXIDIZED_HOME=/etc/oxidized
 
 $ tree -L 1 /etc/oxidized
@@ -234,27 +269,25 @@ Oxidized supports [CSV](docs/Configuration.md#source-csv),  [SQLite](docs/Config
 
 ## 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 [HTT](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.
+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`.
 
 First create the directory where the CSV `output` is going to store device configs and start Oxidized once.
-```
+
+```shell
 mkdir -p ~/.config/oxidized/configs
 oxidized
 ```
 
 Now tell Oxidized where it finds a list of network devices to backup configuration from. You can either use CSV or SQLite as source. To create a CSV source add the following snippet:
 
-Note: If gpg is set to anything other than false it will attempt to decrypt the file contents
-```
+```yaml
 source:
   default: csv
   csv:
     file: ~/.config/oxidized/router.db
     delimiter: !ruby/regexp /:/
-    gpg: false
-    gpg_password: 'password'
     map:
       name: 0
       model: 1
@@ -262,7 +295,7 @@ source:
 
 Now lets create a file based device database (you might want to switch to SQLite later on). Put your routers in `~/.config/oxidized/router.db` (file format is compatible with rancid). Simply add an item per line:
 
-```
+```text
 router01.example.com:ios
 switch01.example.com:procurve
 router02.example.com:ios
@@ -270,13 +303,13 @@ router02.example.com:ios
 
 Run `oxidized` again to take the first backups.
 
-# Extra
+## Extra
 
-## Ubuntu SystemV init setup
+### Ubuntu SystemV init setup
 
 The init script assumes that you have a used named 'oxidized' and that oxidized is in one of the following paths:
 
-```
+```text
 /sbin
 /bin
 /usr/sbin
@@ -287,26 +320,26 @@ The init script assumes that you have a used named 'oxidized' and that oxidized
 1. Copy init script from extra/ folder to /etc/init.d/oxidized
 2. Setup /var/run/
 
-```
+```shell
 mkdir /var/run/oxidized
 chown oxidized:oxidized /var/run/oxidized
 ```
 
 3. Make oxidized start on boot
 
-```
+```shell
 update-rc.d oxidized defaults
 ```
 
-# Help
+## Help
 
 If you need help with Oxidized then we have a few methods you can use to get in touch.
 
-  - [Gitter](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - You can join the Lobby on gitter to chat to other Oxidized users.
-  - [GitHub](https://github.com/ytti/oxidized/) - For help and requests for code changes / updates.
-  - [Forum](https://community.librenms.org/c/help/oxidized) - A user forum run by [LibreNMS](https://github.com/librenms/librenms) where you can ask for help and support.
+* [Gitter](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - You can join the Lobby on gitter to chat to other Oxidized users.
+* [GitHub](https://github.com/ytti/oxidized/) - For help and requests for code changes / updates.
+* [Forum](https://community.librenms.org/c/help/oxidized) - A user forum run by [LibreNMS](https://github.com/librenms/librenms) where you can ask for help and support.
 
-# Help Needed
+## Help Needed
 
 As things stand right now, `oxidized` is maintained by a single person. A great
 many [contributors](https://github.com/ytti/oxidized/graphs/contributors) have
@@ -341,13 +374,12 @@ Brian Anderson (from Rust fame) wrote an [excellent
 post](http://brson.github.io/2017/04/05/minimally-nice-maintainer) on what it
 means to be a maintainer.
 
-# License and Copyright
+## License and Copyright
 
           Copyright
           2013-2015 Saku Ytti <saku@ytti.fi>
           2013-2015 Samer Abdel-Hafez <sam@arahant.net>
 
-
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at