{"id":15031805,"url":"https://github.com/guysoft/fullpageos","last_synced_at":"2025-05-14T15:10:23.763Z","repository":{"id":37458142,"uuid":"44012035","full_name":"guysoft/FullPageOS","owner":"guysoft","description":"A raspberrypi distro to display a full page browser on boot","archived":false,"fork":false,"pushed_at":"2025-03-18T22:33:50.000Z","size":5907,"stargazers_count":4036,"open_issues_count":169,"forks_count":255,"subscribers_count":85,"default_branch":"devel","last_synced_at":"2025-04-11T05:13:20.287Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guysoft.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-10T13:38:29.000Z","updated_at":"2025-04-10T19:23:22.000Z","dependencies_parsed_at":"2024-01-04T21:26:48.171Z","dependency_job_id":"123ebdd4-42c1-4f99-93d0-7dc3b2cc5dee","html_url":"https://github.com/guysoft/FullPageOS","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FFullPageOS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FFullPageOS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FFullPageOS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FFullPageOS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guysoft","download_url":"https://codeload.github.com/guysoft/FullPageOS/tar.gz/refs/heads/devel","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248345267,"owners_count":21088244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T20:16:39.180Z","updated_at":"2025-04-11T05:13:24.318Z","avatar_url":"https://github.com/guysoft.png","language":"Shell","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=26VJ9MSBH3V3W\u0026source=url"],"categories":[],"sub_categories":[],"readme":"FullPageOS\n==========\n\n.. image:: https://github.com/guysoft/FullPageOS/blob/secularstevelogo/media/FullPageOS.png?raw=true\n.. :scale: 50 %\n.. :alt: FullPageOS logo\n\nA `Raspberry Pi \u003chttp://www.raspberrypi.org/\u003e`_ distribution to display one webpage in full screen. It includes `Chromium \u003chttps://www.chromium.org/\u003e`_ out of the box and the scripts necessary to load it at boot.\nThis repository contains the source script to generate the distribution out of an existing `Raspbian \u003chttp://www.raspbian.org/\u003e`_ distro image.\n\nFullPageOS started as a fork from `OctoPi \u003chttps://github.com/guysoft/OctoPi\u003e`_, but then joined the distros that use `CustomPiOS \u003chttps://github.com/guysoft/CustomPiOS\u003e`_.\n\nDonate\n------\nFullPageOS is 100% free and open source and maintained by Guy Sheffer. If it's 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.\n\n|paypal|\n\n.. |paypal| image:: https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif\n   :target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=26VJ9MSBH3V3W\u0026source=url\n\nWhere to get it?\n----------------\n\nThe official mirror is `here \u003chttp://unofficialpi.org/Distros/FullPageOS/\u003e`_\n\nNightly builds are available `here \u003chttp://unofficialpi.org/Distros/FullPageOS/nightly/\u003e`_ (currently built on demand)\n\nHow to use it?\n--------------\n\n#. Unzip the image and install it to an SD card `like any other Raspberry Pi image \u003chttps://www.raspberrypi.org/documentation/installation/installing-images/README.md\u003e`_\n#. Configure your WiFi by editing ``wifi.nmconnection`` on the first partition of the flashed card when using it like a flash drive\n#. Boot the Pi from the SD card\n#. Log into your Pi via SSH (it is located at ``fullpageos.local`` `if your computer supports bonjour \u003chttps://learn.adafruit.com/bonjour-zeroconf-networking-for-windows-and-linux/overview\u003e`_ or the IP address assigned by your router), default username is \"pi\", default password is \"raspberry\" and change the password using the ``passwd`` command. Consider also changing the vnc password as well by `x11vnc -storepasswd`.\n\nRequirements\n------------\n* Raspberry Pi 2 and newer or device running Armbian. Older Raspberry Pis are not currently supported.  See `Raspberry Pi \u003chttps://github.com/guysoft/FullPageOS/issues/12\u003e`_ and `Raspberry Pi \u003chttps://github.com/guysoft/FullPageOS/issues/43\u003e`_.\n* SD card, 4GB or larger, Class 10. (Early June 2020 was the image size 3GB.)\n* 2A power supply\n\n\nFeatures\n--------\n\n* Loads Chromium at boot in full screen\n* Webpage can be changed from /boot/firmware/fullpageos.txt\n    * You can use variable `{serial}` in the url to get device's serialnumber in the URL\n* Default app is `FullPageDashboard \u003chttps://github.com/amitdar/FullPageDashboard\u003e`_, which lets you add multiple tabs changes that switch automatically.\n* Ships with preconfigured `X11VNC \u003chttp://www.karlrunge.com/x11vnc/\u003e`_, for remote connection (password 'raspberry')\n* Specify a custom Splashscreen that gets displayed in the booting process instead of Kernel messages/text\n\nDeveloping\n----------\n\nRequirements\n~~~~~~~~~~~~\n\n#. `qemu-arm-static \u003chttp://packages.debian.org/sid/qemu-user-static\u003e`_\n#. `CustomPiOS \u003chttps://github.com/guysoft/CustomPiOS\u003e`_\n#. Downloaded `Raspbian \u003chttp://www.raspbian.org/\u003e`_ image.\n#. root privileges for chroot\n#. Bash\n#. realpath\n#. sudo (the script itself calls it, running as root without sudo won't work)\n#. jq (part of CustomPiOS dependencies)\n\nBuild FullPageOS From within FullPageOS / Raspbian / Debian / Ubuntu\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nFullPageOS can be built from Debian, Ubuntu, Raspbian, or even FullPageOS.\nBuild requires about 2.5 GB of free space available.\nYou can build it by issuing the following commands::\n\n    sudo apt install coreutils p7zip-full qemu-user-static\n    \n    git clone https://github.com/guysoft/CustomPiOS.git\n    git clone https://github.com/guysoft/FullPageOS.git\n    cd FullPageOS/src/image\n    wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspios_lite_armhf_latest'\n    cd ..\n    ../../CustomPiOS/src/update-custompios-paths\n    sudo modprobe loop\n    sudo bash -x ./build_dist\n    \nBuilding FullPageOS Variants\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nFullPageOS 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``.\n\nTo build a variant use::\n\n    sudo bash -x ./build_dist [Variant]\n    \n    \nBuilding Using Docker\n~~~~~~~~~~~~~~~~~~~~~~\n`See Building with docker entry in wiki \u003chttps://github.com/guysoft/CustomPiOS/wiki/Building-with-Docker\u003e`_\n\n    \nBuilding Using Vagrant\n~~~~~~~~~~~~~~~~~~~~~~\nThere 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.\n\nMake sure you have a version of vagrant later than 1.9!\n\nIf you are using older versions of Ubuntu/Debian and not using apt-get `from the download page \u003chttps://www.vagrantup.com/downloads.html\u003e`_.\n\nTo use it::\n\n    sudo apt-get install vagrant nfs-kernel-server virtualbox\n    sudo vagrant plugin install vagrant-nfs_guest\n    sudo modprobe nfs\n    cd FullPageOS/src/vagrant\n    sudo vagrant up\n\nAfter provisioning the machine, it's also possible to run a nightly build which updates from devel using::\n\n    cd FullPageOS/src/vagrant\n    run_vagrant_build.sh\n    \nTo build a variant on the machine simply run::\n\n    cd FullPageOS/src/vagrant\n    run_vagrant_build.sh [Variant]\n\nUsage\n~~~~~\n\n#. 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.\n#. Run ``src/build_dist`` as root.\n#. The final image will be created in ``src/workspace``\n\n\nRemote access\n~~~~~~~~~~~~~\n\nRemote GUI access can be achieved through VNC Viewer. Get the IP of your raspberry ``hostname -I`` via SSH. \n\nThe password is ``raspberry`` and is independent of password you have set for your user(s). Change the password by ``x11vnc -storepasswd`` via SSH.\n\n\nInstall Chrome Extensions\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nPress ``ctrl`` + ``t``, it will open a new tab. \n\nYou can either install extensions from `Chrome Web Store \u003chttps://chrome.google.com/webstore/category/extensions\u003e`_ or `install your own extension  \u003chttps://support.google.com/chrome_webstore/answer/2664769?hl=en\u003e`_. \n\nIf you wish to install your own extension then you can transfer the build files via tools like ``rcp``, ``rsync`` etc.\n\nExample::\n\n    rsync -av \u003cextension-build-folder\u003e/ pi@fullpageos.local:extensions/\u003cextension-name\u003e/\n\n\nCode contribution would be appreciated!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguysoft%2Ffullpageos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguysoft%2Ffullpageos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguysoft%2Ffullpageos/lists"}