The various configuration steps below are only necessary if installing from scratch via pip. The OpenGB apt package performs these steps automatically post-install.


OpenGB is tested with and designed to run on the Raspberry Pi Model 3B with a Raspberry Pi Touch Display, the Raspbian operating system and the Iceweasel web browser.

The instructions below are specific to this platform but in most cases should be transferrable to any host running a Linux-based operating system and Python 3.4+.


OpenGB Web Interface

To start Iceweasel running the OpenGB web interface fullscreen automatically on boot:

sudo apt-get install iceweasel xdotool

cat << EOF >> ~/.config/lxsession/LXDE-pi/autostart
@iceweasel http://opengb.local:8000
@sleep 10
@xdotool key --clearmodifiers F11

Multicast DNS

Multicast DNS (also known as “mDNS” or “ZeroConf”) allows a host to be accessed by name rather than IP addresss. Raspbian provides mDNS services via the avahi-daemon which is enabled by default.

Change hostname to OpenGB

To change the Raspbian hostname from the default raspberrypi to opengb:

sudo sed -i -e 's/raspberrypi/opengb/g' /etc/hosts
sudo sed -i -e 's/raspberrypi/opengb/g' /etc/hostname
sudo reboot

Upon reboot you should be able to navigate to opengb via http://opengb.local:8000.


Multiple OpenGB Instances

If you are running multiple instances of OpenGB on the same network simply choose a different hostname for each instance. E.g.:

OpenGB instance #1:

sudo sed -i -e 's/opengb/opengb1/g' /etc/hosts
sudo sed -i -e 's/opengb/opengb1/g' /etc/hostname
sudo reboot

OpenGB instance #2:

sudo sed -i -e 's/opengb/opengb2/g' /etc/hosts
sudo sed -i -e 's/opengb/opengb2/g' /etc/hostname
sudo reboot

OpenGB instance #3:

sudo sed -i -e 's/opengb/opengb3/g' /etc/hosts
sudo sed -i -e 's/opengb/opengb3/g' /etc/hostname
sudo reboot



To disable screen blanking:

cat << EOF >> ~/.config/lxsession/LXDE-pi/autostart
@xset s noblank
@xset s off
@xset -dpms


To disable the mouse pointer:

sudo apt-get install unclutter
echo "unclutter -idle 5" >> ~/.config/lxsession/LXDE-pi/autostart