Skip to content

Commit 41bfd4a

Browse files
authored
install instructions improvement
1 parent 2f6edf1 commit 41bfd4a

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

INSTALL.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Dependencies
44

55
- A web server with a web environment available (e.g., Apache, Nginx)
6-
- PHP 8.2 or higher
6+
- A [supported PHP version](https://www.php.net/supported-versions.php) (not end of life)
77
- MySQL or MariaDB database server
88
- Composer (PHP dependency manager)
99
- Node.js and npm (Node Package Manager)
@@ -34,7 +34,7 @@ Install the following Ubuntu / Debian packages, or the equivalent for your opera
3434

3535
1. Copy the OpenBroadcaster Server files to your web server's document root directory.
3636

37-
2. Navigate to the cloned repository directory within the web document root and run the following command to install PHP and JavaScript dependencies.
37+
2. Navigate to the web document root and run the following command to install PHP and JavaScript dependencies.
3838

3939
```
4040
composer install && npm install
@@ -62,8 +62,31 @@ tools/cli/ob updates run all
6262
tools/cli/ob passwd admin
6363
```
6464

65-
9. Set up a cron job to run the `cron.php` script regularly. This script is responsible for clearing old cache and unused upload files. The following is an example crontab entry.
65+
9. Set up a service (or similar) to run required background tasks such as generating thumbnails and cache management. This service should ensure that `tools/bli/cli cron monitor` is running continously.
66+
67+
For example, set up a service, `/etc/systemd/system/ob.service`, as follows:
68+
69+
```
70+
[Unit]
71+
Description=OB Background Tasks
72+
After=network.target
73+
74+
[Service]
75+
Type=simple
76+
User=obuser
77+
ExecStart=/path/to/ob/tools/cli/ob cron monitor
78+
Restart=always
79+
RestartSec=10
80+
81+
[Install]
82+
WantedBy=multi-user.target
83+
```
84+
85+
Then run:
6686

6787
```
68-
* * * * * /path/to/openbroadcaster/tools/cli/ob cron run
88+
systemctl daemon-reload
89+
systemctl enable ob
90+
systemctl start ob
6991
```
92+

0 commit comments

Comments
 (0)