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
35 lines
1.4 KiB
YAML
35 lines
1.4 KiB
YAML
# Neko - Kiosk Browser Example
|
|
#
|
|
# Runs Firefox in kiosk mode (no address bar, tabs or browser chrome) and
|
|
# opens a fixed URL automatically on startup. Useful for turning a smart
|
|
# display, thin client or dedicated terminal into an app-like experience.
|
|
#
|
|
# This works by overriding the Firefox supervisor command, see ./firefox.conf
|
|
# and the Supervisord Configuration docs:
|
|
# https://neko.m1k1o.net/docs/v3/customization#supervisord
|
|
services:
|
|
neko:
|
|
image: "ghcr.io/m1k1o/neko/firefox:latest"
|
|
restart: "unless-stopped"
|
|
shm_size: "2gb"
|
|
ports:
|
|
- "8080:8080"
|
|
- "52000-52100:52000-52100/udp"
|
|
volumes:
|
|
- "./firefox.conf:/etc/neko/supervisord/firefox.conf:ro"
|
|
|
|
# NOTE: this setup is intentionally stateless - no profile is persisted,
|
|
# so cookies and logins are lost every time the container restarts. If
|
|
# you want the kiosk session to stay logged in across restarts, mount a
|
|
# persistent profile directory as well:
|
|
# See: https://neko.m1k1o.net/docs/v3/customization/browsers#persistent-profile
|
|
# - "./profile:/home/neko/.mozilla/firefox/profile.default"
|
|
environment:
|
|
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>
|