Routerctl Users Guide

Mark Heily

Permission to use, copy, modify, and distribute this document for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.


Table of Contents
1. Introduction
2. System Requirements
3. Downloading
4. Building
Compile-time configuration
5. Installation
Running the installer
6. Configuration
7. Starting and stopping the router
8. Where to obtain help

Chapter 1. Introduction

This document is a user's guide to setting up a software-based router using the Routerctl program.


Chapter 2. System Requirements

Routerctl was written for the OpenBSD platform, and has been ported to Linux.

You will need to have the GCC compiler and the Make utility in order to build the software.


Chapter 3. Downloading


Download the latest source code from the Routerctl web site. Once you have downloaded the source code, you need to extract the files into a temporary directory.


Chapter 4. Building

After you have downloaded the source code and extracted the files into a working directory, the next step is to build the software.

Compile-time configuration

Run the `configure' script to generate the appropriate Makefiles for your system.

When `configure' finishes, type `make' to build the program binaries.


Chapter 5. Installation


Running the installer

To install the software, become root by using the `su' or `sudo' command, and then type `make install' to install the program.


Chapter 6. Configuration

The configuration file is located at /etc/router.conf.

At a minimum, the configuration file needs to have two objects: a 'wan0' and 'lan0' object.



wan0 on [interface] inet [IP address]
lan0 on [interface] inet [IP address] subnet [CIDR netblock]

named0 on [zone] domain [domain name]
dhcpd0 on [zone]

host0 on [named]

service0 on [host]

    

For more information, refer to the router.conf(5) manual page.


Chapter 7. Starting and stopping the router

The routerctl(8) utility is used to start or stop the router.


Chapter 8. Where to obtain help


If you have any problems with the software, send a message to .