summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols/md-igmp-proxy.md
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
commit5d6fa52b8985f8068314aba26878a1d7d5cb84e5 (patch)
tree99359ff282846e26b5c5fa2b9b176b35b172809f /docs/configuration/protocols/md-igmp-proxy.md
parent631e454d674ad5111d2b56a6964ead461894a1f6 (diff)
downloadvyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.tar.gz
vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.zip
feat: flip swap mechanism — MD as primary, RST as override (Phase 1)
This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io
Diffstat (limited to 'docs/configuration/protocols/md-igmp-proxy.md')
-rw-r--r--docs/configuration/protocols/md-igmp-proxy.md79
1 files changed, 0 insertions, 79 deletions
diff --git a/docs/configuration/protocols/md-igmp-proxy.md b/docs/configuration/protocols/md-igmp-proxy.md
deleted file mode 100644
index 961f921b..00000000
--- a/docs/configuration/protocols/md-igmp-proxy.md
+++ /dev/null
@@ -1,79 +0,0 @@
----
-lastproofread: '2023-11-13'
----
-
-(igmp-proxy)=
-
-# IGMP Proxy
-
-{abbr}`IGMP (Internet Group Management Protocol)` proxy sends IGMP host messages
-on behalf of a connected client. The configuration must define one, and only one
-upstream interface, and one or more downstream interfaces.
-
-## Configuration
-
-```{cfgcmd} set protocols igmp-proxy interface \<interface\> role \<upstream | downstream\>
-
-* **upstream:** The upstream network interface is the outgoing interface
-which is responsible for communicating to available multicast data sources.
-There can only be one upstream interface.
-
-* **downstream:** Downstream network interfaces are the distribution
-interfaces to the destination networks, where multicast clients can join
-groups and receive multicast data. One or more downstream interfaces must
-be configured.
-```
-
-```{cfgcmd} set protocols igmp-proxy interface \<interface\> alt-subnet \<network\>
-
-Defines alternate sources for multicasting and IGMP data. The network address
-must be on the following format 'a.b.c.d/n'. By default, the router will
-accept data from sources on the same network as configured on an interface.
-If the multicast source lies on a remote network, one must define from where
-traffic should be accepted.
-
-This is especially useful for the upstream interface, since the source for
-multicast traffic is often from a remote location.
-
-This option can be supplied multiple times.
-```
-
-```{cfgcmd} set protocols igmp-proxy disable-quickleave
-
-Disables quickleave mode. In this mode the daemon will not send a Leave IGMP
-message upstream as soon as it receives a Leave message for any downstream
-interface. The daemon will not ask for Membership reports on the downstream
-interfaces, and if a report is received the group is not joined again the
-upstream.
-
-If it's vital that the daemon should act exactly like a real multicast client
-on the upstream interface, this function should be enabled.
-
-Enabling this function increases the risk of bandwidth saturation.
-```
-
-```{cfgcmd} set protocols igmp-proxy disable
-
-Disable this service.
-```
-
-(igmp-proxy-example)=
-
-### Example
-
-Interface eth1 LAN is behind NAT. In order to subscribe 10.0.0.0/23 subnet
-multicast which is in eth0 WAN we need to configure igmp-proxy.
-
-```none
-set protocols igmp-proxy interface eth0 role upstream
-set protocols igmp-proxy interface eth0 alt-subnet 10.0.0.0/23
-set protocols igmp-proxy interface eth1 role downstream
-```
-
-
-## Operation
-
-```{opcmd} restart igmp-proxy
-
-Restart the IGMP proxy process.
-``` \ No newline at end of file