mirror of
https://github.com/m1k1o/neko.git
synced 2026-11-03 00:11:48 -06:00
feat: rename GPU-accelerated browser examples for Intel and Nvidia.
This commit is contained in:
+2
-2
@@ -8,8 +8,8 @@ These are the same examples shown in the [documentation](https://neko.m1k1o.net/
|
|||||||
| --- | --- |
|
| --- | --- |
|
||||||
| [simple-browser](./simple-browser) | Firefox with commented options for persistent/custom profiles and other available browser images. |
|
| [simple-browser](./simple-browser) | Firefox with commented options for persistent/custom profiles and other available browser images. |
|
||||||
| [kiosk-browser](./kiosk-browser) | Firefox in kiosk mode that opens a fixed URL on startup (e.g. a streaming service or dashboard). Stateless by default. |
|
| [kiosk-browser](./kiosk-browser) | Firefox in kiosk mode that opens a fixed URL on startup (e.g. a streaming service or dashboard). Stateless by default. |
|
||||||
| [nvidia-browser](./nvidia-browser) | Firefox with Nvidia GPU acceleration, with a commented "encode-only" option. |
|
| [gpu-nvidia-browser](./gpu-nvidia-browser) | Firefox with Nvidia GPU acceleration, with a commented "encode-only" option. |
|
||||||
| [intel-browser](./intel-browser) | Firefox with Intel (VAAPI) GPU acceleration, with a commented "encode-only" option. |
|
| [gpu-intel-browser](./gpu-intel-browser) | Firefox with Intel (VAAPI) GPU acceleration, with a commented "encode-only" option. |
|
||||||
| [raspberry-pi-browser](./raspberry-pi-browser) | Firefox tuned for Raspberry Pi, with a commented hardware-encoding option. |
|
| [raspberry-pi-browser](./raspberry-pi-browser) | Firefox tuned for Raspberry Pi, with a commented hardware-encoding option. |
|
||||||
| [arm64-browser](./arm64-browser) | Firefox on generic ARM64 hosts, with links to DRM setup and GPU acceleration options. |
|
| [arm64-browser](./arm64-browser) | Firefox on generic ARM64 hosts, with links to DRM setup and GPU acceleration options. |
|
||||||
| [turn-server](./turn-server) | A Coturn TURN server running alongside Neko for WebRTC NAT traversal. |
|
| [turn-server](./turn-server) | A Coturn TURN server running alongside Neko for WebRTC NAT traversal. |
|
||||||
|
|||||||
@@ -252,7 +252,7 @@ For images with Nvidia GPU hardware acceleration using EGL use:
|
|||||||
- [`ghcr.io/m1k1o/neko/nvidia-microsoft-edge`](https://ghcr.io/m1k1o/neko/nvidia-microsoft-edge)
|
- [`ghcr.io/m1k1o/neko/nvidia-microsoft-edge`](https://ghcr.io/m1k1o/neko/nvidia-microsoft-edge)
|
||||||
- [`ghcr.io/m1k1o/neko/nvidia-brave`](https://ghcr.io/m1k1o/neko/nvidia-brave)
|
- [`ghcr.io/m1k1o/neko/nvidia-brave`](https://ghcr.io/m1k1o/neko/nvidia-brave)
|
||||||
|
|
||||||
The base image is available at [`ghcr.io/m1k1o/neko/nvidia-base`](https://ghcr.io/m1k1o/neko/nvidia-base). See [Examples](/docs/v3/installation/examples#nvidia-browser) for more information and usage.
|
The base image is available at [`ghcr.io/m1k1o/neko/nvidia-base`](https://ghcr.io/m1k1o/neko/nvidia-base). See [Examples](/docs/v3/installation/examples#gpu-nvidia-browser) for more information and usage.
|
||||||
|
|
||||||
## Supported Architectures {#arch}
|
## Supported Architectures {#arch}
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ Browse: [`examples/kiosk-browser`](https://github.com/m1k1o/neko/tree/main/examp
|
|||||||
|
|
||||||
For some workflows, passing the target URL directly to Firefox is more reliable than using homepage policies, because session restore can otherwise override the start page. See also: [Supervisord Configuration](/docs/v3/customization#supervisord).
|
For some workflows, passing the target URL directly to Firefox is more reliable than using homepage policies, because session restore can otherwise override the start page. See also: [Supervisord Configuration](/docs/v3/customization#supervisord).
|
||||||
|
|
||||||
## Nvidia Browser {#nvidia-browser}
|
## Nvidia Browser {#gpu-nvidia-browser}
|
||||||
|
|
||||||
Neko supports hardware acceleration using Nvidia GPUs. To use this feature, you need to have the Nvidia Container Toolkit installed on your system. You can find the installation instructions [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html). Check if your GPU supports hardware encoding with [this list](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix).
|
Neko supports hardware acceleration using Nvidia GPUs. To use this feature, you need to have the Nvidia Container Toolkit installed on your system. You can find the installation instructions [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html). Check if your GPU supports hardware encoding with [this list](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix).
|
||||||
|
|
||||||
@@ -43,22 +43,22 @@ This example accelerates both video encoding and browser rendering using the GPU
|
|||||||
|
|
||||||
If you only want to accelerate the encoding, **not the browser rendering**, see the commented "ENCODE-ONLY OPTION" blocks in the example - they switch to the plain `firefox` image and a `videoconvert`-based pipeline instead of `nvidia-firefox` with `cudaupload`/`cudaconvert`.
|
If you only want to accelerate the encoding, **not the browser rendering**, see the commented "ENCODE-ONLY OPTION" blocks in the example - they switch to the plain `firefox` image and a `videoconvert`-based pipeline instead of `nvidia-firefox` with `cudaupload`/`cudaconvert`.
|
||||||
|
|
||||||
Browse: [`examples/nvidia-browser`](https://github.com/m1k1o/neko/tree/main/examples/nvidia-browser)
|
Browse: [`examples/gpu-nvidia-browser`](https://github.com/m1k1o/neko/tree/main/examples/gpu-nvidia-browser)
|
||||||
|
|
||||||
```yaml title="docker-compose.yaml" file=<rootDir>/examples/nvidia-browser/docker-compose.yaml
|
```yaml title="docker-compose.yaml" file=<rootDir>/examples/gpu-nvidia-browser/docker-compose.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
See available [Nvidia Docker Images](/docs/v3/installation/docker-images#nvidia).
|
See available [Nvidia Docker Images](/docs/v3/installation/docker-images#nvidia).
|
||||||
|
|
||||||
## Intel Browser {#intel-browser}
|
## Intel Browser {#gpu-intel-browser}
|
||||||
|
|
||||||
Neko supports hardware acceleration using Intel GPUs via VAAPI. This requires the host to expose `/dev/dri` and have the Intel graphics driver installed.
|
Neko supports hardware acceleration using Intel GPUs via VAAPI. This requires the host to expose `/dev/dri` and have the Intel graphics driver installed.
|
||||||
|
|
||||||
This example accelerates both video encoding and browser rendering using the `intel-firefox` image. If you only want to accelerate the encoding, **not the browser rendering**, see the commented "ENCODE-ONLY OPTION" in the example, which switches to the plain `firefox` image.
|
This example accelerates both video encoding and browser rendering using the `intel-firefox` image. If you only want to accelerate the encoding, **not the browser rendering**, see the commented "ENCODE-ONLY OPTION" in the example, which switches to the plain `firefox` image.
|
||||||
|
|
||||||
Browse: [`examples/intel-browser`](https://github.com/m1k1o/neko/tree/main/examples/intel-browser)
|
Browse: [`examples/gpu-intel-browser`](https://github.com/m1k1o/neko/tree/main/examples/gpu-intel-browser)
|
||||||
|
|
||||||
```yaml title="docker-compose.yaml" file=<rootDir>/examples/intel-browser/docker-compose.yaml
|
```yaml title="docker-compose.yaml" file=<rootDir>/examples/gpu-intel-browser/docker-compose.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
See available [Intel Docker Images](/docs/v3/installation/docker-images#intel).
|
See available [Intel Docker Images](/docs/v3/installation/docker-images#intel).
|
||||||
|
|||||||
Reference in New Issue
Block a user