From fe09dd1513b093ddb4c225ca6702a35ec14f46ce Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Thu, 30 Jan 2020 22:58:49 +0100 Subject: [PATCH] cleanup readme --- README.md | 90 ++++--------------------------------------------------- 1 file changed, 6 insertions(+), 84 deletions(-) diff --git a/README.md b/README.md index 38bc68d..d7593cb 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,14 @@ # xoxys.iptables - -[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.iptables/status.svg)](https://drone.rknet.org/ansible/xoxys.iptables) + +[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.iptables?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.iptables) Role to manage iptables -## Table of content +### License -* [Default Variables](#default-variables) - * [iptables_app_rules](#iptables_app_rules) - * [iptables_app_rules_extra](#iptables_app_rules_extra) - * [iptables_custom_rules](#iptables_custom_rules) - * [iptables_default_head](#iptables_default_head) - * [iptables_default_tail](#iptables_default_tail) - * [iptables_keep_unmanaged](#iptables_keep_unmanaged) -* [Dependencies](#dependencies) -* [License](#license) -* [Author](#author) +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ---- +### Maintainers and Contributors -## Default Variables - -### iptables_app_rules - -#### Default value - -```YAML -iptables_app_rules: [] -``` - -### iptables_app_rules_extra - -#### Default value - -```YAML -iptables_app_rules_extra: [] -``` - -### iptables_custom_rules - -#### Default value - -```YAML -iptables_custom_rules: [] -``` - -### 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_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](https://gitea.rknet.org/xoxys) +[Robert Kaussow](https://gitea.rknet.org/xoxys)