Update with two pre-canned configurations.

This commit is contained in:
2026-05-14 15:37:35 -04:00
parent 0ba30c7440
commit fe443b66f9
7 changed files with 98 additions and 3 deletions
+39
View File
@@ -44,6 +44,18 @@ embeddable configuration commands.
This directory contains the base templates for some generated file types.
#### `${rc_router_dir}/samples`
This directory contains subdirectories with sample configurations for common
use cases. Each subdirectory is named for its purpose. The `basic`
configuration is recommended as a good starting point. Users should fill
in some small details in a "local.conf" file in those configuration samples.
When these samples are used, the entire configuration of the router for that
purpose should be complete. On next reboot, it should function according
to that use case, with no other settings changes necessary. It is
recommended that users copy the `sample` configurations as a starting
point, rather than modify them in place
#### `${rc_router_dir}/harness`
This directory contains a testing harness to allow running many of these
@@ -109,6 +121,33 @@ necessary configuration files from various `rc.conf` variables and hints.
drive this process, such that more customized configurations can be
co-mingled with its patterns.
## How to setup using the `basic` sample configuration
Executing this sequence of sample commands will setup a fully-functional SOHO
router using this framework. You'll need to fill in the appropriate choices
for your ISP and your network interfaces.
```
$ cd /etc
$ mkdir router-conf
$ cd router-conf
$ git init .
$ git submodule add rc.router https://gitea.nerdland.org/adam/rc.router
$ rc.router/scripts/install-dependencies.sh
$ cp rc.router/samples/basic/* .
$ cat << EOF > local.conf
external_card="abc0"
internal_card="xy0"
my_isp="verizon_fios"
EOF
$ git add rc.conf local.conf pf.conf
$ git commit -m "FIRST POST!!!"
$ 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
$ reboot # Router is ready
```
## How to setup (Easy dual-stack example With Git)
Executing this sequence of sample commands will setup a basic Dual-stack router