deblan-mirror/stream-sprout
1
0
Fork 0
mirror of https://github.com/wimpysworld/stream-sprout synced 2026-03-14 14:45:50 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: update documentation to explain the new server config

Browse source
This commit is contained in:
Martin Wimpress 2024-07-24 22:35:52 +01:00 • committed by Martin Wimpress
commit f3b1271813
2 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
.github/obs-settings.png vendored
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Before After
Before After

24
README.md
View file

@ -151,24 +151,31 @@ If you don't specify a configuration file, Stream Sprout will look for a configu
### Server
Here's an example configuration for the Stream Sprout `server:` section.
```yaml
server:
url: "rtmp://127.0.0.1:1935"
ip: 127.0.0.1
port: 1935
app: sprout
key: "create your key with uuidgen here"
archive_stream: false
archive_path: "${HOME}/Streams"
```
The `server:` section is used to configure the RTMP server that Stream Sprout creates; it must be an RTMP URL.
The default port for RTMP is `1935`, but you can use any port you like.
If you remotely host Stream Sprout, you should use an IP address in the `url:` that accessible by your computer that runs OBS Studio and also set `key:` to a secure value to prevent unauthorized access.
Running `uuidgen` will generate a suitable value.
The `server:` section is used to configure the RTMP server that Stream Sprout creates.
- The default `ip` address is `127.0.0.1`. Use `0.0.0.0` to allow connections to any network interface.
- If you remotely host Stream Sprout, use an IP address that is accessible by your computer that runs OBS Studio.
- The default `port` for RTMP is `1935`, but you can use any port between `1024` and `65535`.
- The default `app` name is `sprout`, but you can use any name you like.
- Set `key:` to a secure value to prevent unauthorized access. Running `uuidgen` will generate a suitable value.
The IP address, port, app name and key are composed to create the RTMP URL that you will use in OBS Studio.
For example, `rtmp://ip:port/app/key`.
If `archive_stream:` is `true` Stream Sprout will archive the stream to disk in the directory specified by `archive_path:`.
If `archive_path:` is not accessible, Stream Sprout will fallback to using the current working directory.
Here's an example configuration for the Stream Sprout `server:` section.
### Services
`services:` are arbitrarily named.
@ -227,7 +234,7 @@ services:
- Go to `Settings` > `Stream`
- Select `Custom` from the `Service` dropdown
- Copy the server `url:` from your Stream Sprout configuration to the `Server` field:
- `rtmp://127.0.0.1:1935` (*default*)
- `rtmp://127.0.0.1:1935/sprout` (*default*)
- Copy the `key:` (if you specified one) from your Stream Sprout configuration to the `Stream Key` field
![OBS Studio Stream Settings](.github/obs-settings.png)
@ -236,6 +243,7 @@ services:
- Stream Sprout does not support secure RTMP (RTMPS) at this time.
- *At least I don't think it does, but I haven't fully tested it.*
- https://superuser.com/questions/1438939/live-streaming-over-rtmps-using-ffmpeg
- Each destination you add will increase your bandwidth requirements.
## References