Skip to content

Commit

Permalink
improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
buixor authored Dec 13, 2020
1 parent 27cb84a commit 1fe80ec
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,24 @@ api_url: <API_URL> # when install, default is "localhost:8080"
api_key: <API_KEY> # Add your API key generated with `cscli bouncers add --name <bouncer_name>`
```
- `mode` can be set to `iptables` or `nftables`
- `update_frequency` controls how often the bouncer is going to query the local API
- `api_url` and `api_key` control local API parameters.

You can then start the service:

```sh
sudo systemctl start cs-firewall-bouncer
```

### iptables vs nftables

The bouncer supports two modes : `iptables` or `nftables`.
When using `nftables`, it doesn't directly rely on any available command, but rather on github.com/google/nftables.
When using `iptables`, it relies on `iptables` and `ipset` commands.






0 comments on commit 1fe80ec

Please sign in to comment.