summaryrefslogtreecommitdiff
path: root/plugins/ufw
diff options
context:
space:
mode:
authorAlex Morozoff <a.j.morozoff@gmail.com>2019-10-06 15:24:25 -0400
committerGitHub <noreply@github.com>2019-10-06 15:24:25 -0400
commitdd0ade161c0fc47ea4a9e43ce3787170db2f8f60 (patch)
tree06632a11bdecdc13ef22af903cf777604689f61a /plugins/ufw
parent3848102a5ec8534cef935d594c6abcbfc0f419c8 (diff)
downloadzsh-dd0ade161c0fc47ea4a9e43ce3787170db2f8f60.tar.gz
zsh-dd0ade161c0fc47ea4a9e43ce3787170db2f8f60.tar.bz2
zsh-dd0ade161c0fc47ea4a9e43ce3787170db2f8f60.zip
Create README.md
Added README for UFW plugin issue: [Good first PR] Add READMEs to undocumented plugins #7175
Diffstat (limited to 'plugins/ufw')
-rw-r--r--plugins/ufw/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/ufw/README.md b/plugins/ufw/README.md
new file mode 100644
index 000000000..a27487a46
--- /dev/null
+++ b/plugins/ufw/README.md
@@ -0,0 +1,17 @@
+# UFW
+This plugin adds support for managing everybody's favorite Uncomplicated Firewall (UFW). Learn more about [`UFW`](https://wiki.ubuntu.com/UncomplicatedFirewall).
+
+To use it, add ufw to the plugins array of your zshrc file:
+```
+plugins=(... ufw)
+```
+UFW is a simple Ubuntu interface for managing iptables.
+
+Some of the commands include:
+
+* `allow <port>/<optional: protocol>` add an allow rule
+* `default` set default policy
+* `delete <port>/<optional: protocol>` delete RULE
+* `deny <port>/<optional: protocol>` add deny rule
+* `disable` disables the firewall
+* `enable` enables the firewall