From ebbb2e93a92139fd496337b78ccf1f51e4969be9 Mon Sep 17 00:00:00 2001 From: Fred Posner Date: Fri, 15 Oct 2021 10:10:38 -0400 Subject: [PATCH] toc addition --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index e659446..df5c64c 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,25 @@ Very simple API for managing local iptables chain: `APIBANLOCAL` Simple `GET` actions of add, remove, and flush (see [API usage](#API-usage) for more). +## Contents + +* [Super Lazy Install](#super-lazy-install) +* [Usage](#usage) + * [Default Settings](#default-settings) + * [Example with flags](#example-with-flags) +* [Running as a Service (example)](#running-as-a-service-example) +* [Kamailio Example](#kamailio-example) +* **[API Usage](#api-usage)** + * [Add/Block IP](#addblock-ip) + * [Remove/Unblock IP](#removeunblock-ip) + * [Push IP](#push-ip) + * [Flush APIBANLOCAL chain](#flush-apibanlocal-chain) +* [License / Warranty](#license--warranty) + ## Super Lazy Install +Please at least look at the script before blindly running it on your system. + `curl -sSL https://raw.githubusercontent.com/palner/iptables-api/main/install_iptables-api.sh | bash` (or for a Pi) @@ -14,6 +31,10 @@ Simple `GET` actions of add, remove, and flush (see [API usage](#API-usage) for ## Usage +It is recommended that you run iptables-api [as a service](#running-as-a-service-example), however you can run it however you like. + +To run, simply set exe permissions (such as `chmod 755 iptables-api`) and run: + `./iptables-api` ### Default Settings