adam/rc.router
SHA256
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation fixes and improvements

Browse Source
This commit is contained in:
ADAM David Alan Martin
2026-05-12 01:43:27 -04:00
parent f402f728e5
commit 672f02efc6
5 changed files with 117 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/add_canned_isp.md
+6
View File
@@ -31,6 +31,12 @@ user-defined ISP hints.
ISPs are always configured as `dhcp` for IPv4. For custom static provisioning,
other methods of provisioning these interfaces can be used.
## Example
```
# Connect to Verizon FIOS over `abc0`, and name the connection `main_isp`.
add_canned_isp abc0 main_isp verizon_fios
```
## See Also
- [`add_net`](add_net.md)
docs/add_net.md
+6 -6
View File
@@ -48,12 +48,12 @@ kept as `0`, as those digits are reserved for future improvements. While this
limits the system to 100 vlans, it provides 1:1 visual alignment between IPv4,
IPv6, and VLAN ID. Each can be visually compared to the others.)
|VLAN|IPv4 (3rd octet)|IPv6 suffix (hex)|Example IPv4 |Example IPv6 |
|---:|---------------:|----------------:|--------------:|-----------------------:|
| 7| 7 | 7 |192.168.7.0/24 |2001:db8:abcd:ef07:::/64|
| 101|11 | 11 |192.168.11.0/24|2001:db8:abcd:ef11:::/64|
| 205|25 | 25 |192.168.25.0/24|2001:db8:abcd:ef25:::/64|
| 900|90 | 90 |192.168.90.0/24|2001:db8:abcd:ef25:::/64|
|VLAN|IPv4 (3rd octet)|IPv6 suffix (hex)|Example IPv4 |Example IPv6 |
|---:|---------------:|----------------:|--------------:|----------------------:|
| 7| 7 | 7 |192.168.7.0/24 |2001:db8:abcd:ef07::/64|
| 101|11 | 11 |192.168.11.0/24|2001:db8:abcd:ef11::/64|
| 205|25 | 25 |192.168.25.0/24|2001:db8:abcd:ef25::/64|
| 900|90 | 90 |192.168.90.0/24|2001:db8:abcd:ef25::/64|
## Options
docs/add_v6_net.md
+6 -6
View File
@@ -44,12 +44,12 @@ kept as `0`, as those digits are reserved for future improvements. While this
limits the system to 100 vlans, it provides 1:1 visual alignment between
IPv6 and VLAN ID. Each can be visually compared to the other.)
|VLAN|IPv6 suffix (hex)|Example IPv6 |
|---:|----------------:|-----------------------:|
| 7| 7 |2001:db8:abcd:ef07:::/64|
| 101| 11 |2001:db8:abcd:ef11:::/64|
| 205| 25 |2001:db8:abcd:ef25:::/64|
| 900| 90 |2001:db8:abcd:ef25:::/64|
|VLAN|IPv6 suffix (hex)|Example IPv6 |
|---:|----------------:|----------------------:|
| 7| 7 |2001:db8:abcd:ef07::/64|
| 101| 11 |2001:db8:abcd:ef11::/64|
| 205| 25 |2001:db8:abcd:ef25::/64|
| 900| 90 |2001:db8:abcd:ef25::/64|
## Options
docs/variables.md
+2 -2
View File
@@ -99,7 +99,7 @@ rc_router_gen_dir="/tmp/rc-router-gen/"
This variable defines the lower bound of DHCPv4 pools for auto-generated `/24`
networks constructed by [`add_v4_net`](add_v4_net.md) or [`add_net`](add_net.md).
These pools can also be specified per-physical-interface (but not vlan) by using
`dhcpdv4_pool_lo_${iface}`.
`dhcpv4_pool_lo_${iface}`.
### Example
@@ -117,7 +117,7 @@ dhcpv4_pool_lo_xy0="200" # For networks on `xy0`, start the dynamic pool at 200.
This variable defines the upper bound of DHCPv4 pools for auto-generated `/24`
networks constructed by [`add_v4_net`](add_v4_net.md) or [`add_net`](add_net.md).
These pools can also be specified per-physical-interface (but not vlan) by using
`dhcpdv4_pool_hi_${iface}`.
`dhcpv4_pool_hi_${iface}`.
### Example