Skip to content

Commit 6999675

Browse files
committed
minor docs updates
1 parent 71aba7d commit 6999675

File tree

4 files changed

+54
-0
lines changed

4 files changed

+54
-0
lines changed

docs/source/plugins/firewall_netfilter.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,24 @@ Optional: To get a more readable JSON-output, you can use the :code:`jq` tool to
2323
2424
sudo nft -j list ruleset | jq > ruleset.json
2525
26+
----
27+
28+
Run
29+
###
30+
31+
Here is an example on how to run supply the exported config:
32+
33+
.. code-block:: bash
34+
35+
ftf-cli --firewall-system 'linux_netfilter' \
36+
--file-ruleset 'ruleset.json' \
37+
--file-interfaces 'interfaces.json' \
38+
--file-routes 'routes.json' \
39+
--file-route-rules 'route-rules.json' \
40+
--src-ip 172.17.11.5 \
41+
--dst-ip 1.1.1.1
42+
43+
It also requires the exported config of **interfaces**, **routes** and **route-rules** :ref:`for the Linux system <plugins_sys_linux>`!
2644

2745
----
2846

docs/source/plugins/firewall_opnsense.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ Config Export
1919

2020
----
2121

22+
Run
23+
###
24+
25+
tbd
26+
27+
----
28+
2229
Source Code
2330
###########
2431

docs/source/plugins/system_linux.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,25 @@ Optional: To get a more readable JSON-output, you can use the :code:`jq` tool to
3131
3232
----
3333

34+
Run
35+
###
36+
37+
Here is an example on how to run supply the exported config:
38+
39+
.. code-block:: bash
40+
41+
ftf-cli --firewall-system 'linux_netfilter' \
42+
--file-interfaces 'interfaces.json' \
43+
--file-routes 'routes.json' \
44+
--file-route-rules 'route-rules.json' \
45+
--file-ruleset 'ruleset.json' \
46+
--src-ip 172.17.11.5 \
47+
--dst-ip 1.1.1.1
48+
49+
It also requires the exported **ruleset**-config :ref:`of the Netfilter firewall <plugins_fw_netfilter>`!
50+
51+
----
52+
3453
Source Code
3554
###########
3655

ftf-cli

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/usr/bin/env bash
2+
3+
# This is just a wrapper for the development environment
4+
# the actual 'ftf-cli' command is provided via pyproject.toml / pip install
5+
6+
set -euo pipefail
7+
8+
cd "$(dirname "$0")"
9+
10+
python3 src/firewall_test/cli.py $@

0 commit comments

Comments
 (0)