From 4689c25db4363af4263e0f515b239d3295c3de12 Mon Sep 17 00:00:00 2001
From: Alessio Cassibba <swapon@gmail.com>
Date: Fri, 4 Sep 2015 00:17:28 +0200
Subject: [PATCH] Update README.md

---
 README.md | 107 +++++++++++++++++++++++++-----------------------------
 1 file changed, 49 insertions(+), 58 deletions(-)

diff --git a/README.md b/README.md
index 326529d..48b8cdd 100644
--- a/README.md
+++ b/README.md
@@ -3,64 +3,6 @@ ansible-rsyslog
 
 This role installs and configures rsyslog.
 
-Requirements
-------------
-
-None at this time.
-
-Default Role Variables
---------------
-
-By default this role will provide a minimal configuration
-
-**rsyslog_main_config**: Main config file path (default: "/etc/rsyslog.conf")
-
-**rsyslog_include_path**: Path of additional config stanzas (default: "/etc/rsyslog.d")
-
-**rsyslog_file_mode**: Default mode for configuration files (default: "0640")
-
-**rsyslog_file_create_mode**: Default mode for new files created by rsyslog  (default "0640")
-
-**rsyslog_umask**: Specify the rsyslogd processes' umask (default "0022")
-
-**rsyslog_abort_on_unclean_config**: Check config syntax on startup and abort if unclean (default: off)
-
-**rsyslog_repeated_msg_reduction**: Reduce repeating messages (default: off)
-
-**rsyslog_action_file_default_template**: Use the default, traditional logformat, as default for loggin (default: RSYSLOG_TraditionalFileFormat)
-
-**rsyslog_action_file_template**: Define only when a custom logformat is neeed (default: undefined)
-
-**rsyslog_priv_drop_to_user**: Name of the user rsyslog should run under after startup (default: undefined)
-
-**rsyslog_priv_drop_to_group**: Name of the group rsyslog should run under after startup (default: undefined)
-
-**rsyslog_default_config**: Setup a default basic configuration stanza (default: "True")
-
-
-Dependencies
-------------
-
-None at this time.
-
-Example Playbook
-----------------
-
-    - name: Apply rsyslog role
-      remote_user: root
-      hosts: all
-      sudo: no
-    - role: rsyslog
-      items:
-      - name: "20-iptables"
-        lines: 
-          - ':msg, contains, "iptables" /var/log/iptables.log'
-          - '& ~'
-      - name: "30-dovecot"
-        lines: 
-          - 'if $programname == 'dovecot' and $syslogseverity <= '6' then ~'
-          - '& ~'
-
 Supported Platforms
 -------------------
 
@@ -75,6 +17,55 @@ It will likely run on other platforms, just drop in vars/ a new file to support
 * {{ ansible_os_family }}_{{ ansible_distribution_major_version }}.yml
 * {{ ansible_os_family }}.yml"
 
+Requirements
+------------
+
+None at this time.
+
+Default Role Variables
+--------------
+
+By default this role will install rsyslog and provide a minimal configuration, however variables can be passed to this role
+and configuration can be overridden, for additional informations please have a look to **defaults/main.yml**
+
+
+**rsyslog_default_config**: Setup a default basic configuration stanza (default: "True")
+
+
+Dependencies
+------------
+
+None at this time.
+
+Example Playbook
+----------------
+1) Just install rsyslog with default configuration (it will be placed in /etc/rsyslog.d/)
+```yaml
+- hosts: all
+  remote_user: root
+  sudo: no
+  - roles: 
+    - {{ role: rsyslog }}
+```
+2) Install rsyslog, without default configuration and setup two different custom stanzas
+```yaml
+- hosts: all
+  remote_user: root
+  sudo: no
+  - vars:
+    rsyslog_default_config: False
+  - role: rsyslog
+    items:
+      - name: "20-iptables"
+        lines: 
+          - ':msg, contains, "iptables" /var/log/iptables.log'
+          - '& ~'
+      - name: "30-dovecot"
+        lines: 
+          - 'if $programname == 'dovecot' and $syslogseverity <= '6' then ~'
+          - '& ~'
+```
+
 License
 -------