Skip to content

Commit ca4d345

Browse files
committed
Updated README with image tags info and basic docker examples
1 parent df87ff2 commit ca4d345

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,37 @@ A containerized application to stream a webpage live over RTMP. Just pass a `WE
99
- Setting up a way to broadcast an overlay [like YarpBot does for its status page](https://www.twitch.tv/yarpbot) without a GUI client.
1010
- Other.... stuff (you figure it out).
1111

12+
## Dependencies
13+
14+
1. [Docker](https://www.docker.com/) (or some other container runtime like [containerd](https://containerd.io/))
15+
2. .....That's it. Why did we make this a list?
16+
17+
## Quick Start
18+
19+
### Start A Stream Using Default Settings (720p 30 FPS)
20+
21+
`docker run -e WEBPAGE_URL=https://url-of-website-i-want-to-stream.com -e RTMP_URL=rtmp://rtmp-endpoint.to/stream/to ghcr.io/zozman/stream-webpage-container`
22+
23+
### Start A Stream At 1080p 60 FPS
24+
25+
`docker run -e WEBPAGE_URL=https://url-of-website-i-want-to-stream.com -e RTMP_URL=rtmp://rtmp-endpoint.to/stream/to -e RESOLUTION=720p -e FRAMERATE=60 ghcr.io/zozman/stream-webpage-container`
26+
27+
## Available Image Tags
28+
29+
> [!NOTE]
30+
> All available images can be found on the repo's [container package](https://github.com/Zozman/stream-webpage-container/pkgs/container/stream-webpage-container) page.
31+
32+
- `latest`
33+
- Represents the latest [release](https://github.com/Zozman/stream-webpage-container/releases) and should be what you use if you don't know what to use.
34+
- `v*`
35+
- Example: `v1.0.0`
36+
- Represents a specific [release](https://github.com/Zozman/stream-webpage-container/releases) and is the right choice if you want to update versions manually.
37+
- `edge`
38+
- Represents the latest commit to `main` and is not recommended for daily use unless you want the latest build NOW.
39+
- `sha-*`
40+
- Examples: `sha-df87ff2ac624eb2de65861dfa3b09844a3f0f3db`, `sha-df87ff2`
41+
- Every commit to `main` will have a tag corresponding to that commit's long and short SHA.
42+
1243
## Running From Source
1344

1445
> [!NOTE]

0 commit comments

Comments
 (0)