mirror of
https://github.com/m1k1o/neko.git
synced 2026-11-03 08:21:50 -06:00
Miroslav Šedivý
a597d44680
* move flavored bookworm dockerfile to a new trixie dockerfile. * fix opera openbox selector. * fix remmina dependencies. * remove chromium explicit bookworm source. * Update apps to work with trixie (#624) Co-authored-by: yesBad <me@bad.cash> * remove SYS_ADMIN capability requirement for Chromium-based Docker images and update documentation accordingly. * fix chromium package. * change uBlock Origin to uBlock Origin Lite. * restore waterfox in build matrix for GHCR workflows. --------- Co-authored-by: Bad <87938689+yesBad@users.noreply.github.com> Co-authored-by: yesBad <me@bad.cash>
110 lines
2.7 KiB
Markdown
110 lines
2.7 KiB
Markdown
---
|
|
sidebar_position: 3
|
|
---
|
|
|
|
# Examples
|
|
|
|
## Firefox
|
|
|
|
```yaml
|
|
version: "3.4"
|
|
services:
|
|
neko:
|
|
image: "m1k1o/neko:firefox"
|
|
restart: "unless-stopped"
|
|
shm_size: "2gb"
|
|
ports:
|
|
- "8080:8080"
|
|
- "52000-52100:52000-52100/udp"
|
|
volumes:
|
|
- <your-host-path>:/home/neko/.mozilla/firefox # persist firexfox settings
|
|
environment:
|
|
NEKO_SCREEN: '1920x1080@30'
|
|
NEKO_PASSWORD: neko
|
|
NEKO_PASSWORD_ADMIN: admin
|
|
NEKO_EPR: 52000-52100
|
|
NEKO_NAT1TO1: <your-IP>
|
|
```
|
|
|
|
## Chromium
|
|
|
|
```yaml
|
|
version: "3.4"
|
|
services:
|
|
neko:
|
|
image: "m1k1o/neko:chromium"
|
|
restart: "unless-stopped"
|
|
shm_size: "2gb"
|
|
ports:
|
|
- "8080:8080"
|
|
- "52000-52100:52000-52100/udp"
|
|
environment:
|
|
NEKO_SCREEN: '1920x1080@30'
|
|
NEKO_PASSWORD: neko
|
|
NEKO_PASSWORD_ADMIN: admin
|
|
NEKO_EPR: 52000-52100
|
|
NEKO_NAT1TO1: <your-IP>
|
|
```
|
|
|
|
## VLC
|
|
|
|
```yaml
|
|
version: "3.4"
|
|
services:
|
|
neko:
|
|
image: "m1k1o/neko:vlc"
|
|
restart: "unless-stopped"
|
|
shm_size: "2gb"
|
|
volumes:
|
|
- "<your-video-folder>:/video"
|
|
ports:
|
|
- "8080:8080"
|
|
- "52000-52100:52000-52100/udp"
|
|
environment:
|
|
NEKO_SCREEN: '1920x1080@30'
|
|
NEKO_PASSWORD: neko
|
|
NEKO_PASSWORD_ADMIN: admin
|
|
NEKO_EPR: 52000-52100
|
|
NEKO_NAT1TO1: <your-IP>
|
|
```
|
|
|
|
## Raspberry Pi
|
|
|
|
```yaml
|
|
version: "3.4"
|
|
services:
|
|
neko:
|
|
# see docs for more variants
|
|
image: "ghcr.io/m1k1o/neko/arm-chromium:latest"
|
|
restart: "unless-stopped"
|
|
# increase on rpi's with more then 1gb ram.
|
|
shm_size: "520mb"
|
|
ports:
|
|
- "8088:8080"
|
|
- "52000-52100:52000-52100/udp"
|
|
# note: this is important since we need a GPU for hardware acceleration alternatively
|
|
# mount the devices into the docker.
|
|
privileged: true
|
|
environment:
|
|
NEKO_SCREEN: '1280x720@30'
|
|
NEKO_PASSWORD: 'neko'
|
|
NEKO_PASSWORD_ADMIN: 'admin'
|
|
NEKO_EPR: 52000-52100
|
|
# note: when setting NEKO_VIDEO, then variables NEKO_MAX_FPS and NEKO_VIDEO_BITRATE
|
|
# are not being used, you can adjust them in this variable.
|
|
NEKO_VIDEO: |
|
|
ximagesrc display-name=%s use-damage=0 show-pointer=true use-damage=false
|
|
! video/x-raw,framerate=30/1
|
|
! videoconvert
|
|
! queue
|
|
! video/x-raw,framerate=30/1,format=NV12
|
|
! v4l2h264enc extra-controls="controls,h264_profile=1,video_bitrate=1250000;"
|
|
! h264parse config-interval=3
|
|
! video/x-h264,stream-format=byte-stream,profile=constrained-baseline
|
|
NEKO_VIDEO_CODEC: h264
|
|
```
|
|
|
|
## Not using docker?
|
|
|
|
You can execute `neko --help` to see available arguments. In [Dockerfile](https://github.com/m1k1o/neko/blob/master/.docker/base/Dockerfile) you can find required dependencies and install them manually.
|