freedombox-setup/0002755000000000000000000000000012347053072011241 5ustar freedombox-setup/lxc-templates/0002755000000000000000000000000012323220277014020 5ustar freedombox-setup/lxc-templates/lxc-debian-freedombox0000755000000000000000000002125712223014340020100 0ustar #!/bin/bash # # lxc: linux Container library # Authors: # Daniel Lezcano # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # ============================================================== # This is a slightly modified version by Rob van der Hoeven # I use it for my FreedomBox project: http://freedomboxblog.nl # ============================================================== SUITE=${SUITE:-squeeze} MIRROR=${MIRROR:-http://cdn.debian.net/debian} configure_debian() { rootfs=$1 hostname=$2 # squeeze only has /dev/tty and /dev/tty0 by default, # therefore creating missing device nodes for tty1-4. for tty in $(seq 1 4); do if [ ! -e $rootfs/dev/tty$tty ]; then mknod $rootfs/dev/tty$tty c 4 $tty fi done # configure the inittab cat < $rootfs/etc/inittab id:3:initdefault: si::sysinit:/etc/init.d/rcS l0:0:wait:/etc/init.d/rc 0 l1:1:wait:/etc/init.d/rc 1 l2:2:wait:/etc/init.d/rc 2 l3:3:wait:/etc/init.d/rc 3 l4:4:wait:/etc/init.d/rc 4 l5:5:wait:/etc/init.d/rc 5 l6:6:wait:/etc/init.d/rc 6 # Normally not reached, but fallthrough in case of emergency. z6:6:respawn:/sbin/sulogin 1:2345:respawn:/sbin/getty 38400 console c1:12345:respawn:/sbin/getty 38400 tty1 linux c2:12345:respawn:/sbin/getty 38400 tty2 linux c3:12345:respawn:/sbin/getty 38400 tty3 linux c4:12345:respawn:/sbin/getty 38400 tty4 linux p6::ctrlaltdel:/sbin/init 6 p0::powerfail:/sbin/init 0 EOF # disable selinux in debian mkdir -p $rootfs/selinux echo 0 > $rootfs/selinux/enforce # configure the network using the dhcp cat < $rootfs/etc/network/interfaces auto lo iface lo inet loopback auto eth0 iface eth0 inet dhcp EOF # set the hostname cat < $rootfs/etc/hostname $hostname EOF # let dhcp client report the hostname to DHCP server cat <> $rootfs/etc/dhcp/dhclient.conf send host-name "$hostname"; send vendor-class-identifier "lxc.module"; EOF # reconfigure some services if [ -z "$LANG" ]; then chroot $rootfs locale-gen en_US.UTF-8 UTF-8 chroot $rootfs update-locale LANG=en_US.UTF-8 else chroot $rootfs locale-gen $LANG $(echo $LANG | cut -d. -f2) chroot $rootfs update-locale LANG=$LANG fi # remove pointless services in a container chroot $rootfs /usr/sbin/update-rc.d -f checkroot.sh remove chroot $rootfs /usr/sbin/update-rc.d -f umountfs remove chroot $rootfs /usr/sbin/update-rc.d -f hwclock.sh remove chroot $rootfs /usr/sbin/update-rc.d -f hwclockfirst.sh remove echo "root:root" | chroot $rootfs chpasswd echo "Root password is 'root', please change !" return 0 } cleanup() { rm -rf $cache/partial-$SUITE-$arch rm -rf $cache/rootfs-$SUITE-$arch } download_debian() { packages=\ ifupdown,\ locales,\ libui-dialog-perl,\ dialog,\ isc-dhcp-client,\ netbase,\ net-tools,\ iproute,\ openssh-server cache=$1 arch=$2 trap cleanup EXIT SIGHUP SIGINT SIGTERM # check the mini debian was not already downloaded mkdir -p "$cache/partial-$SUITE-$arch" if [ $? -ne 0 ]; then echo "Failed to create '$cache/partial-$SUITE-$arch' directory" return 1 fi # download a mini debian into a cache echo "Downloading debian minimal ..." debootstrap --verbose --variant=minbase --arch=$arch \ --include=$packages \ "$SUITE" "$cache/partial-$SUITE-$arch" $MIRROR if [ $? -ne 0 ]; then echo "Failed to download the rootfs, aborting." return 1 fi mv "$1/partial-$SUITE-$arch" "$1/rootfs-$SUITE-$arch" echo "Download complete." trap EXIT trap SIGINT trap SIGTERM trap SIGHUP return 0 } copy_debian() { cache=$1 arch=$2 rootfs=$3 # make a local copy of the minidebian echo -n "Copying rootfs to $rootfs..." mkdir -p $rootfs rsync -Ha "$cache/rootfs-$SUITE-$arch"/ $rootfs/ || return 1 return 0 } install_debian() { cache="/var/cache/lxc/debian-$SUITE" rootfs=$1 mkdir -p /var/lock/subsys/ ( flock -n -x 200 if [ $? -ne 0 ]; then echo "Cache repository is busy." return 1 fi arch=$(dpkg --print-architecture) echo "Checking cache download in $cache/rootfs-$SUITE-$arch ... " if [ ! -e "$cache/rootfs-$SUITE-$arch" ]; then download_debian $cache $arch if [ $? -ne 0 ]; then echo "Failed to download 'debian base'" return 1 fi fi copy_debian $cache $arch $rootfs if [ $? -ne 0 ]; then echo "Failed to copy rootfs" return 1 fi return 0 ) 200>/var/lock/subsys/lxc-debian return $? } # nice trick from: http://mindref.blogspot.com/2011/01/debian-lxc-create.html hex() { echo "`tr -dc A-F0-9 < /dev/urandom | head -c 2 | xargs`" } copy_configuration() { path=$1 rootfs=$2 hostname=$3 grep -q "^lxc.rootfs" $path/config 2>/dev/null || echo "lxc.rootfs = $rootfs" >> $path/config cat <> $path/config lxc.tty = 4 lxc.pts = 1024 lxc.utsname = $hostname # When using LXC with apparmor, uncomment the next line to run unconfined: #lxc.aa_profile = unconfined lxc.cgroup.devices.deny = a # /dev/null and zero lxc.cgroup.devices.allow = c 1:3 rwm lxc.cgroup.devices.allow = c 1:5 rwm # consoles lxc.cgroup.devices.allow = c 5:1 rwm lxc.cgroup.devices.allow = c 5:0 rwm lxc.cgroup.devices.allow = c 4:0 rwm lxc.cgroup.devices.allow = c 4:1 rwm # /dev/{,u}random lxc.cgroup.devices.allow = c 1:9 rwm lxc.cgroup.devices.allow = c 1:8 rwm lxc.cgroup.devices.allow = c 136:* rwm lxc.cgroup.devices.allow = c 5:2 rwm # rtc lxc.cgroup.devices.allow = c 254:0 rwm # mounts point lxc.mount.entry = proc proc proc nodev,noexec,nosuid 0 0 lxc.mount.entry = devpts dev/pts devpts defaults 0 0 lxc.mount.entry = sysfs sys sysfs defaults 0 0 # networking lxc.network.type = veth lxc.network.flags = up lxc.network.link = br0 lxc.network.ipv4 = 0.0.0.0/24 lxc.network.hwaddr = 00:1E:$(hex):$(hex):$(hex):$(hex) EOF if [ $? -ne 0 ]; then echo "Failed to add configuration" return 1 fi return 0 } clean() { cache="/var/cache/lxc/debian-$SUITE" if [ ! -e $cache ]; then exit 0 fi # lock, so we won't purge while someone is creating a repository ( flock -x 200 if [ $? != 0 ]; then echo "Cache repository is busy." exit 1 fi echo -n "Purging the download cache..." rm --preserve-root --one-file-system -rf $cache && echo "Done." || exit 1 exit 0 ) 200>/var/lock/subsys/lxc-debian } usage() { cat < --clean EOF return 0 } options=$(getopt -o hp:n:c -l help,path:,name:,clean -- "$@") if [ $? -ne 0 ]; then usage $(basename $0) exit 1 fi eval set -- "$options" while true do case "$1" in -h|--help) usage $0 && exit 0;; -p|--path) path=$2; shift 2;; -n|--name) name=$2; shift 2;; -c|--clean) clean=$2; shift 2;; --) shift 1; break ;; *) break ;; esac done if [ ! -z "$clean" -a -z "$path" ]; then clean || exit 1 exit 0 fi type debootstrap if [ $? -ne 0 ]; then echo "'debootstrap' command is missing" exit 1 fi if [ -z "$path" ]; then echo "'path' parameter is required" exit 1 fi if [ "$(id -u)" != "0" ]; then echo "This script should be run as 'root'" exit 1 fi # detect rootfs config="$path/config" if grep -q '^lxc.rootfs' $config 2>/dev/null ; then rootfs=`grep 'lxc.rootfs =' $config | awk -F= '{ print $2 }'` else rootfs=$path/rootfs fi install_debian $rootfs if [ $? -ne 0 ]; then echo "failed to install debian" exit 1 fi configure_debian $rootfs $name if [ $? -ne 0 ]; then echo "failed to configure debian for a container" exit 1 fi copy_configuration $path $rootfs $name if [ $? -ne 0 ]; then echo "failed write configuration file" exit 1 fi if [ ! -z $clean ]; then clean || exit 1 exit 0 fi freedombox-setup/setup.d/0002755000000000000000000000000012376551540012630 5ustar freedombox-setup/setup.d/20_lxc0000755000000000000000000000147512222755766013660 0ustar #!/bin/sh # # Prepare support for LXC, to allow us to put each service in its own # container. # Based on and # . create_lxc_box() { virtname="$1" pkgs="$2" MIRROR=http://http.debian.net/debian \ SUITE=wheezy \ lxc-create -n "$virtname" -t debian-freedombox if [ "$pkgs" ] ; then lxc-start -d -n "$virtname" lxc-attach -n "$virtname" -- \ DEBIAN_FRONTEND=noninteractive apt-get install -y $pkgs lxc-stop -n "$virtname" fi } DEBIAN_FRONTEND=noninteractive apt-get install -y lxc bridge-utils if ! grep cgroup /etc/fstab ; then echo 'cgroup /sys/fs/cgroup cgroup defaults 0 0' >> /etc/fstab mount /sys/fs/cgroup fi # The Internet router / firewall container #create_lxc_box internet freedombox-setup/setup.d/98_next-is-first-run0000755000000000000000000000021512235001457016377 0ustar #!/bin/sh # Tell init.d/first-run to do its stuff on the next boot. mkdir -p /var/lib/freedombox touch /var/lib/freedombox/first-run-enable freedombox-setup/setup.d/99_provide-source0000755000000000000000000000135512376550524016050 0ustar #!/bin/sh # # Make sure generated images complies with licenses requiring the # source to be available, by providing the source of every package # used. # TODO Remove on 1/1/15: " || [ 'true' = "$NOSOURCE" ]" if [ 'false' = "$SOURCE" ] || [ 'true' = "$NOSOURCE" ] ; then echo "Not adding source packages to filesystem (SOURCE=false)" exit 0 else echo "Adding source packages to file system" fi targetdir=/usr/src/packages echo "Adding source packages to filesystem in $targetdir" apt-get update || true dpkg --get-selections > /tmp/selections mkdir -p $targetdir cd $targetdir cut -f 1 < /tmp/selections | \ cut -d ':' -f 1 > /tmp/packages apt-get source -m --download-only `cat /tmp/packages` rm /tmp/selections /tmp/packages freedombox-setup/setup.d/10_hardware0000755000000000000000000001245712366115447014663 0ustar #!/bin/sh enable_serial_console() { # By default, spawn a console on the serial port device="$1" echo "Adding a getty on the serial port" echo "T0:12345:respawn:/sbin/getty -L $device 115200 vt100" >> /etc/inittab } dreamplug_flash() { # allow flash-kernel to work without valid /proc contents # ** this doesn't *really* work, since there are too many checks # that fail in an emulated environment! We'll have to do it by # hand below anyway... export FK_MACHINE="Globalscale Technologies Dreamplug" # Installing flash-kernel here, as installing it using debootstrap # causes all kernel related postinst scripts to stop working when # installed in a chroot. chroot $rootdir apt-get install -y flash-kernel } dreamplug_repack_kernel() { # process installed kernel to create uImage, uInitrd, dtb # using flash-kernel would be a good approach, except it fails in the # cross build environment due to too many environment checks... #FK_MACHINE="Globalscale Technologies Dreamplug" flash-kernel # so, let's do it manually... # flash-kernel's hook-functions provided to mkinitramfs have the # unfortunate side-effect of creating /conf/param.conf in the initrd # when run from our emulated chroot environment, which means our root= # on the kernel command line is completely ignored! repack the initrd # to remove this evil... echo "info: repacking dreamplug kernel and initrd" kernelVersion=$(ls /usr/lib/*/kirkwood-dreamplug.dtb | head -1 | cut -d/ -f4) version=$(echo $kernelVersion | sed 's/linux-image-\(.*\)/\1/') initRd=initrd.img-$version vmlinuz=vmlinuz-$version mkdir /tmp/initrd-repack (cd /tmp/initrd-repack ; \ zcat /boot/$initRd | cpio -i ; \ rm -f conf/param.conf ; \ find . | cpio --quiet -o -H newc | \ gzip -9 > /boot/$initRd ) rm -rf /tmp/initrd-repack (cd /boot ; \ cp /usr/lib/$kernelVersion/kirkwood-dreamplug.dtb dtb ; \ cat $vmlinuz dtb >> temp-kernel ; \ mkimage -A arm -O linux -T kernel -n "Debian kernel ${version}" \ -C none -a 0x8000 -e 0x8000 -d temp-kernel uImage ; \ rm -f temp-kernel ; \ mkimage -A arm -O linux -T ramdisk -C gzip -a 0x0 -e 0x0 \ -n "Debian ramdisk ${version}" \ -d $initRd uInitrd ) } # Install binary blob and kernel needed to boot on the Raspberry Pi. raspberry_setup_boot() { # Packages used by rpi-update to make Raspberry Pi bootable apt-get install -y git-core binutils ca-certificates wget kmod wget https://raw.github.com/Hexxeh/rpi-update/master/rpi-update \ -O /usr/bin/rpi-update chmod a+x /usr/bin/rpi-update mkdir -p /lib/modules touch /boot/start.elf SKIP_BACKUP=1 rpi-update | tee /root/rpi-update.log } beaglebone_setup_boot() { # copy u-boot to the boot partition cp /usr/lib/u-boot/am335x_boneblack/MLO /boot/MLO cp /usr/lib/u-boot/am335x_boneblack/u-boot.img /boot/u-boot.img # Setup uEnv.txt kernelVersion=$(ls /usr/lib/*/am335x-boneblack.dtb | head -1 | cut -d/ -f4) version=$(echo $kernelVersion | sed 's/linux-image-\(.*\)/\1/') initRd=initrd.img-$version vmlinuz=vmlinuz-$version # uEnv.txt for Beaglebone # based on https://github.com/beagleboard/image-builder/blob/master/target/boot/beagleboard.org.txt cat >> /boot/uEnv.txt <> /etc/fstab < /etc/hosts < /etc/apache2/conf-available/jwchat.conf <<'EOF' Alias /jwchat /usr/share/jwchat/www Options +Indexes +Multiviews +FollowSymLinks # proxy for BOSH server ProxyPass /http-bind/ http://localhost:5280/http-bind/ ProxyPassReverse /http-bind/ http://localhost:5280/http-bind/ Allow from all EOF a2dissite jwchat a2enconf jwchat # Remove SSL keys from images, will be generated on first boot. rm -f /etc/ejabberd/ejabberd.pem freedombox-setup/setup.d/30_ldap-server0000755000000000000000000000120212223743513015267 0ustar #!/bin/sh DEBIAN_FRONTEND=noninteractive apt-get install -y pwgen pwd="$(pwgen -1)" domain=thisbox echo slapd slapd/domain string $domain | debconf-set-selections echo slapd slapd/password1 password "$pwd" | debconf-set-selections echo slapd slapd/password2 password "$pwd" | debconf-set-selections DEBIAN_FRONTEND=noninteractive apt-get install -y slapd ldap-utils # Make sure slapd isn't running when we use slapadd service slapd stop # slapcat -b cn=config #slapadd /usr/share/freedombox/ldap/root.ldif cat < /dev/null 2>&1 ; then etckeeper commit -m "Status after freedombox-setup run." fi freedombox-setup/setup.d/80_tor0000755000000000000000000000101612366115447013666 0ustar #!/bin/sh # TODO: Randomly choose a obfs proxy ports, set them explictly in # configuration and enable firewall for them. apt-get install -y tor obfsproxy cat > /etc/tor/torrc < /home/fbx/README chmod a+rx /home/fbx/README chown fbx /home/fbx/README else echo info: Not adding /home/fbx/README. fi freedombox-setup/setup.d/01_etckeeper-pre0000755000000000000000000000070712235035232015600 0ustar #!/bin/sh # Avoid etckeeper problem (refuses to commit) because git picked a # email address with an empty domain. if which etckeeper > /dev/null 2>&1 && \ [ ! -e /etc/mailname ] && [ -z "$(git config --global --get user.email)" ] ; then echo "info: Setting git user.email." git config --global user.email "root@localhost" etckeeper commit -m "Status before freedombox-setup run." else echo "info: Not setting git user.email." fi freedombox-setup/setup.d/91_privoxy0000755000000000000000000000023312327647333014605 0ustar #!/bin/sh apt-get install -y privoxy # Listen on all interfaces sed -i 's/listen-address localhost:8118/listen-address [::]:8118/' /etc/privoxy/config freedombox-setup/setup.d/15_ssh-keys0000755000000000000000000000020612223770237014622 0ustar #!/bin/sh # Make sure SSH keys are unique, and do not carry the ones generated # in the chroots into images. rm /etc/ssh/ssh_host_* freedombox-setup/setup.d/90_apache20000755000000000000000000000207312315255126014363 0ustar #!/bin/sh # # Configure Apache for FBX. echo "Configuring Apache..." # enable miscellaneous modules. a2enmod rewrite # enable SSL a2enmod ssl # disable default site a2dissite 000-default # disable plinth, if plinth-ssl is enabled if [ -e /etc/apache2/sites-enabled/plinth-ssl.conf ] ; then a2dissite plinth fi # setup freedombox site cat > /etc/apache2/sites-available/fbx.conf <<'EOF' ServerName fbx AddDefaultCharset UTF-8 ## jwchat DocumentRoot /usr/share/jwchat/www Options +Indexes +Multiviews +FollowSymLinks ## Proxy for BOSH server (for jwchat). ProxyPass /http-bind/ http://localhost:5280/http-bind/ ProxyPassReverse /http-bind/ http://localhost:5280/http-bind/ Allow from all ## Send plinth to HTTPS port handled by plinth.conf. RewriteEngine on ReWriteCond %{REQUEST_URI} ^/plinth ReWriteCond %{SERVER_PORT} !^443$ RewriteRule ^/(.*) https://%{HTTP_HOST}/$1 [NC,R,L] EOF a2ensite fbx echo "Done configuring Apache." freedombox-setup/setup.d/50_openvpn0000755000000000000000000000025412234000363014527 0ustar #!/bin/sh # Disabled as it seem to be just cruft from earlier [pere 2013-10-28] exit 0 mkdir -p /etc/openvpn touch /etc/openvpn/static.key touch /etc/openvpn/client.conf freedombox-setup/setup.d/40_dhcp-server0000755000000000000000000000227212215147571015301 0ustar #!/bin/sh # # Replacement DHCP server configuration used on the dreamplug # Disabled while dnsmasq is used as DHCP server echo warning: Not setting up isc-dhcp-server, as dnsmasq is used instead. exit 0 cat > /etc/dhcp/dhcpd.conf< /etc/dnsmasq.conf < /etc/dnsmasq.d/freedombox-upstream-dns < /etc/dnsmasq.d/freedombox-dhcp-server < $LOGFILE 2>&1 etckeeper_commit() { if type etckeeper > /dev/null 2>&1 ; then etckeeper commit -m "$1" fi } mark_complete() { # Prevent this initial configuration script from running again. log_action_begin_msg "Marking first-run complete" mkdir -p "${RUNONCE%/*}" rm -f $RUNONCE log_action_end_msg 0 } case "$1" in start) etckeeper_commit "Status before first-run on first boot." for f in /usr/lib/freedombox/first-run.d/* ; do $f done etckeeper_commit "Status after first-run on first boot." # the last things we do before quitting. mark_complete # we're done, reboot. reboot ;; stop|restart|force-reload) # Do nothing ;; *) log_success_msg "Usage: /etc/init.d/first-run {start}" exit 1 ;; esac freedombox-setup/debian/rules0000755000000000000000000000034512325420320013531 0ustar #!/usr/bin/make -f %: dh $@ --with python2 override_dh_installinit: dh_installinit --no-start --name=freedombox-first-run -u"start 20 2 3 4 5 ." dh_installinit --no-start --name=freedombox-client-proxy -u"start 20 2 3 4 5 ." freedombox-setup/debian/changelog0000644000000000000000000006036112400167320014331 0ustar freedombox-setup (0.2) unstable; urgency=low * Updated documentation from the wiki. * Adjust test suite to use localhost as hostname if no /etc/hostname exist in the test environment. * Change Vcs-Browser field to the cgit interface. -- Petter Reinholdtsen Fri, 29 Aug 2014 23:20:48 +0200 freedombox-setup (0.1) unstable; urgency=high [ James Valleroy ] * Fix typos in first-run.d and setup.d scripts. Remove unused function. [ Petter Reinholdtsen ] * Correct DEBIAN_FRONTEND setting in testsuite to only use lower case letters in value. * Only insert /home/fbx/README in setup.d/45_user-doc if /home/fbx exist. * Make sure /etc/hostname exist in testsuite chroot. * Disable shell tracing in testsuite script now that it is working. -- Petter Reinholdtsen Mon, 25 Aug 2014 08:15:52 +0200 freedombox-setup (0.0.49) unstable; urgency=medium [ James Valleroy ] * Fix wrong quote character in setup.d/99_provide-source (Closes: #756529). * Clean up beaglebone related code. * Adjust Tor setup to enable it as a transparent proxy. [ Petter Reinholdtsen ] * Change test-chroot to use SOURCE=false to avoid trying to download the source packages when testing. * Adjust test-chroot to use DEBIAN_FRONTEND=Noninteractive, as no tty is available when testing. -- Petter Reinholdtsen Sun, 03 Aug 2014 11:46:38 +0200 freedombox-setup (0.0.48) unstable; urgency=medium * Depend on libpam-tmpdir to separate user temporary files by default. * Depend on libpam-abl to make brute force login attacks harder by default. * Update documentation from wiki. * Explain in setup.d/99_provide-source that source is added when it is done. * Add autopkgtest check running the setup script. * Move monkeysphere from depends to suggests while we wait for a solution for bug #635711. -- Petter Reinholdtsen Mon, 28 Jul 2014 20:42:05 +0200 freedombox-setup (0.0.47) unstable; urgency=low [ Nick Daly ] * Tee rpi-update output to the build log. * Rename NOSOURCE variable to SOURCE. * Remove IPv6 configuration from networking auto-config, as network setup seem to choke on it. -- Petter Reinholdtsen Sat, 14 Jun 2014 08:08:34 +0200 freedombox-setup (0.0.46) unstable; urgency=medium [ James Valleroy ] * Add support for Beaglebone using the linux-image-armmp kernel in Debian. * Adjust serial port setup to handle both Dreamplug and Beaglebone. -- Petter Reinholdtsen Fri, 16 May 2014 22:24:50 +0200 freedombox-setup (0.0.45) unstable; urgency=low [ Petter Reinholdtsen ] * Depend on firewalld to block all access by default, and require active involvement to open a port. This require an updated plinth package. * Depend on how-can-i-help to let every user of apt know about problems with 'our' packages. [ James Valleroy ] * Add IPv6 support to network interfaces, privoxy, ejabberd. * Add apache conf for jwchat, separate from fbx site conf. * Add initial support for the Beagle Bone. * Skip backup in rpi-update to avoid error caused by recent change in rpi-update triggering error when no kernel is installed when rpi-update is executed the first time. [ Sunil Mohan Adapa ] * Remove freedombox-client-proxy script, as all the iptables rules are now handled by the plinth package. Depend on plinth (>= 0.3.2.0.git.20140504-1) to get a version with these rules. [ Petter Reinholdtsen ] * Disable downloading of non-Debian packages for the Beagle Bone. We want to use Debian packages for this. * Remove now obsolete init.d scripts /etc/init.d/proxy and /etc/init.d/freedombox-client-proxy on upgrades. * Add curl as binary dependency, as rpi-update switched from wget to curl a month ago. in commit dd495b8dd7f36dc411f2ed2bbdc21e4062b01a62. -- Petter Reinholdtsen Sun, 04 May 2014 09:59:58 +0200 freedombox-setup (0.0.44) unstable; urgency=low * Update Standards-Version from 3.9.4 to 3.9.5. No changes needed. * Add dependency on unattended-upgrades to make it easier to handle upgrades. * Rename init.d scripts first-run to freedombox-first-run and proxy to freedombox-client-proxy, to make it easier to see in /etc/init.d/ which scripts belong to the freedombox setup. * Adjust freedombox-first-run boot dependencies to run after firewalld, tor, haveged, lxc and pagekite, in case those are needed to set up the system. * Rename interface_detect to interface-detect, for more consistent naming with the other sbin tools in this package. * Rename setup.d/10_dreamplug to setup.d/10_hardware to better reflect its current task. * Drop checkinstall from dependencies. It is not used, as far as I can tell. * Drop lua-sec, python-augeas, python-beautifulsoup, python-bjsonrpc, python-docutils and python-lxml from dependencies. None of them are used, as far as I can tell, and they are libraries that should be pulled in by packages that need them. * Drop python-argparse from dependencies, it is now a virtal package provided by libpython2.7-stdlib. * Add dblatex, w3m and zip as build dependencies for the new documentation setup to get the package building automatically (Closes: #745539). -- Petter Reinholdtsen Tue, 22 Apr 2014 20:56:00 +0200 freedombox-setup (0.0.43) unstable; urgency=low * Add Sunil Mohan Adapa as uploader. * Correct copyright info for lxc-templates/lxc-debian-freedombox, it is LGPL 2.1+, not GPL2+. -- Petter Reinholdtsen Tue, 15 Apr 2014 14:21:48 +0200 freedombox-setup (0.0.42) unstable; urgency=low [ Petter Reinholdtsen ] * Drop the README.fbx-home file, and generate it from via Docbook. Store the docbook version of the manual in the source tarball. * Build-depend on libxml2-utils, xmlto and libwww-perl to build the documentation. [ James Valleroy ] * In initial apache setup, disable plinth.conf if plinth-ssl.conf is enabled. -- Petter Reinholdtsen Fri, 28 Mar 2014 16:55:02 +0100 freedombox-setup (0.0.41) unstable; urgency=low [ James Valleroy ] * Change Tor config based on feedback from the Tor community. * Correct ethernet ports in proxy init script. eth0 is external and eth1 is internal. * Make privoxy listen on all interfaces. * Add IPv6 tests. * Make Tor control socket tests a little more robust. * Rewrite Tor obfsproxy test to avoid relying on log file. [ Petter Reinholdtsen ] * Add draft rules in doc/ to generate the documentation from the wiki using docbook transformations. * Recommend the pagekite package currently in NEW. -- Petter Reinholdtsen Thu, 27 Mar 2014 08:35:38 +0100 freedombox-setup (0.0.40) unstable; urgency=low [ James Valleroy ] * For wifi AP setup, source machine-detect and check if $MACHINE is dreamplug. [ Petter Reinholdtsen ] * Add Avahi service definitions for domain(53), ssh(22), sftp-ssh(22) and xmpp-server(5269) to announce the services we provide. -- Petter Reinholdtsen Sat, 22 Mar 2014 14:20:41 +0100 freedombox-setup (0.0.39) unstable; urgency=low * Adjust tor testsuite message to be more clear. * Depend on plinth (>= 0.3.1.git.20140304-1), the version now in jessie. * Document copyright for lxc-templates/lxc-debian-freedombox. * Add missing build dependency on python-support and python | python-all | python-dev | python-all-dev as well as raise debhelper compat version from 8 to 9 to use the python rules automatically. -- Petter Reinholdtsen Thu, 20 Mar 2014 23:14:56 +0100 freedombox-setup (0.0.38) unstable; urgency=low * Added ntp testsuite check. * Correct project git repository URL used in the README. * Depend on avahi-daemon to announce available services on the local net and provide mdns hostname info. Depend on avahi-utils to include tools to use avahi. Depend on libnss-mdns to enable mdns. * Depend on libnss-gw-name to make sure gateway.localhost always map to the current default gateway. * Remove iproute dependency. It is a isc-dhcp-client dependency and we do not need a direct dependency. * Remove python-cheetah and python-cherrypy3 dependencies. They are a plinth dependency and we do not need a direct dependencies. -- Petter Reinholdtsen Thu, 20 Mar 2014 09:10:14 +0100 freedombox-setup (0.0.37) unstable; urgency=low [ James Valleroy ] * Added new jwchat testsuite check. * Use correct hostname for ejabberd and jwchat, when running setup.d scripts inside a chroot. [ Petter Reinholdtsen ] * Removed git and mercurial as dependencies. They are no longer used in setup.d/ as no source repositories are downloaded any more. * Also removed make and build-essential, as building source is no longer needed to get services working. * Removed libpython2.7 as dependency. As far as 'aptitude why' can see, depending on python-augeas is enough to pull it in. * Removed python-simplejson as dependency. As far as 'aptitude why' can see, depending on plinth is enough to pull it in. -- Petter Reinholdtsen Tue, 18 Mar 2014 23:29:56 +0100 freedombox-setup (0.0.36) unstable; urgency=low [ Petter Reinholdtsen ] * Quiet down ldap-server testsuite test. * Start on Tor testsuite test. Check if wget via tor work. * Add privoxy test to check if the proxy really work. * Adjust plinth testsuite test to skip certificate check, as it is self signed and wget fail without --no-check-certificate. [ James Valleroy ] * Change setup.d/80_tor to not disable Tor socks port in the default configuration of tor. -- Petter Reinholdtsen Mon, 17 Mar 2014 06:48:57 +0100 freedombox-setup (0.0.35) unstable; urgency=low * Upload to Debian unstable. * Update the package description. * Add homepage and vcs links in control file. * Depend on essential package hostname to ensure it is pulled in also when using debootstrap --variant minbase. * Move ~fbx/README file to /usr/share/doc/ and copy it in place in setup.d/45_user-doc, to make sure file only show up when setting up a FreedomBox. -- Petter Reinholdtsen Sun, 16 Mar 2014 20:25:47 +0100 freedombox-setup (0.0.34) wheezy; urgency=low [ Nick Daly ] * Reverse roles of eth0 and eth1 ports. Now, eth0 is a DHCP client, and eth1 (if it exist) is a DHCP server. -- Petter Reinholdtsen Fri, 14 Mar 2014 22:28:48 +0100 freedombox-setup (0.0.33) wheezy; urgency=low [ Nick Daly ] * Generate random Globalscale MAC addresses, not Xerox ones. [ Petter Reinholdtsen ] * Add Bdale Garbee and Nick Daly as uploaders. -- Petter Reinholdtsen Thu, 13 Mar 2014 18:34:45 +0100 freedombox-setup (0.0.32) wheezy; urgency=low [Nick Daly] * MAC changes now apply to /etc/network/interfaces; fix docs. - The sed command shouldn't've started with "^". - Don't "wc -l" the wired interface list. - Replace deprecated "service networking restart". - Tabs to 4 spaces. (everywhere) * Moved provide-source from 60 to 99 to make sure the source of all packages are fetched for images needing source. -- Petter Reinholdtsen Fri, 28 Feb 2014 22:52:54 +0100 freedombox-setup (0.0.31) wheezy; urgency=low [ Nick Daly ] * Correct network setup to use bash and work better on the Dreamplug. -- Petter Reinholdtsen Tue, 04 Feb 2014 23:05:01 +0100 freedombox-setup (0.0.30) wheezy; urgency=low [ Petter Reinholdtsen ] * Add ntp as dependency, to make sure the clock is correct (and not 1970, as it end up as on the Raspberry PI). * Drop unused pandoc from dependency list. Thanks to Nick Daly for noticing, as it is currently missing in Jessie. [ Nick Daly ] * Drop setup.d/70_fetch-projects. Those that want to look at the source can fetch it themselves. * Drop unused setup.d/75_projects-setup. * Adjust network setup to get it working on the Dreamplug. -- Petter Reinholdtsen Mon, 27 Jan 2014 15:08:51 +0100 freedombox-setup (0.0.29) wheezy; urgency=low [ James Valleroy ] * Force overwrite of snakeoil certificates during first run script. -- Petter Reinholdtsen Mon, 02 Dec 2013 01:32:04 +0100 freedombox-setup (0.0.28) wheezy; urgency=low [ James Valleroy ] * Add setup script to install tor as bridge relay. * Fix lxc template install location. -- Petter Reinholdtsen Sun, 01 Dec 2013 18:42:49 +0100 freedombox-setup (0.0.27) wheezy; urgency=low [ James Valleroy ] * Dreamplug: after configuring network in first-run, setup persistent rules using udev script write_net_rules. -- Petter Reinholdtsen Sun, 17 Nov 2013 22:14:17 +0100 freedombox-setup (0.0.26) wheezy; urgency=low * Extend plinth-server test to check HTTP reply from plinth. * New web-proxy test to check if privoxy is listening. * Depend on lsof to make debugging easier. * Depends and recommends on batctl, bridge-utils, rfkill and wireless-tools to have the tools needed to configure wireless, bridging and batman-adv mesh networking available. Recommends for the packages that might not be available on all architectures. * Change setup.d/91_privoxy to install privoxy instead of freedombox-privoxy, as the latter seem to have no maintainer at the moment. -- Petter Reinholdtsen Sun, 03 Nov 2013 10:48:46 +0100 freedombox-setup (0.0.25) wheezy; urgency=low * Depend on vim-tiny to get some editor installed by default. * Add debug information when configuring git for etckeeper. * Change setup.d/90_apache2 to not expand variables when creating /etc/apache2/sites-available/fbx.conf. Based on patch from James Valleroy. -- Petter Reinholdtsen Sat, 02 Nov 2013 07:15:11 +0100 freedombox-setup (0.0.24) wheezy; urgency=low * Move code to set up /etc/network/interfaces from setup.d/ to first-run.d/05_network to allow it to be configured based on the detected hardware on first boot. * Move first-run flag file to /var/lib/freedombox/ for FHS compliance. * Invert logic deciding when to run the first-run init.d script, to make sure it is only run after setup.d is executed, and not by just installing freedombox-setup, to avoid surprising those testing the Debian package. -- Petter Reinholdtsen Fri, 01 Nov 2013 20:41:05 +0100 freedombox-setup (0.0.23) wheezy; urgency=low [ James Valleroy ] * Add a new apache server conf file to replace jwchat.conf and forward plinth requests to plinth.conf. [ Petter Reinholdtsen ] * Change setup.d/10_dreamplug to only add /tmp/ as tmpfs in fstab, as the code setting device names for / and /boot/ is not needed when we use vmdebootstrap. -- Petter Reinholdtsen Thu, 31 Oct 2013 18:43:35 +0100 freedombox-setup (0.0.22) wheezy; urgency=low * Add binary dependency on dnsutils for dig to get testsuite working out of the box. * Add binary dependency on hostname needed by setup.d scripts. * Avoid force removal of file to avoid warning om setup.d/98_next-is- first-run when /var/freedombox/first-run is missing. -- Petter Reinholdtsen Wed, 30 Oct 2013 09:12:06 +0100 freedombox-setup (0.0.21) wheezy; urgency=low * Disable setup.d/50_openvpn, which seem to be old cruft. * Add new dns-server check to detect if DNSSEC is enabled or not. * Make sure first-run logs output to /var/log/freedombox-first-run.log. -- Petter Reinholdtsen Tue, 29 Oct 2013 23:34:03 +0100 freedombox-setup (0.0.20) wheezy; urgency=low * Remove setup.d/85_plinth, now part of the plinth package. * Add two new testsuite checks, looking for a running Plinth and DNS server. -- Petter Reinholdtsen Mon, 28 Oct 2013 10:02:56 +0100 freedombox-setup (0.0.19) wheezy; urgency=low * Start on test suite framework. Add simple LDAP and XMPP test as a start. * Insert code in setup.d/10_dreamplug to set up Dreamplug and Raspberry Pi kernel and initrd, as well as enabling serial console on the Dreamplug, copied from the freedom-maker system. -- Petter Reinholdtsen Mon, 28 Oct 2013 08:06:10 +0100 freedombox-setup (0.0.18) wheezy; urgency=low * Update dnsmasq server configuration for new version in Debian Jessie. Patch from James Valleroy. -- Petter Reinholdtsen Sat, 19 Oct 2013 20:47:41 +0200 freedombox-setup (0.0.17) wheezy; urgency=low [ Petter Reinholdtsen ] * Added new dependencies htop, iftop and tcpdump to make it easier to debug the freedombox. Might be removed in a release build. * Added setup.d/98_next-is-first-run to make sure /var/freedombox/first-run is removed and init.d/first-run is triggered on the next reboot. * Update setup.d/85_plinth with the apache modules needed to get plinth+ssl working. -- Petter Reinholdtsen Sat, 19 Oct 2013 09:20:13 +0200 freedombox-setup (0.0.15) wheezy; urgency=low [ Nick Daly ] * Adjust setup.d/95_plinth to use Apache config from the new plinth package, which should fix SSL setup. [ Petter Reinholdtsen ] * Depend on plinth (>= 0.3.0.0.git.20131007.pere.2) to get a version that should work with the new setup.d/85_plinth file. -- Petter Reinholdtsen Mon, 07 Oct 2013 12:18:18 +0200 freedombox-setup (0.0.14) wheezy; urgency=low [ Petter Reinholdtsen ] * Make sure to exit on first error in postinst (thank you lintian). * Adjust first-run init.d script to commit to etckeeper before starting too, to document changes done at this stage. * Disable SSL in plinht, as it isn't working yet. * Fix typo causing apache to log to /error.log and /access.log for plinth. [ James Valleroy ] * Fix bug in fetch-projects that caused a few projects to end up in root directory. -- Petter Reinholdtsen Sun, 06 Oct 2013 11:42:04 +0200 freedombox-setup (0.0.13) wheezy; urgency=low * Correct etckeeper/git workaround to really detect when user.email must be set. -- Petter Reinholdtsen Sat, 05 Oct 2013 14:17:28 +0200 freedombox-setup (0.0.12) wheezy; urgency=low * Added LXC template debian-freedombox by Rob van der Hoeven from http://freedomboxblog.nl/data/lxc-debian-box.gz. * Adjusted setup.d/20_lxc to document how it could be used. * Updated LXC template debian-freedombox with changes done in lxc version 0.9.0~alpha3-2+deb8u1, to only keep the relevant changes relative to the official Debian version in Jessie. * Added postinst script to fix etckeeper user.email if the automatic value is invalid. * Added new setup.d/15_ssh-keys to remove the SSH keys before any images are created, to make sure only unique keys are used on clients. * Added new first-run.d/85_jwchat and adjusted setup.d/85_jwchat to remove ejabberd SSL certificate from images and generate it on first boot. * Added new setup.d/30_ldap-server to start on LDAP server setup. -- Petter Reinholdtsen Sat, 05 Oct 2013 13:21:25 +0200 freedombox-setup (0.0.11) wheezy; urgency=low * Fix setup.d/20_lxc, make sure to install lxc non-interactively. * Adjust setup.d/60_provide-source to skip this step if NOSOURCE=true is set, to speed up test installations. * Add the d-i preseed files to preseed/ in the source package. * Adjusted setup.d/70_fetch-projects to look up home directory and gid dynamically. Corrected GIT url for FreedomBuddy. * Adjusted setup.d/01_etckeeper-pre to set the global git user.email for root to make sure etckeeper always is able to commit changes. * Adjusted first-run init.d script to commit changes in /etc/ using etckeeper. -- Petter Reinholdtsen Tue, 01 Oct 2013 10:03:53 +0200 freedombox-setup (0.0.10) wheezy; urgency=low [ Nick Daly ] * Update handling of SSL setup in apache. [ Petter Reinholdtsen ] * Move generation of snakeoil SSL certificate from setup to first-run, to make it unique for each machine. * New script setup.d/20_lxc to set up LXC for use by the different services. -- Petter Reinholdtsen Tue, 01 Oct 2013 07:22:58 +0200 freedombox-setup (0.0.9) wheezy; urgency=low [ Petter Reinholdtsen ] * Added key-report and freedombox-todos to list of repositories feched by setup.d/70_fetch-projects. Dropped exmachina, now integrated with plinth. * Added setup.d/05_apt-sources to disable cdrom APT sources after installation, to make sure plinth can install packages without asking for a CD to be installed. * Rewrote setup.d/30_dnsmasq-server to split config in three parts, one static and two that could change. [ Nick Daly ] * Added setup.d/01_etckeeper-pre to store /etc/ status before applying FreedomBox setup. * Added code to use snakeoil SSL certificate with Apache, and put plinth behind this https connection. -- Petter Reinholdtsen Mon, 30 Sep 2013 20:38:23 +0200 freedombox-setup (0.0.8) wheezy; urgency=low * Fix typo in 90_jwchat hanging the setup. -- Petter Reinholdtsen Sun, 15 Sep 2013 23:17:09 +0200 freedombox-setup (0.0.7) wheezy; urgency=low * Fix typo in update-rc.d arguments in rules file. * Adjust setup.d/80_plinth to create apache site file with .conf ending to work with apache2 in Jessie. * Created new /usr/lib/freedombox/first-run.d/ directory and moved most code from init.d/first-run to this directory, to make the first-run code extendable using extra packages. -- Petter Reinholdtsen Sun, 15 Sep 2013 22:32:56 +0200 freedombox-setup (0.0.6) wheezy; urgency=low * Pull in libnss-myhostname and remove host name from /etc/hosts, to avoid having to update /etc/hosts when the local hostname change. * Drop unused wajig as dependency. * Make sure to commit the current status of /etc/ at the end of the setup.d run. * Adjust 90_jwchat to only update ejabberd.cfg once if it is executed several times. -- Petter Reinholdtsen Sun, 15 Sep 2013 09:51:57 +0200 freedombox-setup (0.0.5) wheezy; urgency=low * Drop prosody from dependencies, as jwchat pull in ejabberd and two XMPP servers should not be running at the same time on the Freedombox. * Drop isc-dhcp-server from dependencies and disable setup.d/40_dhcp-server for now, as dnsmasq is also providing a DHCP server and we only need one DHCP server. As dnsmasq also is the DNS server, it can not be removed without a larger rewrite of the setup. * Make sure the jwchat and ejabberd configuration contain the correct hostname and ejabberd have mod_http_bind enabled to get XMPP and jwchat working out of the box. Patch from James Valleroy. -- Petter Reinholdtsen Sun, 15 Sep 2013 06:51:29 +0200 freedombox-setup (0.0.4) wheezy; urgency=low * Add new setup.d/91_privoxy to set up freedombox-privoxy. * Remove plinth related call for 'a2enmod rewrite' in first-run, as it is already done in setup.d/80_plinth and do not have to happen during first boot. * Rewrite first-run and proxy script to use log_* functions for output. * Rewrite first-run script from bash to Bourne sh, to avoid the need to load bash during boot. -- Petter Reinholdtsen Tue, 10 Sep 2013 12:13:51 +0200 freedombox-setup (0.0.3) wheezy; urgency=low * Replace transitional package liblua5.1-sec1 with lua-sec, fixing installation problem in jessie. * Make sure to install jwchat non-interactively. -- Petter Reinholdtsen Tue, 10 Sep 2013 00:14:55 +0200 freedombox-setup (0.0.2) wheezy; urgency=low * Do not depend on jwchat, but instead pull it in using a setup.d script, to avoid failing to install when jwchat fail to install like it currently do in testing. * Add new helper script dreamplug-detect, and move all sbin tools to /usr/sbin/. -- Petter Reinholdtsen Mon, 09 Sep 2013 23:20:04 +0200 freedombox-setup (0.0.1) wheezy; urgency=low * Initial version based on setup from freedom-maker. -- Petter Reinholdtsen Mon, 09 Sep 2013 19:50:35 +0200 freedombox-setup/debian/compat0000644000000000000000000000000212312663407013660 0ustar 9 freedombox-setup/debian/freedombox-setup.maintscript0000644000000000000000000000024612327651211020227 0ustar mv_conffile /etc/init.d/first-run /etc/init.d/freedombox-first-run 0.0.43 rm_conffile /etc/init.d/proxy 0.0.43 rm_conffile /etc/init.d/freedombox-client-proxy 0.0.44 freedombox-setup/debian/freedombox-setup.postinst0000644000000000000000000000111012235001565017543 0ustar #!/bin/sh set -e # Avoid etckeeper problem (refuses to commit) because git picked a # email address with an empty mail domain. if which etckeeper > /dev/null 2>&1 && \ [ ! -e /etc/mailname ] && [ -z "$(git config --global --get user.email)" ] ; then git config --global user.email "root@localhost" fi # Migrate flag file to new inverted logic when upgrading if dpkg --compare-versions "$2" le "0.0.23" && [ -e /var/freedombox/first-run ] ; then rm /var/lib/freedombox/first-run-enable rm /var/freedombox/first-run rmdir /var/freedombox fi #DEBHELPER# freedombox-setup/debian/control0000644000000000000000000000303012400167014014050 0ustar Source: freedombox-setup Section: misc Priority: optional Maintainer: Petter Reinholdtsen Uploaders: Bdale Garbee , Nick Daly , Sunil Mohan Adapa Build-Depends: debhelper (>= 9) , python-support , python | python-all | python-dev | python-all-dev , libxml2-utils , xmlto , dblatex , w3m , zip , libwww-perl Standards-Version: 3.9.5 XS-Testsuite: autopkgtest Homepage: https://wiki.debian.org/FreedomBox Vcs-Git: git://anonscm.debian.org/freedombox/freedombox-setup.git Vcs-Browser: http://anonscm.debian.org/cgit/freedombox/freedombox-setup.git Package: freedombox-setup Architecture: all Depends: ${misc:Depends} , ${python:Depends} , apache2 | apache2-mpm-worker , augeas-tools , avahi-daemon , avahi-utils , bridge-utils , devio , dialog , dnsmasq , dnsutils , dosfstools , etckeeper , firewalld , haveged , hostname , how-can-i-help , htop , iftop , iptables , iputils-ping , isc-dhcp-client , libnss-gw-name , libnss-mdns , libnss-myhostname , libpam-tmpdir , libpam-abl , locales , locales-all , lsof , macchanger , net-tools , ntp , openssh-server , parted , plinth (>= 0.3.2.0.git.20140504-1) , psmisc , resolvconf , ssl-cert , sudo , tcpdump , uaputl , unattended-upgrades , vim-tiny , wget , curl , zile Recommends: batctl , rfkill , wireless-tools , pagekite Suggests: monkeysphere Description: Package to set up freedombox environment Configure the Freedombox environment before and after the first reboot. freedombox-setup/debian/freedombox-setup.docs0000644000000000000000000000002412311374402016611 0ustar doc/README.fbx-home freedombox-setup/debian/copyright0000644000000000000000000000447112323222251014411 0ustar Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0 Files: * Copyright: © 2011-2012 Bdale Garbee © 2011 Thiago Jung Bauermann © 2011-2012 Jonas Smedegaard © 2012 Craig Barnes © 2012 James Valleroy © 2012 Tom Galloway © 2012-2013 Nick Daly © 2013 Ivan Savov © 2013 Keith Fernie © 2013 Petter Reinholdtsen License: GPL-3.0+ Files: lxc-templates/lxc-debian-freedombox Copyright: © 2007-2012 IBM Corporation and Daniel Lezcano © 2013 Rob van der Hoeven License: LGPL-2.1+ License: GPL-3.0+ This package is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. . This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. . You should have received a copy of the GNU General Public License along with this program. If not, see . On Debian systems, the complete text of the GNU General Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". License: LGPL-2.1+ This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. . This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. . You should have received a copy of the GNU Lesser General Public License along with this library; if not, see . . The complete text of the GNU General Public License can be found in /usr/share/common-licenses/LGPL-2.1 file. freedombox-setup/debian/tests/0002755000000000000000000000000012400167230013615 5ustar freedombox-setup/debian/tests/test-chroot0000755000000000000000000000311412400166732016021 0ustar #!/bin/sh set -e # Enable when debugging #set -x at_exit() { for m in $umount ; do echo info: umounting "$m" umount "$m" done } trap at_exit INT TERM EXIT chroot_test() { cd $ADTTMP target=test-chroot suite=testing DEBIAN_FRONTEND=noninteractive export DEBIAN_FRONTEND debootstrap --include freedombox-setup testing $target printf "#!/bin/sh\nexit 101\n" > $target/usr/sbin/policy-rc.d chmod a+rx $target/usr/sbin/policy-rc.d # Workaround for resolvconf not working in chroot without /run # mounted. rm $target/etc/resolv.conf cp /etc/resolv.conf $target/etc/resolv.conf # Make sure chroot have some kind of hostname set in /etc/ if [ -e /etc/hostname ] ; then cp /etc/hostname $target/etc/hostname else echo localhost > $target/etc/hostname fi mount -t proc proc $target/proc umount="$target/proc" mount -t sysfs sysfs $target/sys umount="$target/proc $target/sys" # Workaround for something mounting /sys/fs/cgroup umount="$target/sys/fs/cgroup $umount" chroot $target /usr/lib/freedombox/setup # List packages with problems in Debian chroot $target how-can-i-help --old # Workaround for something mounting /sys/fs/cgroup umount $target/sys/fs/cgroup umount $target/proc umount="$target/sys" umount $target/sys umount="" rm -rf $target } # Use predictable language setting. # FIXME should try several to check language specific setup LC_ALL=C export LC_ALL # Run test without downloading all the source SOURCE=false chroot_test exit 0 freedombox-setup/debian/tests/control0000644000000000000000000000010112365502371015217 0ustar Tests: test-chroot Depends: debootstrap Restrictions: needs-root freedombox-setup/debian/freedombox-setup.install0000644000000000000000000000055412325422101017332 0ustar setup usr/lib/freedombox setup.d usr/lib/freedombox testsuite usr/lib/freedombox first-run.d usr/lib/freedombox sysctl.d/freedombox-setup.conf etc/sysctl.d sbin/copy2dream usr/sbin sbin/machine-detect usr/sbin sbin/interface-detect usr/sbin sbin/tor-get-orport usr/sbin lxc-templates/lxc-debian-freedombox usr/share/lxc/templates avahi-services etc/avahi/services freedombox-setup/first-run.d/0002755000000000000000000000000012376551352013422 5ustar freedombox-setup/first-run.d/80_flash-kernel0000755000000000000000000000155112366115447016232 0ustar #!/bin/sh # # Update the kernel if package flash-kernel is install unless # requested otherwise. . /lib/lsb/init-functions if ! type flash-kernel > /dev/null 2>&1 ; then return fi if [ -e /var/freedombox/dont-tweak-kernel ] then log_warning_msg "Skipped Flashing Kernel." return else . machine-detect if [ "$MACHINE" = "dreamplug" ]; then kernel_version="$(/bin/ls $mountpoint/boot/vmlinuz-*-kirkwood | sort -rn | head -n1 | sed s#$mountpoint/boot/vmlinuz-##)" else if [ "$MACHINE" = "beaglebone" ]; then kernel_version="$(/bin/ls $mountpoint/boot/vmlinuz-*-armmp | sort -rn | head -n1 | sed s#$mountpoint/boot/vmlinuz-##)" fi fi log_action_begin_msg "Flashing Kernel version $kernel_version " if flash-kernel $kernel_version ; then log_action_end_msg 0 else log_action_end_msg 1 fi fi freedombox-setup/first-run.d/85_jwchat0000755000000000000000000000020612223772000015122 0ustar #!/bin/sh # Generate new SSL certificates. rm -f /etc/ejabberd/ejabberd.pem DEBIAN_FRONTEND=noninteractive dpkg-reconfigure ejabberd freedombox-setup/first-run.d/20_gpg-key0000755000000000000000000000044312215410555015202 0ustar #!/bin/sh # # see http://lists.gnupg.org/pipermail/gnupg-users/2003-March/017376.html # . /lib/lsb/init-functions #log_action_begin_msg "Creating GPG key" #echo " Need to create other keys." #if gpg --batch --gen-key ; then # log_action_end_msg 0 # else # log_action_end_msg 1 # fi freedombox-setup/first-run.d/05_network0000755000000000000000000001124712376550524015350 0ustar #!/bin/bash # Configure networking for device. # # Adds entries to the network interface file. # # First parameter is the path to the network interface file to # configure. if [ -n "$1" ] then IFACES_FILE=$1 else IFACES_FILE=/etc/network/interfaces fi INTERFACE_DETECT="interface-detect" function get-wired-interfaces { # set WIRED_IFACES to list of wired interfaces, less lo. WIRED_IFACES=`$INTERFACE_DETECT | grep "wired" \ | grep "^[^l][^o]"` } function remove-udev { # removes udev rules. rm -f /etc/udev/rules.d/75-persistent-net-generator.rules } function sort-interfaces { # always name interfaces in same order as MAC addresses # "service networking restart" deprecated. service networking stop; service networking start MACS=$(ifconfig | awk '/Ethernet/ { print $5 }' | sort) COUNT=0 for MAC in $MACS; do export MATCHADDR=$MAC export INTERFACE=eth export INTERFACE_NAME=eth$COUNT /lib/udev/write_net_rules COUNT=$((COUNT+1)) done } function interfaces-start { # creates empty network-interfaces file. cat > $IFACES_FILE <> $IFACES_FILE <> $IFACES_FILE <> $IFACES_FILE <> $IFACES_FILE <> /etc/tor/torrc fi if ! grep -q "TransPort $ip:9040" /etc/tor/torrc ; then echo "TransPort $ip:9040" >> /etc/tor/torrc fi if ! grep -q "DNSPort $ip:53" /etc/tor/torrc ; then echo "DNSPort $ip:53" >> /etc/tor/torrc fi done freedombox-setup/first-run.d/40_apache20000755000000000000000000000025112246752271015151 0ustar #!/bin/sh # # Make sure every machine have their own unique SSL certificate, even # if it is a snake oil one. make-ssl-cert generate-default-snakeoil --force-overwrite freedombox-setup/README0000644000000000000000000000221012312146274012111 0ustar Set up FreedomBox using deb packages ==================================== To make sure a FreedomBox can be set up on any architecture supported by Debian, the code and settings used to configure packages are gathered in this deb. The scripts in setup.d/ are executed during installation to install and configure different parts of the FreedomBox. Note that most setup should be done as plinth modules on request of its user, and not during installation. These scripts should not make any assumtions about hostname or encryption keys, as these will be set or generated on the first boot. The scripts in first-run.d/ are executed during first boot, and the end of the boot sequence. After freedombox-setup is installed, the /usr/lib/freedombox/setup should be called to finish the setup. On the first boot, /etc/init.d/first-run is called and a reboot done when it finishes to make sure all services are started with the correct configuration. To create the deb file: sudo apt-get install git build-essential debhelper devscripts cd ~/ git clone git://anonscm.debian.org/freedombox/freedombox-setup.git cd freedombox-setup debuild freedombox-setup/Makefile0000644000000000000000000000005012315226420012664 0ustar all clean distclean: $(MAKE) -C doc $@ freedombox-setup/sbin/0002755000000000000000000000000012327650477012206 5ustar freedombox-setup/sbin/tor-get-orport0000755000000000000000000000065712313654521015033 0ustar #!/bin/sh # # Get ORPort number from Tor control port. # Usage: tor-get-orport # # Tor control port must be enabled on localhost port 9051. # cookie=`perl -e 'my $a=do{local(@ARGV,$/)="/var/run/tor/control.authcookie"; <>}; warn unpack("H*",$a)' 2>&1 | awk '{print $1}'` response=`nc localhost 9051` <. """ def execute(command): """Return a command's output. Don't escape the command. Return empty strings instead of *None* if the specified command had no output or if it errored. """ try: process = subprocess.Popen( shlex.split(command), stdout=subprocess.PIPE, stderr=subprocess.PIPE) except OSError: details = (None, None) else: details = process.communicate() return [(x if x else "") for x in details] def parse_interface_and_macs(): """Associate all interfaces with their MAC addresses. Parse *ifconfig* output and record each interface's MAC address. Also, record the interfaces that share MAC addresses. """ output, error = execute("ifconfig -a") interfaces, macs = dict(), DefaultDict(list) for line in output.splitlines(): if not line.split() or line.startswith(" "): continue line = line.split() interface = line[0] mac = line[-1] interfaces[interface] = mac macs[mac] += interface return interfaces, macs def parse_connection_type(interfaces, macs): """Identify and record which interfaces are wired and wireless. *iwconfig* returns wireless interfaces in *stdout* and wired interfaces in *stderr*. It's quite strange. """ output, error = execute("iwconfig") wired, wireless = dict(), dict() wired = parse_iwconfig(wired, macs, error) wireless = parse_iwconfig(wireless, macs, output) return wired, wireless def parse_iwconfig(interfaces, macs, details): """Actually parse the *iwconfig* output. Each *iwconfig* line that identifies an interface starts with the interface's name and contains data about the networks supported or the line ~no wireless extensions.~, if the interface is a wired interface. *iwconfig* doesn't currently appear to display interface aliases, so we can use its output to filter out the aliases that don't refer to real, physical interfaces. """ for line in details.splitlines(): if not line.split() or line.startswith(" "): continue line = line.split() interface = line[0] interfaces[interface] = macs[interface] return interfaces if __name__ == "__main__": interfaces, macs = parse_interface_and_macs() wired, wireless = parse_connection_type(interfaces, macs) display_items = lambda items, type_: [ ",".join([iface, type_, interfaces[iface]]) for iface in items] print("\n".join(display_items(wired, "wired"))) print("\n".join(display_items(wireless, "wireless"))) freedombox-setup/sbin/copy2dream0000644000000000000000000000271612213402021014150 0ustar #!/bin/sh # # this script assumes the current root filesystem is the source, and the # internal microSD on a DreamPlug is the target .. all existing content on # the microSD card will be lost. # # partition microSD card inside DreamPlug echo "=> partition internal microSD card" parted -s /dev/sda mklabel msdos parted -s /dev/sda mkpart primary fat16 0 128 parted -s /dev/sda mkpart primary ext2 128 100% # create filesystems on new partitions echo "=> create filesystems on internal microSD card" mkdosfs /dev/sda1 mke2fs -j /dev/sda2 echo "=> mount target partitions" mount /dev/sda2 /media mkdir -p /media/boot mount /dev/sda1 /media/boot echo "=> copy filesystem content from USB stick to target partitions" (cd / ; tar cpSf - `/bin/ls | grep -v boot | grep -v proc | grep -v sys | grep -v media | grep -v dev`) | (cd /media ; tar xpf -) # the following intentionally ignores subdirectories cp /boot/* /media/boot/ echo "=> touch up target root partition" mkdir /media/proc /media/sys /media/media /media/dev mknod /media/dev/console c 5 1 mknod /media/dev/random c 1 8 mknod /media/dev/urandom c 1 9 mknod /media/dev/null c 1 3 mknod /media/dev/ptmx c 5 2 # patch up /etc/fstab entry for /boot sed -e 's/sdc/sda/g' < /etc/fstab > /media/etc/fstab # flash the kernel and create the device's keys chroot /media /etc/init.d/first-run echo "unmount target partitions" umount /dev/sda1 umount /dev/sda2 echo "=> installation complete, see docs to boot from internal microSD" freedombox-setup/setup0000755000000000000000000000065012213402021012306 0ustar #!/bin/sh # Make sure configuring packages do not start any services if [ ! -e /usr/sbin/policy-rc.d ] ; then cat > /usr/sbin/policy-rc.d </dev/null | \ grep -qa OpenLDAProotDSE ; then success "$0: ldap server on $ldapuri responded" else error "$0: unable to find LDAP root DSE on $ldapuri" fi freedombox-setup/testsuite/web-proxy.test0000755000000000000000000000205412327647333016140 0ustar #!/bin/sh . $(dirname $0)/testsuite-functions netstat_check 8118 tcp privoxy netstat_check 8118 tcp6 privoxy if http_proxy=http://localhost:8118 wget -4 -O - http://www.debian.org/ 2>/dev/null | \ grep -q '/dev/null | \ grep -q '/dev/null | \ grep -q '&1 | grep -q "250 closing connection"` ; then success "$0: Tor control socket is listening on $ip." else error "$0: Tor control socket is not listening on $ip." fi ips=$(ip -4 -o addr | awk '!/^[0-9]*: ?lo|link\/ether/ {gsub("/", " "); print $4}') for ip in $ips do # Check that Tor control socket only listens on localhost. if `echo QUIT | nc $ip 9051 2>&1 | grep -q "250 closing connection"` ; then error "$0: Tor control socket is listening on $ip." else success "$0: Tor control socket is not listening on $ip." fi # Check that Tor Socks listens on every interface. netstat_check_socket $ip:9050 tcp tor done # Check obfsproxy transports transports="obfs3 scramblesuit" for transport in $transports do port=`grep $transport /var/lib/tor/state | awk -F'[: ]*' '{print $4}'` if [ -z "$port" ] ; then error "$0: $transport transport is not registered." else success "$0: $transport transport is registered on port $port." netstat_check $port tcp obfsproxy fi done if torsocks wget -4 -O - http://www.debian.org/ 2>/dev/null | \ grep -q '/dev/null | \ grep -q '/dev/null | \ grep -q 'Congratulations. This browser is configured to use Tor.'; then success "$0: HTTP request to check.torproject.org via TOR on IPv4 confirm that TOR is used." else error "$0: HTTP request to check.torproject.org via TOR on IPv4 confirm that TOR is not used." fi if torsocks wget -6 -O - https://check.torproject.org/ 2>/dev/null | \ grep -q 'Congratulations. This browser is configured to use Tor.'; then success "$0: HTTP request to check.torproject.org via TOR on IPv6 confirm that TOR is used." else error "$0: HTTP request to check.torproject.org via TOR on IPv6 confirm that TOR is not used." fi freedombox-setup/testsuite/xmpp-server.test0000755000000000000000000000036712327647333016501 0ustar #!/bin/sh . $(dirname $0)/testsuite-functions netstat_check xmpp-client tcp XMPP netstat_check xmpp-client tcp6 XMPP netstat_check xmpp-server tcp XMPP netstat_check xmpp-server tcp6 XMPP netstat_check 5280 tcp XMPP netstat_check 5280 tcp6 XMPP freedombox-setup/testsuite/check0000755000000000000000000000010612234000611014252 0ustar #!/bin/sh cd $(dirname $0) for test in ./*.test ; do $test done freedombox-setup/testsuite/testsuite-functions0000644000000000000000000000156712313654521017262 0ustar # -*- shell-script -*- success() { echo "success: $@" } error() { echo "error: $@" } # Check if something is listening on the given port and protocol netstat_check() { port=$1 proto=$2 service="$3" if netstat -a --numeric-hosts 2>&1 | grep ":$port " | grep -q "^$proto" ; then success "$0: $service service is listening on $port/$proto." true else error "$0: $service service is not listening on $port/$proto." false fi } # Check if something is listening on the given socket and protocol netstat_check_socket() { socket=$1 proto=$2 service="$3" if netstat -a --numeric-hosts 2>&1 | grep "$socket " | grep -q "^$proto" ; then success "$0: $service service is listening on $socket/$proto." true else error "$0: $service service is not listening on $socket/$proto." false fi } freedombox-setup/doc/0002755000000000000000000000000012400167332012001 5ustar freedombox-setup/doc/Makefile0000644000000000000000000000253512325532453013452 0ustar #!/usr/bin/make -f URL=https://wiki.debian.org/FreedomBox/Manual/Jessie?action=raw DBURL=https://wiki.debian.org/FreedomBox/Manual/Jessie?action=RenderAsDocbook XMLTOOPTS= XMLTOPDFOPTS=--with-dblatex XMLTOHTMLOPTS= XMLLINTOPTS = --nonet --noout --xinclude --postvalid all: lint manual-jessie.pdf manual-jessie.html manual-jessie.txt manual-jessie.epub manual-jessie.pdf: manual-jessie.xml xmlto $(XMLTOPDFOPTS) $(XMLTOOPTS) pdf $^ manual-jessie.html: manual-jessie.xml xmlto $(XMLTOHTMLOPTS) $(XMLTOOPTS) html-nochunks $^ manual-jessie.txt: manual-jessie.xml LC_ALL=C xmlto txt $^ cp $@ README.fbx-home manual-jessie.epub: manual-jessie.xml LC_ALL=C xmlto epub $^ manual-jessie.xml: GET -H "User-Agent: make" '$(DBURL)' | \ sed "s%%\n<title>%g" | \ sed "s%<\/title>%\n<\/title>%g" | \ sed "s%<section%\n\n<section%g" | \ sed "s%<\/section>%\n<\/section>%g" | \ sed "s%<para>%\n<para>%g" | \ sed "s%<\/para>%\n<\/para>%g" | \ sed "s%FIXME%\nFIXME%g" | \ sed "s%<itemizedlist>%\n<itemizedlist>%" | \ sed "s%<listitem>%\n<listitem>%" | \ cat > $@.new && mv $@.new $@ lint: manual-jessie.xml xmllint $(XMLLINTOPTS) $^ clean: $(RM) manual-jessie.txt manual-jessie.pdf manual-jessie.html manual-jessie.epub manual-jessie.proc distclean: clean $(RM) README.fbx-home �������������������������������������������������������������������������������������������������������������������������������������������������������������������freedombox-setup/doc/manual-jessie.xml��������������������������������������������������������������0000644�0000000�0000000�00000047532�12400166531�015271� 0����������������������������������������������������������������������������������������������������ustar ��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE article PUBLIC '-//OASIS//DTD DocBook XML V4.4//EN' 'http://www.docbook.org/xml/4.4/docbookx.dtd'> <article><articleinfo> <title>FreedomBox/Manual/Jessie 202014-06-14 20:29:03PetterReinholdtsenPagekite is now set up using Plinth. Update documentation.192014-03-28 08:33:04PetterReinholdtsenMention where the authorative source for the document is.182014-03-28 01:50:47NickDalysplit lines correctly in "Building your own" code examples172014-03-28 01:49:16NickDalyMoinWiki doesn't support non-sequential ordered lists, worked around non-sequential numbering.162014-03-28 01:39:30NickDalyFixed diagram numbering.152014-03-26 22:57:42PetterReinholdtsenVisit freedombox/plinth/ to get startet.142014-03-26 22:50:11PetterReinholdtsenPlinth got a new upstream now.132014-03-26 22:04:20PetterReinholdtsenCorrect typos.122014-03-26 22:00:10PetterReinholdtsenCorrect more formatting.112014-03-26 21:26:14PetterReinholdtsenMore formatting fixes.102014-03-26 21:15:40PetterReinholdtsenFix more links.92014-03-26 13:11:12PetterReinholdtsenAvoid some unwanted links.82014-03-26 13:06:20PetterReinholdtsenCorrect heading levels.72014-03-26 12:19:50PetterReinholdtsenFix formatting.62014-03-24 14:04:11PetterReinholdtsenFix some links.52014-03-24 14:01:01PetterReinholdtsenMistake.42014-03-24 13:59:53PetterReinholdtsenTypo.32014-03-24 13:51:07PetterReinholdtsenSecond translformation try, using pandoc to html, and then "html2wiki --dialect=MoinMoin" to convert from HTML to moinmoin.22014-03-24 13:41:46PetterReinholdtsenTransform some mediawiki notation to moinmoin.12014-03-24 13:35:03PetterReinholdtsenConverted freedombox-setup/doc/README.fbx-home to wiki format using "pandoc doc/README.fbx-home -f rst -t mediawiki".
Welcome to your FreedomBox!
Getting Help This document is intended to give you all the information you need to get started with your FreedomBox. However, if you have any questions after reading this document, you can get help by: Emailing freedombox-discuss@lists.alioth.debian.org. You can also sign up to receive copies of every discussion that happens on the mailing list and read the archives. Chatting at #freedombox@irc.oftc.net. Reading the wiki. Reading the FreedomBox Foundation's website. Reading the FreedomBox Project Page.
Using your FreedomBox This section describes the basic information you need to know to successfully use your FreedomBox.
Quick Start Plug one end of your ethernet cord into your FreedomBox's eth0 port (the one toward the middle of the box), and plug the other end into your router. Plug your computer into the eth1 port (the one toward the end of the box) on the FreedomBox. Plug your FreedomBox into a power outlet. Wait a few minutes while it starts itself for the first time. Start enjoying the Internet. Navigate to your FreedomBox by browsing to: Bask in your own awesomeness :) Now, you can try: Browsing the Internet Hosting a Wiki Publishing with your FreedomBox Other tools are also planned, such as an IM (chat) server, a blog, and more.
Browsing the Internet To browse the Internet through your FreedomBox: Plug one end of your ethernet cord into your FreedomBox's eth0 port (the one toward the middle of the box), and plug the other end into your router. Plug your computer into the eth1 port (the one toward the end of the box) on the FreedomBox. Start enjoying the Internet.
Hosting a Wiki Connect to your FreedomBox, as root, because we're going to modify the system by installing some new packages. Install the ikiwiki package: Say "yes" when it asks you about installing new packages. Follow the ikiwiki setup instructions, or use the additional projects to automatically configure ikiwiki.
Publishing with your FreedomBox Now that you've put a wiki together, you might as well publish it to the Internet. To publish material to the Internet, you need two things: A place to host it. A name, so you can be found. You already have the place to host data, it's this FreedomBox. Now, you just need a name. While it's possible to buy your own domain name, it's a rather tedious and complicated process. Many folks have had good luck with "reverse proxies," things like PageKite. Other reverse proxy services are also available.
Publishing with PageKite Getting started with PageKite is pretty straightforward. After you've connected to your FreedomBox you can configure it using the Plinth web interface in the Router->General Setup->Public Visibility (PageKite) menu. Enable PageKite, fill in your site name and kite secret, check the http service and now, you can access from anywhere!
Common Tasks Some tasks require a bit of command line magic. We've reproduced that magic here, so it's easy to refer to, when you need it.
Logging in to your FreedomBox When your FreedomBox first starts, it has two accounts: a root account for system maintenance, and a normal user who doesn't have the power to mess with how the system works. The default passwords for each of those users are: root freedom fbx frdm You'll need this information if you want to log in, as explained in the next section. Also, after you log in, you should probably change the default passwords. Otherwise, anybody else who reads this document could log into your box, too.
Connecting to your FreedomBox These instructions will teach you how to log in, via ssh, to your FreedomBox. Run an ethernet cord from your computer to your FreedomBox's eth0 port (the one toward the middle). Wait a bit, or until your computer says that it's successfully connected. Run the following command to log in as the administrative, everyday, user: To log in as the root user instead, in case you want to perform some serious system maintenance: Make a habit of logging in as root only when you need to. If you aren't logged in as root, you can't accidentally break everything. Even if everything does break though, don't worry, it can still be fixed, it'll just take a couple hours. See the Getting Help section for more details.
Changing your Password To change your password, log in to your FreedomBox as the user whose password you want to change. Then, run the following command: That'll ask you for your current password before giving you the opportunity to put in a new one.
Updating your FreedomBox These instructions will teach you how to keep your FreedomBox up to date with the latest software releases. Ask the box to update itself: Chances are good the "upgrade" command will ask you if it's alright to install some packages and use some disk space. Say "yes", because that's what you want it to do. If those commands complete successfully, then congratulations, you've just updated your FreedomBox! If they don't complete successfully ask for help, as described in the Getting Help section.
Diagram Ever wonder what all those holes and fiddly bits were called? 1. Power Cord 2. AC Adapter 3. UART 4. Reset Hole 5. JTAG 6. Foot 7. USB 8. Optical Out 9. eth0 10. eth1 1. Power Cord 2. AC Adapter 6. Foot 7. USB 11. Microphone In 12. Headphone Out 13. eSATA 14. SD
Warnings If you need to open the box, open it from the side that's not the AC Adapter side. Be very careful here: the box's two halves are held together, on the adapter side, by a couple of fragile wires.
Hacking on your FreedomBox Your FreedomBox includes several projects you can check out: Freedom Maker Plinth Privoxy To start using these projects, navigate to the relevant folder in the /home/fbx directory and examine their README files.
Projects
Freedom Maker Freedom Maker is the tool used to create a running FreedomBox system. It creates the bootable system image that lives on the DreamPlug's microSD card.
Plinth Plinth is the FreedomBox's administration UI. It's not done yet, but it will be included in future FreedomBox updates when it's finished.
Privoxy Privoxy is the FreedomBox's privacy-preserving web-proxy.
Building your own FreedomBox
Updating DreamPlug's U-Boot You can also review these instructions online: These instructions are from Ian Campbell, using uboot version 2012.04.01-2, which is the current version in Debian's Wheezy release. Prepare your system: Move the USB drive to your DreamPlug, and connect to your system via JTAG. Connect the UART DreamPlug port to the JTAG Board's UART port or connect the JTAG DreamPlug port to the JTAG Board's JTAG port. Next, plug the USB cord into your main system and access the serial port with: Now, interrupt the boot process so you can flash it from within the bootloader, before the GNU/Linux system takes over: usb start > fatload usb 2 0x6400000 dreamplug/u-boot.kwb > sf probe 0 > sf erase 0x0 0x80000 > sf write 0x6400000 0x0 0x${filesize}]]> You must, of course, fill in the size of the file you're loading in hex. At this point, you should be able to reset the DreamPlug and have it boot to a serial console prompt. If that fails, you'll need real JTAG magic to try again. Note that freedom-maker now includes DreamPlug firmware in the FAT partition on USB stick targets. To use a freedom-maker USB stick to update your u-boot, ignore the instructions above about how to wget and extract the firmware, and just connect to the DreamPlug and follow the bootloader instructions.
Building your own File-system Image On another system, download the Freedom-Maker repoistory and follow the README to build your own image that you can plug into your DreamPlug:
Adding Additional Projects There are a number of incomplete projects that you might find useful, for setting up a wiki, an IM server, and so forth. To check these out, download the repository: Then, read the README. It's pretty detailed. A word of warning, though: the FreedomBox Foundation folks think that using PHP-based services, like the blog service included in that plugserver repository, is a generally poor idea. Just use the wiki instead. Also, if you can, it may be best to wait until these tools are fully integrated into the FreedomBox image. Otherwise, migrating from these custom tools to the officially supported FreedomBox tools may be difficult. Ultimately, that decision is up to you.
Updating the documentation This manual is maintained on a Wiki, allowing every registered user to update it. If you find something that could be written better, please update it on .
freedombox-setup/avahi-services/0002755000000000000000000000000012313041313014136 5ustar freedombox-setup/avahi-services/sftp-ssh.service0000644000000000000000000000052312313035741017275 0ustar %h _sftp-ssh._tcp 22 path=/home/fbx u=fbx freedombox-setup/avahi-services/domain.service0000644000000000000000000000040212313036704016771 0ustar %h _domain._udp 53 freedombox-setup/avahi-services/ssh.service0000644000000000000000000000037712313041313016322 0ustar %h _ssh._tcp 22 freedombox-setup/avahi-services/xmpp-server.service0000644000000000000000000000041112313036353020012 0ustar %h _xmpp-server._tcp 5269 freedombox-setup/sysctl.d/0002755000000000000000000000000012213402021012764 5ustar freedombox-setup/sysctl.d/freedombox-setup.conf0000644000000000000000000000052712213402021017125 0ustar # Reduce writes to flash drives vm.laptop_mode=5 vm.swappiness=0 vm.dirty_writeback_centisecs=1500 vm.dirty_expire_centisecs=1500 # Uncomment the next line to enable packet forwarding for IPv6 # Enabling this option disables Stateless Address Autoconfiguration # based on Router Advertisements for this host net.ipv6.conf.all.forwarding=1 freedombox-setup/LICENSE0000644000000000000000000010451312213402657012247 0ustar GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read .