🔴 You want to power RaspberryPi and automatically see your slideshow on a screen connected to it and manage your slideshow ? You're in the right place.
- Download RaspberryPi Imager and setup an sdcard with
Raspberry Pi OS Lite
(🚨without desktop, onlyLite
version!). You'll find it under categoryRaspberry PI OS (other)
- Log into your RaspberryPi locally or via ssh (by default it's
ssh [email protected]
)
- Install studio by executing following script
curl -fsSL https://raw.githubusercontent.com/jr-k/obscreen/master/system/install-studio.sh -o /tmp/install-studio.sh && chmod +x /tmp/install-studio.sh && sudo /bin/bash /tmp/install-studio.sh $USER $HOME
sudo reboot
- Server configuration is editable in
.env
file. - Application configuration will be available at
http://raspberrypi.local:5000/settings
page after run. - Check logs with
journalctl -u obscreen-studio -f
# (Optional) Install docker if needed
curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout
# ....then login again
# Prepare application data file tree
cd ~ && mkdir -p obscreen/data/db obscreen/data/uploads && cd obscreen
# Run the Docker container
docker run --restart=always --name obscreen --pull=always \
-e DEBUG=false \
-e PORT=5000 \
-e SECRET_KEY=ANY_SECRET_KEY_HERE \
-p 5000:5000 \
-v ./data/db:/app/data/db \
-v ./data/uploads:/app/data/uploads \
jierka/obscreen:latest
# Prepare application data file tree
cd ~ && mkdir -p obscreen/data/db obscreen/data/uploads && cd obscreen
# Download docker-compose.yml
curl https://raw.githubusercontent.com/jr-k/obscreen/master/docker-compose.yml > docker-compose.yml
# Run
docker compose up --detach --pull=always
- Page which plays slideshow is reachable at
http://raspberrypi.local:5000
- Slideshow manager is reachable at
http://raspberrypi.local:5000/manage
- Install player autorun by executing following script (will install chromium, x11, pulseaudio and obscreen-player systemd service)
curl -fsSL https://raw.githubusercontent.com/jr-k/obscreen/master/system/install-player-rpi.sh -o /tmp/install-player-rpi.sh && chmod +x /tmp/install-player-rpi.sh && sudo /bin/bash /tmp/install-player-rpi.sh $USER $HOME
sudo reboot
- Just use systemctl
sudo systemctl restart obscreen-player.service
- First you have to reboot your device with
sudo reboot
- You have to set audio channel to HDMI
sudo raspi-config nonint do_audio 1
(0 is for jack 3.5 output)
When you run the browser yourself, don't forget to use these flags for chromium browser:
# chromium or chromium-browser or even chrome
# replace http://localhost:5000 with your obscreen-studio instance url
chromium --disable-features=Translate --ignore-certificate-errors --disable-web-security --disable-restore-session-state --autoplay-policy=no-user-gesture-required --start-maximized --allow-running-insecure-content --remember-cert-error-decisions --noerrdialogs --kiosk --incognito --window-position=0,0 --window-size=1920,1080 --display=:0 http://localhost:5000
-
Basic Setup For basic RaspberryPi setup you can use most of the available guides, for example this one: https://gist.github.com/blackjid/dfde6bedef148253f987
-
HDMI Mode You may need to set the HDMI Mode on the raspi to ensure the hdmi resolution matches your screen exactly. Here is the official documentation: https://www.raspberrypi.org/documentation/configuration/config-txt/video.md
However, I used this one: (2,82) = 1920x1080 60Hz 1080p
- Just add
--pull=always
to yourdocker run ...
command, you'll get the latest version automatically.
- Just add
--pull=always
to yourdocker compose up ...
command, you'll get the latest version automatically.
- Using Git Updater plugin
- Or by executing following script
cd ~/obscreen
git pull
source ./venv/bin/activate
pip install -r requirements.txt
sudo systemctl restart obscreen-studio.service