https://github.com/pforret/siteshow

Display URL carousel in Raspberry Pi browser
https://github.com/pforret/siteshow

bashew dashboard kiosk raspberry-pi rpi slideshow

Last synced: 7 months ago
JSON representation

Display URL carousel in Raspberry Pi browser

• Host: GitHub
• URL: https://github.com/pforret/siteshow
• Owner: pforret
• License: mit
• Created: 2021-05-16T18:19:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-18T20:00:11.000Z (over 4 years ago)
• Last Synced: 2025-01-13T22:21:44.400Z (9 months ago)
• Topics: bashew, dashboard, kiosk, raspberry-pi, rpi, slideshow
• Language: Shell
• Homepage:
• Size: 1.52 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![bash_unit CI](https://github.com/pforret/siteshow_pi/workflows/bash_unit%20CI/badge.svg)

![Shellcheck CI](https://github.com/pforret/siteshow_pi/workflows/Shellcheck%20CI/badge.svg)

![GH Language](https://img.shields.io/github/languages/top/pforret/siteshow_pi)

![GH stars](https://img.shields.io/github/stars/pforret/siteshow_pi)

![GH tag](https://img.shields.io/github/v/tag/pforret/siteshow_pi)

![GH License](https://img.shields.io/github/license/pforret/siteshow_pi)

[![basher install](https://img.shields.io/badge/basher-install-white?logo=gnu-bash&style=flat)](https://basher.gitparade.com/package/)

# siteshow

![siteshow](assets/siteshow_pi.jpg)

Show web pages in carousel on Raspberry Pi - to be used as e.g. a dashboard display

## 🔥 Usage

```

Program: siteshow 0.2.0 by peter@forret.com

Updated: May 18 00:00:45 2021

Description: This is my script siteshow_pi

Usage: siteshow [-h] [-q] [-v] [-f] [-l ] [-t ] [-B ] [-C ] [-D ] [-I ] [-W ] 

Flags, options and parameters:

    -h|--help        : [flag] show usage [default: off]

    -q|--quiet       : [flag] no output [default: off]

    -v|--verbose     : [flag] output more [default: off]

    -f|--force       : [flag] do not ask for confirmation (always yes) [default: off]

    -l|--log_dir > : [option] folder for log files   [default: /Users/pforret/log/siteshow]

    -t|--tmp_dir > : [option] folder for temp files  [default: /tmp/siteshow]

    -B|--browser > : [option] browser to use: chromium/firefox  [default: chromium]

    -C|--category >: [option] screen category

    -D|--display > : [option] display ID

    -I|--install > : [option] folder for installing scripts  [default: /home/pi]

    -W|--wait >    : [option] wait between pages  [default: 30]

             : [parameter] action to perform: install/display

### TIPS & EXAMPLES

* use 'siteshow_pi install' to install the RPi as a display server

  siteshow_pi install

* use 'siteshow_pi display' to .start display

  siteshow_pi display

* use 'siteshow_pi check' to check if this script is ready to execute and what values the options/flags are

  siteshow_pi check

* use 'siteshow_pi env' to generate an example .env file

  siteshow_pi env > .env

* use 'siteshow_pi update' to update to the latest version

  siteshow_pi check

```

## 🚀 Installation

```bash

$ git clone https://github.com/pforret/siteshow_pi.git

$ cd siteshow_pi

$ ./siteshow_pi install

# follow the instructions

# and now reboot

```

## 📝 Acknowledgements

* script created with [bashew](https://github.com/pforret/bashew)

© 2021 Peter Forret