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: docs/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ This project provides a set of scripts to set up an Nginx server with RTMP modul
63
63
***Multi-Platform Restreaming:** Configure Nginx to push your input stream to multiple RTMP/RTMPS endpoints.
64
64
***Stunnel4 for RTMPS:** Securely stream to services requiring RTMPS by tunneling RTMP through Stunnel4.
65
65
***HLS Output:** Configure Nginx to output HLS (HTTP Live Streaming) for playback in web browsers or media players.
66
-
***Flexible Configuration:** Uses a `real.env/master.env` file for easy customization of stream keys, paths, and application names.
66
+
***Flexible Configuration:** Uses a `real.env/master.env` file for easy customisation of stream keys, paths, and application names.
67
67
***Helper Scripts:** Includes scripts for initial setup, service management (start, stop, status), SSL certificate generation for Stunnel, and a full reset.
68
68
***WSL2 Support:** Includes a PowerShell script (`WSL2-Setup/Install-RestreamWSL.ps1`) to automate WSL2 setup, Linux distribution installation, and running the restream server setup on Windows.
69
69
***WSL2 Management Scripts:**
@@ -291,7 +291,7 @@ The `stream-gphoto2-webcam.sh` script uses `ffmpeg` to process the output from `
291
291
* `-f lavfi -i anullsrc=channel_layout=stereo:sample_rate=44100`: Generates a silent stereo audio track at 44.1kHz. This is crucial if your camera doesn't provide audio or for compatibility with some streaming platforms that require an audio track.
292
292
* Video Encoding (`libx264` - H.264):
293
293
*`-c:v libx264`: Specifies the H.264 video codec.
294
-
*`-preset ultrafast`: A common preset for live streaming, prioritizing low CPU usage over quality/compression. Other presets include `superfast`, `veryfast`, `faster`, `fast`, `medium` (default), `slow`, `slower`, `veryslow`. Slower presets give better quality/compression at the cost of higher CPU.
294
+
*`-preset ultrafast`: A common preset for live streaming, prioritising low CPU usage over quality/compression. Other presets include `superfast`, `veryfast`, `faster`, `fast`, `medium` (default), `slow`, `slower`, `veryslow`. Slower presets give better quality/compression at the cost of higher CPU.
295
295
*`-b:v 2000k` (e.g., 2 Mbps): Sets the target video bitrate. Adjust based on your internet upload speed and desired quality.
296
296
*`-maxrate 2500k`: Sets the maximum allowed video bitrate.
297
297
*`-bufsize 4000k`: Sets the decoder buffer size, often twice the maxrate.
@@ -335,4 +335,4 @@ Using `gphoto2` within WSL2 requires successful USB device passthrough from Wind
335
335
***Stunnel4 Logs:** Check the `output` path specified in your `/etc/stunnel/stunnel.conf` (e.g., `/var/log/stunnel4/stunnel.log`). The debug level can also be adjusted in`stunnel.conf`.
336
336
***Permissions:** Ensure file and directory permissions are correct, especially for Nginx PID files, web content, HLS directories, and Stunnel run/log directories. The setup script attempts to handle these.
337
337
***Firewall:** On standalone Linux, ensure your system firewall (e.g., `ufw`) allows incoming connections on the necessary ports (e.g., 1935 for RTMP, or any ports Stunnel listens on if accessed externally, 8080 for HLS HTTP).
338
-
***WSL2 Networking:** If OBS or your streaming source can't connect to Nginx in WSL2, double-check the WSL2 IP address and your Windows Firewall rules (see WSL2 section).
338
+
***WSL2 Networking:** If OBS or your streaming source can't connect to Nginx in WSL2, double-check the WSL2 IP address and your Windows Firewall rules (see WSL2 section).
0 commit comments