Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please improve documentation #124

Open
bschoelpen opened this issue Apr 23, 2023 · 0 comments
Open

Please improve documentation #124

bschoelpen opened this issue Apr 23, 2023 · 0 comments

Comments

@bschoelpen
Copy link

To be honest, the documentation is quite poor and should be improved. Just one example:

I'm using OMV with several docker images / containers and I was trying to set up autoshutdown. My intention was, to check against network traffic on EXTERNAL network interfaces, so I came across the RANGE parameter. My first try was to leave the default setting and the system was not shutodown, because of recognized traffic on the (internal) network interfaces between the docker containers and the host. So I tried to configure the RANGE param to watch on the external network interface only. The doc states:

> RANGE="2..254,0x0..0xFFFF"
>     # Define a range of IPs which should be scanned. (default="2..254,
>     # 0x0..0xFFFF"). The 'RANGE' should be comma delimited list of the
>     # following:
>     # - Define an IPv4 range: <START>..<END> | iface@<START>..<END> |
>     #                         www.xxx.yyy.<START>..<END> |
>     #                         [email protected].<START>..<END>
>     # - Define a single IPv4: Last octet of IPv4 zzz | iface@zzz |
>     #                         www.xxx.yyy.zzz | [email protected]
>     # - Define an IPv6 range: 0x<START>..0x<END> | iface@0x<START>..0x<END> |
>     #                         s:t:u:v:w:x:y:0x<START>..0x<END> |
>     #                         iface@s:t:u:v:w:x:y:0x<START>..0x<END>
>     # - Define a single IPv6: Last hextet of IPv6 0xzzzz | iface@0xzzzz |
>     #                         s:t:u:v:w:x:y:z | iface@s:t:u:v:w:x:y:z"
>     # - Define by FQDN      : fqdn | iface@fqdn
>     # If '<START>..<END>' or 'Last octet of IPv4' is set the first three octets
>     # of the iface IPv4 address are used. If '0x<START>..0x<END>' or 'Last
>     # hextet of IPv6' is set the first seven hextets of the iface IPv6 address
>     # is used. Please make sure to leave 1 and 255 out of the IPv4 range!

For my understanding of the above, I should be able to define an IP range on a specific interface only (e.g. wlp2s0) by changing 2..254,0x0..0xFFFF to [email protected],[email protected], which was rejected as invalid configuration as I saw in the logfile.

So please explain, how this is supposed to work. In addition to this example, there are many other wordings in the documenation, which are not quite clear to me, so I suggest that the docs should be checked / revised thoroughly. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant