Browse Source

toc addition

test-string
Fred Posner 4 years ago
parent
commit
ebbb2e93a9
No known key found for this signature in database GPG Key ID: ABAD515F42AE1A40
1 changed files with 21 additions and 0 deletions
  1. +21
    -0
      README.md

+ 21
- 0
README.md View File

@ -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


Loading…
Cancel
Save