mirror of
https://github.com/m1k1o/neko.git
synced 2026-11-03 08:21:50 -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
44 lines
1.8 KiB
YAML
44 lines
1.8 KiB
YAML
# Neko - Raspberry Pi Browser Example
|
|
#
|
|
# Runs Firefox on a Raspberry Pi (or similar ARM SBC). Works out of the box
|
|
# with software rendering/encoding; see below for optional hardware-
|
|
# accelerated encoding on boards with a V4L2 M2M encoder (e.g. Pi 3/4).
|
|
#
|
|
# See supported architectures and known caveats:
|
|
# https://neko.m1k1o.net/docs/v3/installation/docker-images#availability
|
|
services:
|
|
neko:
|
|
image: "ghcr.io/m1k1o/neko/firefox:latest"
|
|
restart: "unless-stopped"
|
|
# increase on Pi's with more than 1gb ram.
|
|
shm_size: "520mb"
|
|
ports:
|
|
- "8080:8080"
|
|
- "52000-52100:52000-52100/udp"
|
|
# note: required for the GPU ACCELERATION OPTION below, alternatively
|
|
# mount the specific /dev/video* devices instead of running privileged.
|
|
# privileged: true
|
|
environment:
|
|
# GPU ACCELERATION OPTION: enable hardware encoding via the Broadcom
|
|
# VideoCore V4L2 M2M encoder (available on Raspberry Pi 3/4, not Pi 5).
|
|
# Requires `privileged: true` above (or the matching /dev/video* devices).
|
|
# NEKO_CAPTURE_VIDEO_PIPELINE: |
|
|
# ximagesrc display-name={display} show-pointer=true use-damage=false
|
|
# ! video/x-raw,framerate=25/1
|
|
# ! videoconvert ! queue
|
|
# ! video/x-raw,format=NV12
|
|
# ! v4l2h264enc
|
|
# name=encoder
|
|
# extra-controls="controls,h264_profile=1,video_bitrate=1250000;"
|
|
# ! h264parse config-interval=-1
|
|
# ! video/x-h264,stream-format=byte-stream
|
|
# ! appsink name=appsink
|
|
# NEKO_CAPTURE_VIDEO_CODEC: "h264"
|
|
NEKO_DESKTOP_SCREEN: '1280x720@30'
|
|
NEKO_MEMBER_MULTIUSER_USER_PASSWORD: neko
|
|
NEKO_MEMBER_MULTIUSER_ADMIN_PASSWORD: admin
|
|
NEKO_WEBRTC_EPR: 52000-52100
|
|
NEKO_WEBRTC_ICELITE: 1
|
|
# See: https://neko.m1k1o.net/docs/v3/configuration/webrtc#nat1to1
|
|
# NEKO_WEBRTC_NAT1TO1: <your-IP>
|