README

ipcsystools
===========

Collection of scripts and utilities for MCB2 or mIPC platform
firmware.

Control files
=============

/etc/ipcsystools.disable :
    Create file to disable execution of ipc-monitor script 
    (debugging aid, not for regular use)

/var/run/ipcsystools/ipcsystools.enabled :
    Created by ipc-startup and removed by ipc-shutdown. Controls the 
    execution of ipc-monitor. Ensures that modem and other interface
    hardware is setup and ready

Settings File
=============

------ General --------------------------------------------------------

general.log_level=<0|1|2> :
    0=off  1=syslog without debug msgs, 2=syslog with debug msgs

general.start_wan_enabled=<0|1> :
    Start and monitor configured connections

general.reboot.fake=<0|1> :
    Disable reboot function for debugging purposes.


------ WAN Monitoring -------------------------------------------------

general.wan.fallbackmode=<0|1>
    Check primary connection and switch back, when available.

general.wan.interfaces=eth ppp dip
    List of connections to monitor. First given interface is primary
    interface for fallback mode

general.wan.checktargets=88.198.6.166 64.16.193.46
    Ping targets to check connection. The ping address should be located
    on the connections provider side. This ping only check connectivity
    to your provider!

general.wan.checkgateways=172.25.0.1 10.64.64.64
    This is a list of gateway addresses to use as host routes to the
    connections ping address


------ Connection Script Specifics and Arguments ----------------------

connection.eth.dev=eth1
    Name of interface to use for connection-eth.sh

connection.eth.keepup=1
    Do not 'ifdown' the given interface. Useful with DHCP setup and
    a local router (DSL, Cablemodem, ...)

connection.ppp.dev=ppp0
    Name of interface to use for connection-ppp.sh

connection.dip.dev=wwan0
    Name of interface to use for connection-dip.sh


------ WATCHDOG-CONNECTION --------------------------------------------

watchdog.wan.connection.check_enabled=<0|1> :
    The check_enable variable can be used to enable/disable this test

watchdog.wan.connection.max_restarts=<n> :
watchdog.wan.connection.max_fail_time=<secs> :
    Monitors WAN connection status and reboots system after <n> restarts
    of connection or maximum <secs> with out valid connection status.

    These provide an timeout for all connections in general.wan.interfaces
    after which the system is rebooted.

------ WATCHDOG-PING --------------------------------------------------

watchdog.ping.check_ping_enabled=<0|1> :
    Enable ping to target near target network of the router. It checks
    that the routing over the default route is up and running. It doesn't
    check the connection to your local provider.

watchdog.ping.check_ping_ip=<ip> :
watchdog.ping.check_ping_reboot=<n> :
watchdog.ping.check_ping_time=<secs> :
    Target address, the number of allowed fails and a maximum time allowed
    without connection to target network.

------ MONITOR-VPN ----------------------------------------------------

ovpn.start_enabled=<0|1> :
ovpn.monitorpeers=ifconfig :
    Enable startup of OpenVPN connection and defines test method for
    connection.

ipsec.start_enabled=<0|1> :
ipsec.monitorpeers= :
    Enable startup of IPSec connection and defines test method for
    connection.

------ MODEM ----------------------------------------------------------
modem.newselratmodes=0|1
    Enable LTE RAT modes for LTE modems (not yet autodetected)

modem.connectionmode=<00|01|02|03|04>
    Set the radio technologies for UMTS/LTE

------ SIM CARD -------------------------------------------------------

sim.auth=<0|1> :
	Enable SIM pin/user authentication.
sim.apn=<string> :
	AccessPointName, e.g. web.vodafone.de
sim.username=<string> :
sim.passwd=<string> :
	Optional username and password for APN access (Radius)
sim.pin=<decimalstring> :
	Optional SIM pin number or empty for PIN-free SIM cards


Useful build commands
=======================
git archive --format tar.gz master --prefix webmin-1.580.0/ -9  > ../webmin_1.580.0.orig.tar.gz

gbp buildpackage --git-verbose --git-ignore-new --git-no-pristine-tar -tc -us -uc
gbp buildpackage --git-verbose --git-tag --git-retag -tc
gbp buildpackage --git-verbose --git-tag --git-retag -tc --git-no-pristine-tar
gbp dch --git-author -a
gbp dch --git-author -a -R
gbp dch --git-author -av -S
gbp dch --git-author -i
gbp dch --git-author -N 1.580.0-1
gbp dch --git-author -R
gbp dch --git-author -S

git-import-orig --pristine-tar ../whatever.orig.tar.gz
git log
git log 0..master
git log > CHANGELOG
git log --cumulative
git log --dense
git log ..master
git log --tags  > CHANGELOG
git rebase --help
git rebase -i upstream master
git status
git tag -f upstream/1.580.0