diff --git a/README.md b/README.md index 0e296b8..a4d5444 100644 --- a/README.md +++ b/README.md @@ -8,26 +8,11 @@ This daemon is an IGMP querier helper for the Linux bridge. Configuration ------------- -```ApacheConf -# Global settings followed by per-interface enable/disable of features +By default `querierd` is passive on all interfaces. To activate IGMPv3 +querier, add whitespace separated interface names to the .conf file. -# Query interval can be [1,1024], default 125. Recommended not go below 10 -#igmp-query-interval 125 - -# Last member query interval [1,1024], default 1. The igmp-robustness -# setting controls the last member query count. -#igmp-query-last-member-interval 1 - -# Robustness can be [2,10], default 2. Recommended to use 2 -#igmp-robustness 2 - -# IP Option Router Alert is enabled by default -#no router-alert - -# Disble all, or enable plus one of the IGMP versions, wich is the startup -# version, with fallback to older versions if older clients appear. -# iface [enable | disable] [igmpv1 | igmpv2 | igmpv3] -``` +> **Note:** this is a temporary file format, a later release will include +> more advanced settings, without being backwards compatible! Origin & References diff --git a/TODO.md b/TODO.md index 4d57c17..a7ab912 100644 --- a/TODO.md +++ b/TODO.md @@ -6,7 +6,31 @@ Ideas for v1.0 - granular enable/disable of IGMP/MLD - configurable query interval - static join - - add basic README.md - - add initial ChangeLog.md + - see proposal below - Update Makefile.am, include text files in dist - - add release.yml for automatic releases on tag + + +.conf file format +----------------- + +```ApacheConf +# Global settings followed by per-interface enable/disable of features + +# Query interval can be [1,1024], default 125. Recommended not go below 10 +#igmp-query-interval 125 + +# Last member query interval [1,1024], default 1. The igmp-robustness +# setting controls the last member query count. +#igmp-query-last-member-interval 1 + +# Robustness can be [2,10], default 2. Recommended to use 2 +#igmp-robustness 2 + +# IP Option Router Alert is enabled by default +#no router-alert + +# Disble all, or enable plus one of the IGMP versions, wich is the startup +# version, with fallback to older versions if older clients appear. +#iface [enable | disable] [igmpv1 | igmpv2 | igmpv3] +``` +