Skip to content

Commit

Permalink
Installation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
fboender committed Jun 13, 2015
1 parent 353fedb commit ecf7030
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@ with custom data.

[HTML example](https://rawgit.com/fboender/ansible-cmdb/master/example/cmdb.html) output.

Installation
------------

Get the package for your distribution from the [Releases page](https://github.com/fboender/ansible-cmdb/releases)

For **Debian / Ubuntu** systems:

sudo dpkg -i ansible-cmdb**.deb

For **Redhat / Centos** systems:

sudo yum -i -i ansible-cmdb**.rpm

For **Other** systems:

tar -vxzf ansible-cmdb*.tar.gz
cd ansible-cmdb*
sudo make install

Usage
-----
Expand All @@ -26,15 +44,15 @@ First, generate Ansible output for your hosts:
Next, call ansible-cmdb on the resulting `out/` directory to generate the CMDB
overview page:

./ansible_cmdb out/ > overview.html
ansible_cmdb out/ > overview.html


### Templates

ansible-cmdb offers multiple templates. You can choose your template with the
`-t` or `--template` argument:

./ansible-cmdb -t tpl_custom out/ > overview.html
ansible-cmdb -t tpl_custom out/ > overview.html

The 'html_fancy' template is the default. It can be easily extended by copying
it and modifying the `cols` definition at the top. It should be served over
Expand Down Expand Up @@ -137,7 +155,7 @@ Your custom variables will be put in the root of the host information dictionary

### Full usage

Usage: ./ansible-cmd [option] > output.html
Usage: ansible-cmd [option] > output.html

Options:
-h, --help show this help message and exit
Expand Down

0 comments on commit ecf7030

Please sign in to comment.