csmith1865/obscreen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 16 Wiki Activity

doc

Browse Source
This commit is contained in:
jr-k 2024-07-18 21:06:12 +02:00
parent 6be09e35f8
commit a8df9a5f5a
2 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/setup-run-headless.md
View File

@ -31,6 +31,9 @@ docker run --restart=always --name obscreen --pull=always \
-v /dev/null:/app/var/run/play \ -v /dev/null:/app/var/run/play \
jierka/obscreen:latest jierka/obscreen:latest
``` ```
---
</details> </details>
<details closed> <details closed>
@ -46,6 +49,9 @@ curl https://raw.githubusercontent.com/jr-k/obscreen/master/docker-compose.headl
# Run # Run
docker compose up --detach --pull=always docker compose up --detach --pull=always
``` ```
---
</details> </details>
<details closed> <details closed>
@ -99,16 +105,16 @@ sudo journalctl -u obscreen-studio -f
## 🏁 Finally ## 🏁 Finally
- Run `sudo systemctl restart obscreen-studio` or `sudo reboot` - Run `sudo systemctl restart obscreen-studio` or `sudo reboot`
---
</details> </details>
---
## 👌 Usage ## 👌 Usage
- Page which plays slideshow is reachable at `http://localhost:5000` - Page which plays slideshow is reachable at `http://localhost:5000`
- Slideshow manager is reachable at `http://localhost:5000/manage` - Slideshow manager is reachable at `http://localhost:5000/manage`
---
## 📺 Run the player instance ## 📺 Run the player instance
<details closed> <details closed>
@ -124,6 +130,9 @@ sudo reboot
#### How to restart #### How to restart
1. Just use systemctl `sudo systemctl restart obscreen-player.service` 1. Just use systemctl `sudo systemctl restart obscreen-player.service`
---
</details> </details>
<details closed> <details closed>
@ -135,10 +144,12 @@ When you run the browser yourself, don't forget to use these flags for chromium
# replace http://localhost:5000 with your obscreen-studio instance url # 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 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
``` ```
</details>
--- ---
</details>
## 📎 Additional ## 📎 Additional
@ -159,4 +170,7 @@ source ./venv/bin/activate
pip install -r requirements.txt pip install -r requirements.txt
sudo systemctl restart obscreen-studio.service sudo systemctl restart obscreen-studio.service
``` ```
---
</details> </details>

5
docs/setup-run-on-rpi.md
View File

@ -177,6 +177,8 @@ https://www.raspberrypi.org/documentation/configuration/config-txt/video.md
However, I used this one: `(2,82) = 1920x1080 60Hz 1080p` However, I used this one: `(2,82) = 1920x1080 60Hz 1080p`
---
</details> </details>
<details closed> <details closed>
@ -196,4 +198,7 @@ source ./venv/bin/activate
pip install -r requirements.txt pip install -r requirements.txt
sudo systemctl restart obscreen-studio.service sudo systemctl restart obscreen-studio.service
``` ```
---
</details> </details>