From 241da7f67a71e42ed9cad71dda63a2ae00ca39d5 Mon Sep 17 00:00:00 2001 From: jr-k Date: Thu, 16 May 2024 02:22:01 +0200 Subject: [PATCH] doc --- docs/setup-run-headless.md | 8 ++++---- docs/setup-run-on-rpi.md | 14 ++++++++------ 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/setup-run-headless.md b/docs/setup-run-headless.md index 3526b07..3626fa0 100644 --- a/docs/setup-run-headless.md +++ b/docs/setup-run-headless.md @@ -4,7 +4,7 @@ #### 🔵 You want to start browser and setup playlist url manually on your device and just want a slideshow manager ? You're in the right place. - +--- ## 🐳 Run with docker ### With docker (for test) ```bash @@ -35,7 +35,7 @@ curl https://raw.githubusercontent.com/jr-k/obscreen/master/docker-compose.headl # Run docker compose up --detach --pull always ``` - +--- ## 📠 Run system wide ### Install ```bash @@ -75,9 +75,9 @@ sudo systemctl start obscreen-manager.service To troubleshoot you can check logs ```bash -sudo journalctl -u obscreen -f +sudo journalctl -u obscreen-manager -f ``` - +--- ## 👌 Usage - Page which plays slideshow is reachable at `http://localhost:5000` - Slideshow manager is reachable at `http://localhost:5000/manage` diff --git a/docs/setup-run-on-rpi.md b/docs/setup-run-on-rpi.md index e857f0f..1860998 100644 --- a/docs/setup-run-on-rpi.md +++ b/docs/setup-run-on-rpi.md @@ -56,14 +56,12 @@ docker compose up --detach --pull always ```bash # Install system dependencies sudo apt-get update -sudo apt-get install -y git xinit xserver-xorg chromium-browser unclutter python3-venv python3-pip +sudo apt-get install -y git # Get files git clone https://github.com/jr-k/obscreen.git && cd obscreen # Install application dependencies -python3 -m venv venv -source ./venv/bin/activate pip3 install -r requirements.txt # Add some sample data @@ -75,11 +73,11 @@ cp .env.dist .env ### Configure - Server configuration is editable in `.env` file. -- Application configuration will be available at `http://raspberrypi.local:5000/settings` page after run. +- Application configuration will be available at `http://localhost:5000/settings` page after run. ### Start server (for test) ```bash -python3 ./obscreen.py +./obscreen.py ``` ### Start server forever with systemctl @@ -92,8 +90,12 @@ sudo systemctl start obscreen-manager.service To troubleshoot you can check logs ```bash -sudo journalctl -u obscreen -f +sudo journalctl -u obscreen-manager -f ``` +--- +## 🏁 Finally +- Run `sudo systemctl restart obscreen-player` or `sudo reboot` + --- ## 👌 Usage - Page which plays slideshow is reachable at `http://raspberrypi.local:5000`