From 64c0004eeb4d34a065ff3e40ddb954ee83d57572 Mon Sep 17 00:00:00 2001 From: Sjon Hortensius Date: Sat, 24 Jan 2015 10:53:57 +0100 Subject: Updated readme with development instructions --- README.md | 47 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 35 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c4c7dba..f24cbc7 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ pfSense on bootstrap We are migrating pfSense to Bootstrap. You can help! Please respect these code-guidelines: -* use tabs (tabstop=4) for indenting (except the license-header which contains 3 lines that are indented with "\t ") +* use tabs (tabstop=4) for indenting (except the license-header which contains 3 lines that are indented with "\t") * no trailing whitespace * limited echoing of HTML from php, please use proper templating syntax instead (eg. foreach/endforeach) * limited attributes on elements; _no style attributes_ @@ -13,6 +13,29 @@ We are migrating pfSense to Bootstrap. You can help! Please respect these code-g If you feel adventurous you can sometimes rewrite some PHP & javascript code as well; but try to keep this to a minimum. +# Development setup + +We suggest you setup a development enviroment for testing your changes. This can be done with either Virtualbox or Qemu. + +## Qemu + +Use libvirt to setup a FreeBSD-10 machine with 2 NICs. Boot the latest pfSense.iso and install it. I've attached both NICs to the virbr0 that libvirt offers by default. One interface can be used as WAN (where pfSense will use dhcp and should get a NATted ip on your local network), the other as a LAN interface with a fixed IP address. + +## Virtualbox + +.. + +## Post install tasks + +Disable the dhcp server (on the LAN interface) of your pfSense install and you're good to go. Start the ssh-daemon, login and setup public-key authentication (for the root user). Execute `pkg install rsync` and create a script to upload your changes from your development environment to your pfSense install: + +```bash +#!/bin/sh + +rsync -xav --delete `dirname $0`/usr/local/www/ root@192.168.122.100:/usr/local/www/ +rsync -xav --delete `dirname $0`/etc/inc/ root@192.168.122.100:/etc/inc/ +``` + # Cleaner Before diving into a template, clean it with the supplied cleaner (`clean.sh`). This script tries to remove most of the unnecessary element attributes and does a bunch of other replaces which have to be done in every template. @@ -47,19 +70,19 @@ An example (which omits everything but relevant Bootstrap classes):
- -
- - What's this all about? -
+ +
+ + What's this all about? +
- -
- -
+ +
+ +
-- cgit v1.1