<title>RpiKiosk</title>

Creating Easy Digital Sign With Raspberry Pi 3

How To

***NOTE*** This tutorial is for the GUI Version of RpiKiosk. I will write up a different tutorial for the CLI Version.
This program and this tutorial were designed for use with a raspberry pi 2 or 3 with armhf architecture.
This program was based on the 2017-11-29-raspbian-stretch version of raspbian.

1. The first thing you will need to do is install Raspian onto your raspberry pi. To Install Raspian Stretch to your pi please go to https://www.raspberrypi.org/downloads/raspbian/ and follow the instructions there.

2. Next, the gui version of this tool does have a dependency to work correctly. You will need to install the "dialog" package in order to use the GUI version of this tool. You can install "dialog" using the following command on your Pi in the terminal:

$ sudo apt-get install dialog

3. There are also a few packages that these scripts do not directly depend on but will help the user should the want to make further changes. The RpiKioskInstall script will look for these and install them if they are not found on your pi. However, if you wish to install them before running the script then run the following commands on your pi in the terminal:

$ sudo apt-get update
$ sudo apt-get install git vim clutter

The "git" package is for users that are familiar with using git and want to clone the RpiKiosk Repository rather than downloading the zip file.
The "vim" package is simply a terminal text editor. This package is not crucial but will be of benefit if you are an advanced linux or pi user.
The "clutter" package will hide your pi's mouse cursor when it is not being used. This is good for locations that your kiosk or digital sign will not be within reach of public. In the case that your kiosk or digital sign is within reach of public, the RpiKioskCursorDisable script will allow you to completely disable your mouse cursor on your pi. (This can be reverted using the RpiKioskCursorEnable script)

DEB PACKAGE USE ONLY

If you wish to download the deb package version download the file then run the following commands: rpikiosk_1.0-4.deb

$ cd /path/to/downloaded/rpikiosk_1.0-4.deb
$ sudo dpkg -i rpikiosk_1.0-4.deb

If the install fails and complains about a dependency the install the "dialog" package using:

$ sudo apt-get -f install
$ sudo dpkg -i rpikiosk_1.0-4.deb

Now you can simply run the following command in the terminal and follow on-screen prompts and options.

$ RpiKioskMain

From here you can select what you would like to do: Install, Uninstall, Enable Mouse, Disable Mouse.

RUN RPIKIOSK FROM CLONE OR ZIP DOWNLOAD

1. Clone the RpiKiosk Repository from https://github.com/jharttech/RpiKiosk.git:

$ git clone https://github.com/jharttech/RpiKiosk.git

1. Download the RpiKiosk zip file from https://github.com/jharttech/RpiKiosk/archive/master.zip to your pi, then extract the files:

$ cd /path/to/downloaded/RpiKiosk-master.zip
$ mkdir /home/pi/RpiKiosk
$ mv RpiKiosk-master.zip /home/pi/RpiKiosk
$ cd /home/pi/RpiKiosk

2. Go into the RpiKiosk folder and move files to the correct location.

$ cd /home/pi/RpiKiosk
$ sudo mv Rpi* /usr/local/bin/
$ sudo mv logo.txt /usr/local/bin/

3. Run the Install Script (If you did not download the deb package version)

$ cd /usr/local/bin
$ chmod +x RpiKioskMain
$ ./RpiKioskMain

From the Main menu you can select what you would like to do. You can choose between: Install, Uninstall, Enable Mouse, Disable Mouse.
Install: This will start the Installation script and will walk you through the setup of your kiosk or digital sign. Simply followw the script and answer with the desired inputs. Once the script has finished you should restart your pi for the changes to take effect.
(If you downloaded and installed the deb package version of the RpiKiosk please refer to the "DEB PACKAGE ONLY" section above.

NOTES

In the Main menu you can choose between: Install, Uninstall, Enable Mouse, Disable Mouse. Install: This will start the Installation script and will walk you through the setup of your kiosk or digital sign. Simply follow the script and answer with the desired inputs. Uninstall: This will start the Uninstall script and will revert all config files back to the pi defaults. Enable Mouse: This will start the Enable Mouse script. If you disabled the mouse during initial installation this will re-enable your mouse cursor without uninstalling the kiosk. Disable Mouse: This will start the Disable Mouse script. If you did not disable the mouse during initial installation this will allow you to do so should you feel the need.

I recommend you setting up a free Dakboard account at https://dakboard.com/site. This company will help you quickly set up a nice digital display for free. (The free version is limited on customizations)

Screen Orientation: This setting is dependant upon which way your digital sign (monitor or TV) is mounted. Your options are "Landscape" or Portrait".

Enter your URL: The Install script will ask you for a URL to your kiosk, video, or slideshow. If you are using DAKBoard, you will find this url under your account settings. If will be called your Private URL. If you are using google slides this will be your public published URL. This URL can be a URL to any type of legal media that you wish to display on your digital sign.

Disable Mouse Cursor: The Install script will ask if you would like to disable your mouse cursor. If you choose to do so, you can revert this at a later date by running the EnableCursor.sh script. If you choose not to disable the mouse cursor during install, you can disable it later by running the DisableCursor.sh script.

Memory Split: The Install script will ask if you would like to change the memory split of your pi. If you do not know what this means please indicate that you would not like to change this value by entering "NO" when prompted. You can change this later by running the "$ raspi-config" command.

How to get to the terminal once you have installed the kiosk: You may want to run other scripts or exit out of your newely created Kiosk. To do this on your pi, press the "windows" key on your keyboard. Next arrow down to "Accessories", arrow to the right one time, then arrow down to terminal and press the "enter" key. Once the terminal is up, type the following command to stop the Kiosk:

$ killall chromium-browsers

(This will stop the kiosk and allow you to run other scripts or use your pi how ever you desire).

UNINSTALL

To uninstall the kiosk simply return to the terminal and run RpiKioskMain, then select the "Uninstall" option. This script will revert all config files back to the original states and will enable the mouse if it has been disabled.

IN NO EVENT WILL WE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, SPECIAL OR EXEMPLARY DAMAGES FOR ANY USE OF THIS SITE, OR USE OF ANY OTHER LINKED SITE, OR SOFTWARE, EVEN IF WE ARE ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.