From 672b9d79b543a48e85bc50aeace7e4250c7d9a8b Mon Sep 17 00:00:00 2001 From: DroneShipper Date: Thu, 17 Oct 2019 19:03:55 +0000 Subject: [PATCH] [SKIP CI] update readme --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 73 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b6add3c..d31dd2f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,74 @@ -# ansible_iptables +# xoxys.iptables + +[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.iptables/status.svg)](https://drone.rknet.org/ansible/xoxys.iptables) + +Rule to manage iptables + +## Table of content + +* [Default Variables](#default-variables) + * [iptables_default_head](#iptables_default_head) + * [iptables_default_tail](#iptables_default_tail) + * [iptables_custom_rules](#iptables_custom_rules) + * [iptables_keep_unmanaged](#iptables_keep_unmanaged) +* [Dependencies](#dependencies) +* [License](#license) +* [Author](#author) + +--- + +## Default Variables + +### iptables_default_head + +Default head (allow) rules. + +#### Default value + +```YAML +iptables_default_head: "-P INPUT ACCEPT\n-P FORWARD ACCEPT\n-P OUTPUT ACCEPT\n-A INPUT\ + \ -m state --state RELATED,ESTABLISHED -j ACCEPT\n-A INPUT -i lo -j ACCEPT\n-A INPUT\ + \ -p icmp --icmp-type echo-request -j ACCEPT\n-A INPUT -p tcp -m tcp --dport 22\ + \ -j ACCEPT\n" +``` + +### iptables_default_tail + +Default tail (deny) rules. + +#### Default value + +```YAML +iptables_default_tail: "-A INPUT -j REJECT\n-A FORWARD -j REJECT\n" +``` + +### iptables_custom_rules + +#### Default value + +```YAML +iptables_custom_rules: [] +``` + +### iptables_keep_unmanaged + +By default this role deletes all iptables rules which are not managed by Ansible. Set this to 'yes', if you want the role to keep unmanaged rules. + +#### Default value + +```YAML +iptables_keep_unmanaged: no +``` + +## Dependencies + +None. + +## License + +MIT + +## Author + +xoxys