Skip to content

Latest commit

 

History

History
157 lines (104 loc) · 6.75 KB

README.rst

File metadata and controls

157 lines (104 loc) · 6.75 KB
Raw

FullPageOS

https://raw.githubusercontent.com/guysoft/FullPageOS/devel/media/FullPageOS.png

A Raspberry Pi distribution to display one webpage in full screen. It includes Chromium out of the box and the scripts necessary to load it at boot. This repository contains the source script to generate the distribution out of an existing Raspbian distro image.

FullPageOS started as a fork from OctoPi, but then joined the distros that use CustomPiOS.

Donate

FullPageOS is 100% free and open source and maintained by Guy Sheffer. If its helping your life, your organisation or makes you happy, please consider making a donation. It means I can code more and worry less about my balance. Any amount counts.

paypal

Where to get it?

Official mirror is here

Nightly builds are available here (currently built on demand)

How to use it?

  1. Unzip the image and install it to an SD card like any other Raspberry Pi image
  2. Configure your WiFi by editing fullpageos-wpa-supplicant.txt on the first partition of the flashed card when using it like a flash drive
  3. Boot the Pi from the SD card
  4. Log into your Pi via SSH (it is located at fullpageos.local if your computer supports bonjour or the IP address assigned by your router), default username is "pi", default password is "raspberry" and change the password using the passwd command.

Requirements

  • Raspberry Pi 2 and newer or device running Armbian. Older Raspberry Pis are not currently supported. See Raspberry Pi and Raspberry Pi.
  • SD card, 4GB or larger, Class 10. (Early June 2020 was the image size 3GB.)
  • 2A power supply

Features

  • Loads Chromium at boot in full screen
  • Webpage can be changed from /boot/fullpageos.txt
    • You can use variable {serial} in the url to get device's serialnumber in the URL
  • Default app is FullPageDashboard, which lets you add multiple tabs changes that switch automatically.
  • Ships with preconfigured X11VNC, for remote connection (password 'raspberry')
  • Specify a custom Splashscreen that gets displayed on booting process instead of Kernel messages/text

Developing

Requirements

  1. qemu-arm-static
  2. CustomPiOS
  3. Downloaded Raspbian image.
  4. root privileges for chroot
  5. Bash
  6. realpath
  7. sudo (the script itself calls it, running as root without sudo won't work)

Build FullPageOS From within FullPageOS / Raspbian / Debian / Ubuntu

FullPageOS can be built from Debian, Ubuntu, Raspbian, or even FullPageOS. Build requires about 2.5 GB of free space available. You can build it by issuing the following commands:

sudo apt install coreutils p7zip-full qemu-user-static

git clone https://github.com/guysoft/CustomPiOS.git
git clone https://github.com/guysoft/FullPageOS.git
cd FullPageOS/src/image
wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspios_lite_armhf_latest'
cd ..
../../CustomPiOS/src/update-custompios-paths
sudo modprobe loop
sudo bash -x ./build_dist

Building FullPageOS Variants

FullPageOS supports building variants, which are builds with changes from the main release build. An example and other variants are available in the folder src/variants/example.

To build a variant use:

sudo bash -x ./build_dist [Variant]

Building Using Docker

See Building with docker entry in wiki

Building Using Vagrant

There is a vagrant machine configuration to let build FullPageOS in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.

Make sure you have a version of vagrant later than 1.9!

If you are using older versions of Ubuntu/Debian and not using apt-get from the download page.

To use it:

sudo apt-get install vagrant nfs-kernel-server virtualbox
sudo vagrant plugin install vagrant-nfs_guest
sudo modprobe nfs
cd FullPageOS/src/vagrant
sudo vagrant up

After provisioning the machine, its also possible to run a nightly build which updates from devel using:

cd FullPageOS/src/vagrant
run_vagrant_build.sh

To build a variant on the machine simply run:

cd FullPageOS/src/vagrant
run_vagrant_build.sh [Variant]

Usage

  1. If needed, override existing config settings by creating a new file src/config.local. You can override all settings found in src/config. If you need to override the path to the Raspbian image to use for building OctoPi, override the path to be used in ZIP_IMG. By default, the most recent file matching *-raspbian.zip found in src/image will be used.
  2. Run src/build_dist as root.
  3. The final image will be created in src/workspace

Remote access

Remote GUI access can be archieved through VNC Viewer. Get the IP of you raspberry hostname -I via SSH.

The password is raspberry and is independent of password you have set for your user(s). Change the password by x11vnc -storepasswd via SSH.

Install Chrome Extensions

Press ctrl + t, it will open an new tab.

You can either install extensions frome Chrome Web Store or install your own extension.

If you which to install your own extension then you can transfer the build files via tools like rcp, rsync etc.

Example:

rsync -av <extension-build-folder>/ [email protected]:extensions/<extension-name>/

Code contribution would be appreciated!