Skip to content

Commit 57bbe45

Browse files
authored
Update INSTALL.md
1 parent 8c5184b commit 57bbe45

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

INSTALL.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@
1010

1111
## Required PHP Modules
1212

13-
Make sure the following PHP modules are installed and enabled:
13+
Make sure the following PHP modules are installed and enabled (listed as Ubuntu/Debian packages):
1414

15-
- mysql (for MySQL database connectivity)
16-
- mbstring (for multi-byte string handling)
17-
- xml (for XML parsing)
18-
- gd (for image manipulation)
19-
- curl (for making HTTP requests)
20-
- imagick (for advanced image processing)
15+
- php-mysql (for MySQL database connectivity)
16+
- php-mbstring (for multi-byte string handling)
17+
- php-xml (for XML parsing)
18+
- php-gd (for image manipulation)
19+
- php-curl (for making HTTP requests)
20+
- php-imagick (for advanced image processing)
2121

2222
## Required Packages
2323

24-
Install the following Ubuntu / Debian packages, or the equivalent for your operating system.
24+
Install the following Ubuntu/Debian packages, or the equivalent for your operating system.
2525

2626
- festival (for text-to-speech functionality)
2727
- imagemagick (for image manipulation)
@@ -40,11 +40,11 @@ Install the following Ubuntu / Debian packages, or the equivalent for your opera
4040
composer install && npm install
4141
```
4242

43-
5. Create a new MySQL or MariaDB database for OpenBroadcaster and import the `db/clean.sql` file to set up the initial database structure.
43+
3. Create a new MySQL or MariaDB database for OpenBroadcaster and import the `db/clean.sql` file to set up the initial database structure.
4444

45-
6. Copy the `config.sample.php` file to `config.php` and open it in a text editor. Set the required configuration items, such as database connection details and other settings specific to your environment.
45+
4. Copy the `config.sample.php` file to `config.php` and open it in a text editor. Set the required configuration items, such as database connection details and other settings specific to your environment.
4646

47-
7. Run the following command to validate your configuration file. Correct any errors displayed in red.
47+
5. Run the following command to validate your configuration file. Correct any errors displayed in red.
4848

4949
```
5050
tools/cli/ob check
@@ -56,17 +56,17 @@ tools/cli/ob check
5656
tools/cli/ob updates run all
5757
```
5858

59-
8. Set the password for the default admin user by running the following command. Enter a secure password when prompted.
59+
7. Set the password for the default admin user by running the following command. Enter a secure password when prompted.
6060

6161
```
6262
tools/cli/ob passwd admin
6363
```
6464

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.
65+
8. Set up a service (or similar) to run required background tasks such as generating thumbnails and cache management. This service should ensure that `tools/cli/ob cron monitor` is running continuously.
6666

67-
# Example Service
67+
## Example Service
6868

69-
As an example for step 9, set up a service, `/etc/systemd/system/ob.service`, as follows:
69+
As an example for step 8, set up a service, `/etc/systemd/system/ob.service`, as follows. Be sure to update the `ExecStart` path and `User` as necessary.
7070

7171
```
7272
[Unit]
@@ -84,7 +84,7 @@ RestartSec=10
8484
WantedBy=multi-user.target
8585
```
8686

87-
Then enable and start the service:
87+
Then enable and start the service (as root or with sudo):
8888

8989
```
9090
systemctl daemon-reload

0 commit comments

Comments
 (0)