dd0ade161c0fc47ea4a9e43ce3787170db2f8f60
- Author
- Alex Morozoff <a.j.morozoff@gmail.com>
- Committer
- GitHub <noreply@github.com>
- Date
Message
Create README.md
Added README for UFW plugin issue: [Good first PR] Add READMEs to undocumented plugins #7175
Diff
1diff --git a/plugins/ufw/README.md b/plugins/ufw/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..a27487a46b0f4e483eb8b91d98f1ccd95660905f
4--- /dev/null
5+++ b/plugins/ufw/README.md
6@@ -0,0 +1,17 @@
7+# UFW
8+This plugin adds support for managing everybody's favorite Uncomplicated Firewall (UFW). Learn more about [`UFW`](https://wiki.ubuntu.com/UncomplicatedFirewall).
9+
10+To use it, add ufw to the plugins array of your zshrc file:
11+```
12+plugins=(... ufw)
13+```
14+UFW is a simple Ubuntu interface for managing iptables.
15+
16+Some of the commands include:
17+
18+* `allow <port>/<optional: protocol>` add an allow rule
19+* `default` set default policy
20+* `delete <port>/<optional: protocol>` delete RULE
21+* `deny <port>/<optional: protocol>` add deny rule
22+* `disable` disables the firewall
23+* `enable` enables the firewall