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

doc rename

Browse Source
This commit is contained in:
jr-k 2024-06-28 18:51:57 +02:00
parent 9f896d7d3b
commit 94d587e768
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -9,7 +9,7 @@
## 📡 Run the studio instance ## 📡 Run the studio instance
### with docker run ### with docker run
> ⚠️ Not suitable for production use because it won't survive a reboot; but it's ok for quick testing > ⚠️ `docker ... --rm` option is not suitable for production use because it won't survive a reboot. However, it's okay for quick testing. You need to use --restart=always instead to ensure that it persists.
```bash ```bash
# (Optional) Install docker if needed # (Optional) Install docker if needed
curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout # then login again curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout # then login again
@ -18,7 +18,7 @@ curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout # t
cd ~ && mkdir -p obscreen/data/db obscreen/data/uploads && cd obscreen cd ~ && mkdir -p obscreen/data/db obscreen/data/uploads && cd obscreen
# Run the Docker container # Run the Docker container
docker run --rm --name obscreen --pull=always \ docker run --restart=always --name obscreen --pull=always \
-e DEBUG=false \ -e DEBUG=false \
-e PORT=5000 \ -e PORT=5000 \
-e PLAYER_AUTOSTART_FILE=/app/var/run/play \ -e PLAYER_AUTOSTART_FILE=/app/var/run/play \
@ -69,12 +69,12 @@ cp .env.dist .env
- Application configuration will be available at `http://localhost:5000/settings` page after run. - Application configuration will be available at `http://localhost:5000/settings` page after run.
#### Start server #### Start server
> ⚠️ Not suitable for production use because it won't survive a reboot; but it's ok for quick testing > ⚠️ Not suitable for production use because it won't survive a reboot. However, it's okay for quick testing. You need to use `systemd` (detailed in next section) to ensure that it persists.
```bash ```bash
python ./obscreen.py python ./obscreen.py
``` ```
#### Start server forever with systemctl #### Start server forever with systemd
```bash ```bash
cat "$(pwd)/system/obscreen-studio.service" | sed "s#/home/pi#$HOME#g" | sed "s#=pi#=$USER#g" | sudo tee /etc/systemd/system/obscreen-studio.service cat "$(pwd)/system/obscreen-studio.service" | sed "s#/home/pi#$HOME#g" | sed "s#=pi#=$USER#g" | sudo tee /etc/systemd/system/obscreen-studio.service
sudo systemctl daemon-reload sudo systemctl daemon-reload

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

@ -23,7 +23,7 @@ curl -fsSL https://raw.githubusercontent.com/jr-k/obscreen/master/system/install
## 📡 Run the studio instance ## 📡 Run the studio instance
### with docker run ### with docker run
> ⚠️ Not suitable for production use because it won't survive a reboot; but it's ok for quick testing > ⚠️ `docker ... --rm` option is not suitable for production use because it won't survive a reboot. However, it's okay for quick testing. You need to use --restart=always instead to ensure that it persists.
```bash ```bash
# (Optional) Install docker if needed # (Optional) Install docker if needed
curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout # then login again curl -sSL get.docker.com | sh && sudo usermod -aG docker $(whoami) && logout # then login again
@ -86,7 +86,7 @@ cp .env.dist .env
- Application configuration will be available at `http://raspberrypi.local:5000/settings` page after run. - Application configuration will be available at `http://raspberrypi.local:5000/settings` page after run.
#### Start server #### Start server
> ⚠️ Not suitable for production use because it won't survive a reboot; but it's ok for quick testing > ⚠️ Not suitable for production use because it won't survive a reboot. However, it's okay for quick testing. You need to use `systemd` (detailed in next section) to ensure that it persists.
```bash ```bash
python ./obscreen.py python ./obscreen.py
``` ```