Skip to content

Commit

Permalink
feat(dpi): add instructions for excluding interfaces in Netifyd (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
stephdl authored Dec 18, 2024
1 parent d6ba879 commit 765e706
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion dpi_filter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,37 @@ To add a new exception, click the ``Add exception`` button.
Enter the ``IP address`` that should be exempted from the filter.
You can include a description explaining the reason for the exclusion.

Each exception can be enabled or disabled as desired.
Each exception can be enabled or disabled as desired.

Netify interface exclusion
--------------------------

By default, Netifyd monitors all interfaces. To exclude specific interfaces, you can define an exclusion list. Below are commands to add, modify, or remove excluded interfaces.
The exclusion list is configured using the ``ns_exclude`` option that takes a list of patterns. Each entry is a shel glob pattern.

- Add interfaces to exclusion list. The system will exclude the `eth1` interface and all OpenVPN and WireGuard interfaces: ::

uci add_list netifyd.@netifyd[0].ns_exclude='eth1'
uci add_list netifyd.@netifyd[0].ns_exclude='tun*'
uci add_list netifyd.@netifyd[0].ns_exclude='wg*'
uci commit netifyd
echo '{"changes": {"network": {}}}' | /usr/libexec/rpcd/ns.commit call commit

In this this case the system will exclude interface ``eth1``, all WireGuard ``wgX`` interfaces and all OpenVPN routed interfaces.
- Modify exclusion list: ::

uci delete netifyd.@netifyd[0].ns_exclude='eth1'
uci add_list netifyd.@netifyd[0].ns_exclude='eth2'
uci commit netifyd
echo '{"changes": {"network": {}}}' | /usr/libexec/rpcd/ns.commit call commit

- Clear exclusion list: ::

uci delete netifyd.@netifyd[0].ns_exclude
uci commit netifyd
echo '{"changes": {"network": {}}}' | /usr/libexec/rpcd/ns.commit call commit

- Return the exclusion list: ::

uci show netifyd.@netifyd[0].ns_exclude

0 comments on commit 765e706

Please sign in to comment.