Add example Docker Compose configurations for Neko (#684)

* 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
This commit is contained in:
Miroslav Šedivý
2026-09-27 17:13:20 +02:00
committed by GitHub
parent f4d632df2c
commit 3f4f94087a
16 changed files with 838 additions and 367 deletions
@@ -0,0 +1,39 @@
# Neko - Simple Browser Example
#
# Runs Firefox in Neko. Firefox is the default, most tested image, but Neko
# supports many other browsers and applications - see the full list here:
# https://neko.m1k1o.net/docs/v3/installation/docker-images#apps
#
# Other browser images you can swap in below:
# ghcr.io/m1k1o/neko/chromium
# ghcr.io/m1k1o/neko/google-chrome
# ghcr.io/m1k1o/neko/brave
# ghcr.io/m1k1o/neko/vivaldi
# ghcr.io/m1k1o/neko/microsoft-edge
# ghcr.io/m1k1o/neko/tor-browser
# ghcr.io/m1k1o/neko/waterfox
services:
neko:
image: "ghcr.io/m1k1o/neko/firefox:latest"
restart: "unless-stopped"
shm_size: "2gb"
ports:
- "8080:8080"
- "52000-52100:52000-52100/udp"
# volumes:
# Persist Firefox settings, bookmarks, extensions and history across
# container restarts by mounting the profile directory.
# See: https://neko.m1k1o.net/docs/v3/customization/browsers#persistent-profile
# - "./profile:/home/neko/.mozilla/firefox/profile.default"
# Or mount your own pre-configured Firefox profile instead of an empty one.
# See: https://neko.m1k1o.net/docs/v3/customization/browsers#persistent-profile
# - "./my-custom-profile:/home/neko/.mozilla/firefox/profile.default"
environment:
NEKO_DESKTOP_SCREEN: '1920x1080@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>