Skip to content

Commit

Permalink
Client stuff format and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Jose Antonio izquierdo lopez committed Oct 23, 2020
1 parent be65c6d commit d4444c9
Showing 1 changed file with 10 additions and 16 deletions.
26 changes: 10 additions & 16 deletions source/main/OwlHClient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ configuration is in the same folder as well as logs will be store in this folder
configuration file conf.json looks like this:

::

{
"collectorIP":"10.13.1.13",
"collectorPort":"50010",
Expand All @@ -40,19 +40,13 @@ configuration file conf.json looks like this:

Be sure to update the parameters properly.

Collector IP - is you OwlH Node or OwlH Master IP that is running the STAP socket-to-network service
Collector Port - is the port on OwlH StAP service side

Cert - is deployed and build with the sh script when installing client. feel free to change as needed.

BPF - Please, take care here. as you are forwarding traffic from a host to a different one, you can create a loop or kill your network if forwarding is not right filtered. minimum filtering must include STAP service ports like in the picture

Include Interfaces - This parameter allows you to define which interfaces client must listen to. current configuration will manage enX (en0, en1, en2 etc) as well as ethX (eth0, eth1, eth2 etc). A log file for each interface will be created.

Exclude Interfaces - lets suppose you don't want to listen to en1 as per our previous sample, then you can include here en1 as an interface to exclude.

Include Nets - You will also able to filter what interfaces to listen by identifying with ip and network has the interface defined. 0.0.0.0/0 means that any ip is allowed.

Exclude IPs - again you can stop collecting from interfaces that will include the excluded ip.

Wait Time - Time between checks in minutes. if you do a configuration change, Client will restart as needed with the new configuration. If client went down or connection is lost because OwlH Stap service is done for a while, Client will try to reconnect each 'wait time'
* **Collector IP** - is you OwlH Node or OwlH Master IP that is running the STAP socket-to-network service
* **Collector Port** - is the port on OwlH StAP service side
* **Cert** - is deployed and build with the sh script when installing client. feel free to change as needed.
* **BPF** - Please, take care here. as you are forwarding traffic from a host to a different one, you can create a loop or kill your network if forwarding is not right filtered. minimum filtering must include STAP service ports like in the picture
* **Include Interfaces** - This parameter allows you to define which interfaces client must listen to. current configuration will manage enX (en0, en1, en2 etc) as well as ethX (eth0, eth1, eth2 etc). A log file for each interface will be created.
* **Exclude Interfaces** - lets suppose you don't want to listen to en1 as per our previous sample, then you can include here en1 as an interface to exclude.
* **Include Nets** - You will also able to filter what interfaces to listen by identifying with ip and network has the interface defined. 0.0.0.0/0 means that any ip is allowed.
* **Exclude IPs** - again you can stop collecting from interfaces that will include the excluded ip.
* **Wait Time** - Time between checks in minutes. if you do a configuration change, Client will restart as needed with the new configuration. If client went down or connection is lost because OwlH Stap service is done for a while, Client will try to reconnect each 'wait time'

0 comments on commit d4444c9

Please sign in to comment.