diff --git a/README.md b/README.md index 46943ee..404811e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ on FreeBSD-14, but I no longer run any routers with it on FreeBSD-14.) None, in particular. The `rc.router/scripts/install-dependencies.sh` script will install all necessary dependency packages for FreeBSD. Several of the -`${rc_router_dir}/rc.d` startup scripts depend upon these. +`${rc_router_dir}/rc.d` startup scripts depend upon these. It is expected that +this script will be run by the administrator to install those packages. ## Directory Layout @@ -120,7 +121,7 @@ $ cd /etc $ mkdir router-conf $ cd router-conf $ git init . -$ echo << EOF > rc.conf +$ cat << EOF > rc.conf # Configure a basic external v4 ISP external_card="em0" @@ -135,6 +136,7 @@ EOF $ git add rc.conf $ git submodule add rc.router https://gitea.nerdland.org/adam/rc.router $ git commit -m "FIRST POST!!!" +$ rc.router/scripts/install-dependencies.sh $ echo 'rc_router_dir="/etc/router-conf/rc.router"' >> /etc/rc.conf $ echo 'rc_router_conf_dir="/etc/router-conf"' >> /etc/rc.conf $ echo ". ${rc_router_dir}/rc.entry" >> /etc/rc.conf @@ -149,7 +151,7 @@ $ cd /etc $ mkdir router-conf $ cd router-conf $ git init . -$ echo << EOF > rc.conf +$ cat << EOF > rc.conf # Configure a basic external v4 ISP external_card="em0" add_v4_isp ${external_card} dhcp @@ -165,6 +167,7 @@ EOF $ git add rc.conf $ git submodule add rc.router https://gitea.nerdland.org/adam/rc.router $ git commit -m "FIRST POST!!!" +$ rc.router/scripts/install-dependencies.sh $ echo 'rc_router_dir="/etc/router-conf/rc.router"' >> /etc/rc.conf $ echo 'rc_router_conf_dir="/etc/router-conf"' >> /etc/rc.conf $ echo ". ${rc_router_dir}/rc.entry" >> /etc/rc.conf diff --git a/docs/add_v4_net.md b/docs/add_v4_net.md index e9e5139..1fb78f0 100644 --- a/docs/add_v4_net.md +++ b/docs/add_v4_net.md @@ -7,7 +7,7 @@ ## Synopsis ``` -add_v4_net ${card} ${vlan} ${group} [{isp=abc|no_isp}...] +add_v4_net ${card} ${vlan} ${group} ``` ## Description @@ -49,16 +49,16 @@ IPv6, and VLAN ID. Each can be visually compared to the others.) ## Examples #### Basic home LAN -`add_net abc2 100 main` +`add_v4_net abc2 100 main` #### Guest network with no ULA -`add_net xy2 102 guest no_ula` +`add_v4_net xy2 102 guest` -#### IoT network with no ULA and no ISP prefix delegation -`add_net xy2 103 iot no_ula no_isp` +#### IoT network with no ISP association +`add_v4_net xy2 103 iot no_isp` -#### Management network on a different ISP PD -`add_net xy2 402 mgmt isp=fios_1` +#### Management network on a different ISP +`add_v4_net xy2 402 mgmt isp=fios_1` ## See Also diff --git a/docs/add_wireguard_route.md b/docs/add_wireguard_route.md index 138a90f..c6a7e29 100644 --- a/docs/add_wireguard_route.md +++ b/docs/add_wireguard_route.md @@ -11,7 +11,7 @@ ## Description Creates a wireguard interface with the specified wireguard interface number -(`${wireguard_number}`), associates that intererface and the specified IPv6 +(`${wireguard_number}`), associates that interface and the specified IPv6 prefix (`${ipv6_prefix}`) with a fib of the same number (`${wireguard_number}`). Internally, this calls [`add_wireguard_interface`](add_wireguard_interface.md) and diff --git a/scripts/install-dependencies.sh b/scripts/install-dependencies.sh new file mode 100644 index 0000000..d5a543c --- /dev/null +++ b/scripts/install-dependencies.sh @@ -0,0 +1,5 @@ +#!/bin/sh + +pkg_list="bind920 bind-tools tayga wireguard-tools dhcp6 isc-dhcp44-server openbgpd8" + +pkg install ${pkg_list}