You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,18 +10,18 @@
10
10
11
11
## Required PHP Modules
12
12
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):
14
14
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)
21
21
22
22
## Required Packages
23
23
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.
25
25
26
26
- festival (for text-to-speech functionality)
27
27
- imagemagick (for image manipulation)
@@ -40,11 +40,11 @@ Install the following Ubuntu / Debian packages, or the equivalent for your opera
40
40
composer install && npm install
41
41
```
42
42
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.
44
44
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.
46
46
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.
48
48
49
49
```
50
50
tools/cli/ob check
@@ -56,17 +56,17 @@ tools/cli/ob check
56
56
tools/cli/ob updates run all
57
57
```
58
58
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.
60
60
61
61
```
62
62
tools/cli/ob passwd admin
63
63
```
64
64
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.
66
66
67
-
# Example Service
67
+
##Example Service
68
68
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.
70
70
71
71
```
72
72
[Unit]
@@ -84,7 +84,7 @@ RestartSec=10
84
84
WantedBy=multi-user.target
85
85
```
86
86
87
-
Then enable and start the service:
87
+
Then enable and start the service (as root or with sudo):
0 commit comments