add VPS utils

[webi-installers/.git] / vps-utils / README.md

diff --git a/vps-utils/README.md b/vps-utils/README.md
new file mode 100644 (file)
index 0000000..3dbce19
--- /dev/null
+++ b/vps-utils/README.md
@@ -0,0 +1,47 @@
+---
+title: VPS Utils
+homepage: https://webinstall.dev/vps-utils
+tagline: |
+  VPS Utils make it easy to setup and manage a VPS
+description: |
+  VPS Utils includes shortcut commands for some common tasks, including `cap-net-bind`, 'vps-addswap', and 'vps-myip'
+---
+
+**cap-net-bind**:
+
+`cap-net-bind` will give the specified program the ability to listen on
+privileged ports, such as 80 (http) and 443 (https) without `root` privileges or
+`sudo`.
+
+```bash
+sudo cap-net-bind node
+```
+
+This is the same as running the full command:
+
+```bash
+setcap 'cap_net_bind_service=+ep' $(readlink -f $(which node))
+```
+
+**vps-myip**:
+
+Will output externally detected IPv4 and IPv6 addresses. See
+<https://webinstall.dev/vps-myip>.
+
+```bash
+vps-myip
+```
+
+```txt
+IPv4 (A)   : 136.36.196.101
+IPv6 (AAAA): 2605:a601:a919:9800:f8be:f2c4:9ad7:9763
+```
+
+**vps-addswap**:
+
+Adds and activates permanent swap in `/var/swapfile`. See
+<https://webinstall.dev/vps-addswap>.
+
+```bash
+vps-addswap
+```