gderosa / onboard

ruby OnBoard -- http://dev.vemarsas.it/onboard/ .

Except where otherwise stated, this work is
Copyright 2009 Guido De Rosa <guido.derosa at vemarsas.it>
License: GPLv2 

Some artworks from the GNOME project are included, see 
public/icons/gnome for details and Copyright info.

---

A web interface to configure Linux-based network appliances. It's been
developed and tested on Debian GNU/Linux and its derivative for
embedded systems, Voyage Linux (http://linux.voyage.hk/). It should work on 
other distros too, altough untested right now. Feel free to contribute and 
test.

---

For any web page, you may change .html extension into .json or .yaml to
get machine-readable data. 

An .rb extension is also available for debugging purposes when in 
Sinatra 'development' environment. 

---

Software requirements for "core" (check individual directories under modules/
for module-specific, additional requirements): 

* ruby 1.9 (preferably >=1.9.1)
* sudo
* iproute2
* iptables (with proper kernel support)
* bridge-utils (brctl)
* pciutils (lspci command)
* dhcpcd 
  * Also, resolvconf is recommended
* dnsmasq >= 2.46 
  ## removed ISC-style leasefile format, which is assumed when no
  ## dhcp-range is provided -- and leads to troubles
* locales 
  ## and generate (UTF8) locales for languages/countries you want to support
* ifrename (optional) 

Gems:

(some gems are written in C or C++ , so you need a reasonably complete 
C/C++ build environment; and, if you installed a pre-packaged ruby, you
will need header files from a package named ruby-dev or something alike)

gem install rubytree sinatra i18n_data locale thin r18n-core sinatra-r18n escape facets --no-ri --no-rdoc

--

Please read carefully doc/sysadm/example/etc/sysctl.conf and copy and/or append 
the configuration to the Linux machine /etc/sysctl.conf file.

--

Optional add-ons:

You can get pretty-printed JSON output via JsonPrinter 
by Mark McGranaghan. To get it, change to the lib/ directory (or your
system's site_ruby dir), then:

git clone git://github.com/techcrunch/json_printer.git

You can also take advantage of Ya2YAML by Akira FUNAI to get native 
UTF-8 YAML ouptut (i.e. no need to treat Unicode Strings as binary data
and encode them in base64). 

gem install ya2yaml

---

This Free/Open Source Software project is sponsored by 
VEMAR sas, Paterno (PZ), Italy -- http://www.vemarsas.it/