User Guide

For installing BSDRP you need a 512Mb Compact Flash/USB stick.

For using BSDRP you need a minimum of 64MB RAM for Qemu and 96MB RAM for XORP.

All hardware supported by FreeBSD 8.0 is supported by BSDRP with the exception of following drivers:

Wireless, PCMCIA cards, SCSI adapters, USB printer, fire wire, etc. that were removed from the FreeBSD kernel.

BSDRP use:

• Ethernet device polling for high performance.
• ALTQ for queuing

And only theses devices support these modes:

Using others NIC will works, but not give you optimal performance.

The BSDRP images use this filename convention:

BSDRP_release_image type_arch_console.img.bz2

The value image type can be:

• full : To be used for installing BSDRP. This image contain full BSDRP filesystem (bootloader, 2 systems partitions, cfg partition and data partition)
• upgrade : To be used for upgrading BSDRP. This image contain only one system partition.

The value arch can be:

• i386 : for i486, i586 and i686 CPU
• amd64 : for all x86-64 CPU (amd64 or intel 64)

The value console can be:

• vga: To be used with a vga card and keyboard as default console (but it's still possible to connect to the serial port)
• serial: For headless use, use only serial port as default console

Examples:

• BSDRP_0.3_full_i386_vga.img, means full image, for arch i386, with keyboard/vga as console.
• BSDRP_0.3_upgrade_amd64_serial.img, means upgrade image, for arch amd64 on headless serial.

The *.mtree.bz2 files are used for system integrity check.

Unzip the BSDRP image file (you need to have a file with .img extension and not .bz2 extension).

Then, use physdiskwrite for writting the image on your CF/USB connected to your PC.

Connect your Compact Flash or USB disk and note the device name (sd4 for a usb key in this exemple).

Then unzip the file and byte copy it to your drive (Warning: Double check that you had choosen the good destination disk!!!):

bunzip2 -c BSDRP-full-vga.0.2.img.bz2 | dd of=/dev/sd4 bs=64k

You can boot from this media now.

Connect your Compact Flash or USB disk and note the device name (da0 for a usb key in this exemple).

Then unzip the file and byte copy it to your drive (Warning: Double check that you had choosen the good destination disk!!!):

bunzip2 -c BSDRP-full-vga.0.2.img.bz2 | dd of=/dev/da0 bs=64k

You can boot from this media now.

Insert the USB key, and run mount in a terminal (or disk utility if you prefer graphical method) to see what device OSX has assigned to your USB key. You should see something like this:

/dev/disk0s2 on / (hfs, local, journaled)
devfs on /dev (devfs, local)
fdesc on /dev (fdesc, union)
map -hosts on /net (autofs, automounted)
map auto_home on /home (autofs, automounted)
/dev/disk3s1 on /Volumes/UNTITLED (msdos, local, nodev, nosuid, noowners)

The last line is your USB device. Unmount it and write the BSDRP image to it with:

sudo umount -f /dev/disk3s1
bunzip2 -c BSDRP-full-vga.0.2.img.bz2 | dd of=/dev/disk3 bs=64k

If successful, OSX will pop up an error dialog telling you it doesn't recognize the disk. Click 'Eject', remove the USB key, and you're done.

For using BSDRP as a Virtual Machine, refers to chapter How to run in the Technical docs.

Once BSDRP is started for the first time, don't forget to lower the default kern.HZ value that is not optimized for a VM usage by entering this command:

system virtualized

The FreeBSD (BSDRP) bootloader default configuration isn't compatible with the WRAP: You need to change the bootloader mode before to use it on a WRAP platform. From a FreeBSD host, once you had installed the image on your CF, change the bootloader mode (replace daX by your device):

boot0cfg -o nopacket /dev/daX

Using this method, you need a SCP server (any unix/linux with SSH enabled).

Resume: The router download the BSDRP image by SCP then it start the upgrade

Put the BSDRP-upgrade.image.bz2 file on SCP server “my-server” home dir of “my-user”, and from the BSDRP router, enter this command:

ssh my-user@my-server cat BSDRP-upgrade.image.bz2 | bzcat | upgrade

This method requiered:

• A minimum of 64Mb of free RAM on your BSDRP
• A SCP client on your MS Windows (FileZilla or WinSCP for example)

Resume:

1. Create a 64 ram disk on BSDRP
2. Transfert the BSDRP image upgrade on the ram disk using the SCP client
3. Upgrade the system

Step 1: Creating the ram disk

On BSDRP, enter theses commands:

set RAMDRIVE=`mdconfig -a -t malloc -s 64m`
newfs -m 0 -n $RAMDRIVE
mount /dev/$RAMDRIVE /mnt/

Step 2: From your Windows desktop using your SCP client, send the BSDRP upgrade image to the /mnt folder.

Step 3: After transfer complete, On BSDRP, enter this command:

cat /mnt/BSDRP-upgrade.image.bz2 | bzcat | upgrade
umount /mnt

Login as root with no password.

If you are using the serial version, serial port parameters are: 9600,8,N,1,MODEM

Start by using the help:

help

Create a password for root (mandatory for SSH):

passwd

Enter in quagga mode:

cli

Do your quagga configuration, and save quagga config and exit quagga cli:

wr
exit

Then save all changes:

config save

BSDRP is a FreeBSD, then you need to read how to configure a FreeBSD for using it.

Here is a list of useful documentations:

• BSDRP Examples
• FreeBSD Handbook:
  • Bridging
  • Link Aggregation and Failover
  • Alternate Queuing
  • IPv6
• FreeBSD Man Pages
• Quagga Manual
• XORP user manual (PDF)

The config tool:

Usage: ./config option
  - save     : Save current config
  - apply    : Apply current config
  - rollback : Revert to previous config
  - put      : Put config to a remote server
  - get      : Get config from remote server
  - reset  : Return to default configuration
  - password (pass) : Change root password
  - help (h) [option]  : Display this help message.
                        If [option] given, display more detail about

The root filesystem is in read-only mode, then you can't modify or create your own script on it.

For modify the existing script (don't forget to send us your improvement), use the “data” partition. Here is an example for customizing the config tools:

mount /dev/ufs/data /mnt
cp /usr/local/bin/config /mnt
vim /mnt/config

Now you can add your great patches to config script. And test it:

cd /mnt
./config

Then, don't forget to umount the /mnt partition:

umount /mnt

You can modify the full filesystem by re-mount the active slice in read-write mode:

mount -u -o rw /

Now you can modify all files or removing/installing package.

Here is how to remove bird as example:

[root@router]~#pkg_info | grep bird
bird-1.2.1 Dynamic IP routing daemon
[root@router]~#pkg_delete bird-1.2.1

After your changes, re-mount it in read-only mode:

mount -u -o ro /