Quickstart guide

Creating a ZRouter build environment.

This should probably be done within a Jail.

At First, this Requires you have [[hg]]/mercurial installed:
  • From FreeBSD ports:
    # cd /usr/ports/devel/mercurial
    # make install clean
    
  • OR From FreeBSD packages:
    # pkg_add -r mercurial (or # pkg install mercurial)
    
  1. Create a path set aside for ZRouter build.
    # mkdir -p ZRouter/
  2. Enter directory:
    # cd ZRouter
  3. Checkout/clone ZRouter Project
    # hg clone http://zrouter.org/hg/zrouter/
  4. Checkout/clone Current compatible FreeBSD source:
    # hg clone http://zrouter.org/hg/FreeBSD/head FreeBSD
  5. Begin ZRouter Build Menu
    # ./menu.sh

Entering ./menu.sh

Main menu

  1. Select your target device (example D-Link DIR-632):
    Target device
  2. Select Base Profile. That's two choise:
    - Small - size firmware > 4 MB (if your ROM more than 4 MB)
    - Extra small - size firmware <= 4MB (if your ROM less than 4 MB)
    Firmware size
  3. At "Profiles" select package that included firmware:
    - DEBUG_ - ?
    - ath - ? (atheros driver)
    - dhclient - FreeBSD native DHCP client. Include dhclient, ahclient-script.
    - dhcp - FreeBSD native DHCP server and client. Include dhcpd, dhclient, dhcrelay.
    - dig_spcdns - ?
    - hostap - authentication and encryption for IEEE 802.11 networks. Include hostapd, hostapd_cli, wpa_cli, wpa_passphrase, wpa_supplicant.
    - ipfw - stateful firewall written for FreeBSD. Include ipfw, ipfw_nat, dummynet
    - lagg - ? (interface allows aggregation of multiple network interface)
    - lua_web_ui - Simple Web User Interface based on Lua. Include its own http server.
    - mono - ?
    - mpd - ? netgraph based implementation of the multi-link PPP protocol for FreeBSD
    - mroute - IP multicast routing. Include kernel options MROUTING
    - net_help - ? help network utilities.
    - nfs_client - client for supports the Network File System (NFS)
    - ng_igmp_fwd -
    - ntpdate - for clock synchronization over Network Time Protocol (NTP).
    - openvpn - create a Virtual Private Network. Include OpenVPN, crypto libraries.
    - ppp - utilities for support and configuring Point-to-Point Protocol (PPP). Include ppp.
    - racoon - ? establish security association with other hosts.
    - racoon2 - ?
    - shttpd - lightweight, easy to use web server.
    - ssh - enable SSH service. Include ssh, sshd, SSH PAM service file and /etc/ssh configs.
    - watchdog - if software freeze, then watchdog H/W reset system. Include watchdogd and rc.d script.
    - zhttpd - ?
    Packages
  4. Last that must to do - select paths of source and build object:
    Paths
    - Path of FreeBSD/head
    Source
    - Path of objects (temporary direcroty where will be compilate your firmware)
    Objects
    Then go back to main menu:
    Back to main menu
  5. You can save your selection to "Build Profile" for future use (file will be created at "./Zrouter/zrouter/build_profiles/" ):
    Save Build Profile
    Enter Build Profile Name
  6. You can load your Build Profile if you save it early:
    Load Build Profile
    Select Build Profile
  7. Now select to "Build" and you see all your choices:
    Last choice
    Answer "yes" and firmware will begining.

Flash your firmware

mainmenu.jpg - Main menu (42.1 kB) Alexey Z., 02/28/2013 12:29 pm

Target.jpg - Target device (64.4 kB) Alexey Z., 02/28/2013 12:29 pm

kernel.jpg - Firmware size (35.6 kB) Alexey Z., 02/28/2013 12:29 pm

package.jpg - Packages (48.1 kB) Alexey Z., 02/28/2013 12:29 pm

path.jpg - Paths (27 kB) Alexey Z., 02/28/2013 12:29 pm

Path_head.jpg - Source (22.5 kB) Alexey Z., 02/28/2013 12:34 pm

path_obj.jpg - Objects (20.3 kB) Alexey Z., 02/28/2013 12:34 pm

path_back.jpg - Back to main menu (28.2 kB) Alexey Z., 02/28/2013 12:34 pm

save_menu.jpg - Save Build Profile (44.5 kB) Alexey Z., 02/28/2013 12:43 pm

save.jpg - Enter Build Profile Name (18.9 kB) Alexey Z., 02/28/2013 12:43 pm

load_menu.jpg - Load Build Profile (41.6 kB) Alexey Z., 02/28/2013 12:45 pm

load.jpg - Select Build Profile (25.6 kB) Alexey Z., 02/28/2013 12:45 pm

Compilate.jpg - Last choice (33.2 kB) Alexey Z., 02/28/2013 12:53 pm