From 4e45475ea98cff96d47fafb707c1049ec3f67a93 Mon Sep 17 00:00:00 2001 From: jr-k Date: Mon, 22 Jul 2024 03:59:35 +0200 Subject: [PATCH] doc --- docs/setup-run-on-rpi.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/setup-run-on-rpi.md b/docs/setup-run-on-rpi.md index 777f9cb..3f65665 100644 --- a/docs/setup-run-on-rpi.md +++ b/docs/setup-run-on-rpi.md @@ -14,6 +14,26 @@ ## 📡 Run the studio instance +
+

System-wide (recommended)

+ +#### Install +- Install studio by executing following script + +```bash +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 +``` + +#### Configure +- 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` + +--- + +
+

Using docker run

@@ -62,25 +82,6 @@ docker compose up --detach --pull=always
-
-

System-wide (recommended)

- -#### Install -- Install studio by executing following script - -```bash -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 -``` - -#### Configure -- 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` - ---- - -
## 👌 Usage - Page which plays slideshow is reachable at `http://raspberrypi.local:5000`