doc

docs/setup-run-headless.md

@@ -16,7 +16,7 @@ chromium --disable-features=Translate --ignore-certificate-errors --disable-web-
 ---
 ## 📡 Run the manager
 
-### with docker (for test)
+### with docker run (for test)
 ```bash
 # (Optional) Install docker if needed
 curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout # then login again
@@ -37,7 +37,7 @@ docker run --rm --name obscreen --pull=always \
   jierka/obscreen:latest
 ```
 ---
-### or with docker-compose
+### or with docker compose
 ```bash
 # Prepare application data file tree
 cd ~ && mkdir -p obscreen/data/db obscreen/data/uploads && cd obscreen
@@ -46,7 +46,7 @@ cd ~ && mkdir -p obscreen/data/db obscreen/data/uploads && cd obscreen
 curl https://raw.githubusercontent.com/jr-k/obscreen/master/docker-compose.headless.yml > docker-compose.yml
 
 # Run
-docker compose up --detach --pull always
+docker compose up --detach --pull=always
 ```
 ---
 ### or system wide
@@ -97,3 +97,20 @@ sudo journalctl -u obscreen-studio -f
 ## 👌 Usage
 - Page which plays slideshow is reachable at `http://localhost:5000`
 - Slideshow manager is reachable at `http://localhost:5000/manage`
+
+## 📎 Additional
+
+
+### How to upgrade
+>#### with docker run
+- Just add `--pull=always` to your `docker run ...` command, you'll get latest version automatically.
+>#### or with docker compose
+- Just add `--pull=always` to your `docker compose up ...` command, , you'll get latest version automatically.
+>#### or system wide
+- Execute following script
+```bash
+cd ~/obscreen
+source ./venv/bin/activate
+pip install -r requirements.txt
+sudo systemctl restart obscreen-studio.service
+```

docs/setup-run-on-rpi.md

@@ -22,7 +22,7 @@ curl -fsSL https://raw.githubusercontent.com/jr-k/obscreen/master/system/install
 ---
 ## 📡 Run the manager
 
-### with docker (for test)
+### with docker run (for test)
 ```bash
 # (Optional) Install docker if needed
 curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout # then login again
@@ -46,7 +46,7 @@ docker run --rm --name obscreen --pull=always \
   jierka/obscreen:latest
 ```
 ---
-### or with docker-compose
+### or with docker compose
 ```bash
 # Prepare application data file tree
 cd ~ && mkdir -p obscreen/data/db obscreen/data/uploads obscreen/system && cd obscreen
@@ -58,7 +58,7 @@ mkdir -p var/run && touch var/run/play && chmod +x var/run/play
 curl https://raw.githubusercontent.com/jr-k/obscreen/master/docker-compose.yml > docker-compose.yml
 
 # Run
-docker compose up --detach --pull always
+docker compose up --detach --pull=always
 ```
 ---
 ### or system wide
@@ -128,4 +128,17 @@ https://www.raspberrypi.org/documentation/configuration/config-txt/video.md
 
 However, I used this one: `(2,82) = 1920x1080	60Hz	1080p`
 
+### How to upgrade
+>#### with docker run
+- Just add `--pull=always` to your `docker run ...` command, you'll get latest version automatically.
+>#### or with docker compose
+- Just add `--pull=always` to your `docker compose up ...` command, , you'll get latest version automatically.
+>#### or system wide
+- Execute following script
+```bash
+cd ~/obscreen
+source ./venv/bin/activate
+pip install -r requirements.txt
+sudo systemctl restart obscreen-studio.service
+```
 

src/service/OsInfos.py

@@ -108,4 +108,5 @@ def get_all():
         "Storage Free Space": get_free_space(),
         "Memory Usage": get_memory_usage(),
         "OS Version": get_os_version(),
+        "Install Directory": os.getcwd()
     }

system/upgrade-system-wide.sh

@@ -1,6 +0,0 @@
-#!/bin/bash
-
-cd ~/obscreen
-source ./venv/bin/activate
-pip install -r requirements.txt
-sudo systemctl restart obscreen-studio.service