mirror of
https://github.com/m1k1o/neko.git
synced 2026-11-03 00:11:48 -06:00
Miroslav Šedivý
3f4f94087a
* Add example Docker Compose configurations for Neko - Introduced a simple browser example using Firefox in Docker with optional persistent profile configuration. - Added a TURN server example using Coturn alongside Neko for WebRTC support. - Updated installation documentation to include new examples and improved organization. - Enhanced Docusaurus configuration to support dynamic code imports for example files. - Updated package dependencies to include remark-code-import for better documentation handling. * feat: rename GPU-accelerated browser examples for Intel and Nvidia. * feat: update GPU browser examples and add OAuth configuration example * feat: add Raspberry Pi GPU browser example and update documentation links * feat: update GPU browser examples section for clarity and organization
Examples
Ready-to-use Docker Compose configurations for Neko. Each folder is self-contained and can be copied out and run on its own with docker compose up. All files are heavily commented, showing available options and linking to the relevant documentation inline.
These are the same examples shown in the documentation, kept here so they can be browsed, cloned or downloaded directly from the repository.
| Example | Description |
|---|---|
| simple-browser | Firefox with commented options for persistent/custom profiles and other available browser images. |
| kiosk-browser | Firefox in kiosk mode that opens a fixed URL on startup (e.g. a streaming service or dashboard). Stateless by default. |
| oauth | Firefox authenticating members through an external OAuth 2.0 / OpenID Connect provider, configured via a mounted config.yaml. |
| gpu-nvidia-browser | Firefox with Nvidia GPU acceleration, with a commented "encode-only" option. |
| gpu-intel-browser | Firefox with Intel (VAAPI) GPU acceleration, with a commented "encode-only" option. |
| gpu-raspberry-pi-browser | Firefox tuned for Raspberry Pi, with a commented hardware-encoding option. |
| arm64-browser | Firefox on generic ARM64 hosts, with links to DRM setup and GPU acceleration options. |
| turn-server | A Coturn TURN server running alongside Neko for WebRTC NAT traversal. |