Update README files to reflect new Docker image naming and features in the fork

This commit is contained in:
Sergey Krashevich
2026-03-11 00:24:33 +03:00
parent d4c2721d1c
commit 5fced9a580
3 changed files with 41 additions and 6 deletions
+36 -1
View File
@@ -22,6 +22,41 @@
Ultimate camera streaming application with support for dozens formats and protocols.
---
> ### 🔀 Fork: [skrashevich/go2rtc](https://github.com/skrashevich/go2rtc)
>
> This is a fork of [AlexxIT/go2rtc](https://github.com/AlexxIT/go2rtc) with the following additions:
>
> - **HomeKit Secure Video (HKSV)** — full recording support with motion detection (P-frame analysis, ONVIF events, API)
> - **ONVIF motion detection** — automatic motion events from ONVIF cameras for HomeKit
> - **WebP streaming** — native WebP encoding (snapshot & multipart stream) without FFmpeg
> - **System resource monitoring** — CPU/memory usage in API (`/api/system`) and WebUI graphs
> - **Read-only mode** — disable all write operations in API/WebUI for production security
> - **Offline WebUI in Docker** — CDN JS dependencies bundled into Docker images
> - **YAML config merge fix** — corrected merge behavior for YAML configuration
> - **Streams race condition fix** — fixed race condition in stream schema handling
> - **Go 1.26** — updated to the latest Go runtime
>
> #### Download
>
> **Docker images** (GHCR):
> ```bash
> # Standard
> docker pull ghcr.io/skrashevich/go2rtc:beta
>
> # With hardware acceleration (Intel/AMD)
> docker pull ghcr.io/skrashevich/go2rtc:beta-hardware
>
> # Rockchip
> docker pull ghcr.io/skrashevich/go2rtc:beta-rockchip
> ```
>
> **Binaries**: download from [GitHub Actions](https://github.com/skrashevich/go2rtc/actions/workflows/build.yml) artifacts (select the latest successful run on the `beta` branch).
> Available for: Windows (amd64, i386, arm64), Linux (amd64, i386, arm, arm64), macOS (amd64, arm64), FreeBSD (amd64, arm64).
---
- zero-dependency [small app](#go2rtc-binary) for all OS (Windows, macOS, Linux, FreeBSD)
- zero-delay for many [supported protocols](#codecs-madness) (lowest possible streaming latency)
- [streaming input](#streaming-input) from dozens formats and protocols
@@ -135,7 +170,7 @@ It comes preinstalled with [FFmpeg](internal/ffmpeg/README.md) and [Python](inte
Latest, but maybe unstable version:
- Binary: [latest master build](https://nightly.link/AlexxIT/go2rtc/workflows/build/master)
- Docker: `alexxit/go2rtc:master` or `alexxit/go2rtc:master-hardware` versions
- Docker: `ghcr.io/skrashevich/go2rtc:beta` or `ghcr.io/skrashevich/go2rtc:beta-hardware` versions
- Home Assistant add-on: `go2rtc master` or `go2rtc master hardware` versions
## Configuration
+3 -3
View File
@@ -7,9 +7,9 @@ Images are built automatically via [GitHub actions](https://github.com/AlexxIT/g
- `alexxit/go2rtc:latest` - latest release based on `alpine` (`amd64`, `386`, `arm/v6`, `arm/v7`, `arm64`) with support for hardware transcoding for Intel iGPU and Raspberry
- `alexxit/go2rtc:latest-hardware` - latest release based on `debian 13` (`amd64`) with support for hardware transcoding for Intel iGPU, AMD GPU and NVidia GPU
- `alexxit/go2rtc:latest-rockchip` - latest release based on `debian 12` (`arm64`) with support for hardware transcoding for Rockchip RK35xx
- `alexxit/go2rtc:master` - latest unstable version based on `alpine`
- `alexxit/go2rtc:master-hardware` - latest unstable version based on `debian 13` (`amd64`)
- `alexxit/go2rtc:master-rockchip` - latest unstable version based on `debian 12` (`arm64`)
- `ghcr.io/skrashevich/go2rtc:beta` - latest unstable version based on `alpine`
- `ghcr.io/skrashevich/go2rtc:beta-hardware` - latest unstable version based on `debian 13` (`amd64`)
- `ghcr.io/skrashevich/go2rtc:beta-rockchip` - latest unstable version based on `debian 12` (`arm64`)
## Docker compose
+2 -2
View File
@@ -59,7 +59,7 @@ Docker users should add the `--privileged` option to the container for access to
**Supported on:** Linux binary, Docker, Hass Addon.
Docker users should install: `alexxit/go2rtc:master-hardware`. Docker users should add the `--privileged` option to the container for access to the hardware.
Docker users should install: `ghcr.io/skrashevich/go2rtc:beta-hardware`. Docker users should add the `--privileged` option to the container for access to the hardware.
Hass Addon users should install **go2rtc master hardware** version.
@@ -69,7 +69,7 @@ Hass Addon users should install **go2rtc master hardware** version.
**Supported on:** Windows binary, Linux binary, Docker.
Docker users should install: `alexxit/go2rtc:master-hardware`.
Docker users should install: `ghcr.io/skrashevich/go2rtc:beta-hardware`.
Read more [here](https://docs.frigate.video/configuration/hardware_acceleration) and [here](https://jellyfin.org/docs/general/administration/hardware-acceleration/#nvidia-hardware-acceleration-on-docker-linux).