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:45:27 +02:00
parent b59adba472
commit cf540c08df
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,7 +8,8 @@
--- ---
## 📡 Run the studio instance ## 📡 Run the studio instance
### with docker run (for test) ### with docker run
> Not suitable for production use because it won't survive a reboot but it's ok for quick testing
```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
@ -67,7 +68,8 @@ cp .env.dist .env
- Server configuration is editable in `.env` file. - Server configuration is editable in `.env` file.
- 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 (for test) #### Start server
> Not suitable for production use because it won't survive a reboot but it's ok for quick testing
```bash ```bash
python ./obscreen.py python ./obscreen.py
``` ```

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

@ -22,7 +22,8 @@ curl -fsSL https://raw.githubusercontent.com/jr-k/obscreen/master/system/install
--- ---
## 📡 Run the studio instance ## 📡 Run the studio instance
### with docker run (for test) ### with docker run
> Not suitable for production use because it won't survive a reboot but it's ok for quick testing
```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
@ -84,7 +85,8 @@ cp .env.dist .env
- Server configuration is editable in `.env` file. - 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://raspberrypi.local:5000/settings` page after run.
#### Start server (for test) #### Start server
> Not suitable for production use because it won't survive a reboot but it's ok for quick testing
```bash ```bash
python ./obscreen.py python ./obscreen.py
``` ```