iridium/neko
2
2
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2024-07-24 14:40:50 +12:00
Code Issues Packages Projects Releases Wiki Activity

update docs, #273.

Browse Source
This commit is contained in:
Miroslav Šedivý 2023-04-02 12:35:06 +02:00
parent 395db0fd54
commit 009bc20969
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/getting-started/README.md
View File

@ -164,7 +164,7 @@ services:
### Nvidia GPU acceleration ### Nvidia GPU acceleration
You need to have nvidia-docker installed, start the container with `--gpus all` flag and use images built for nvidia (see above). You need to have [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) installed, start the container with `--gpus all` flag and use images built for nvidia (see above).
```bash ```bash
docker run -d --gpus all \ docker run -d --gpus all \
@ -176,6 +176,8 @@ docker run -d --gpus all \
-e NEKO_EPR=56000-56100 \ -e NEKO_EPR=56000-56100 \
-e NEKO_NAT1TO1=192.168.1.10 \ -e NEKO_NAT1TO1=192.168.1.10 \
-e NEKO_ICELITE=1 \ -e NEKO_ICELITE=1 \
-e NEKO_VIDEO_CODEC=h264 \
-e NEKO_HWENC=nvenc \
--shm-size=2gb \ --shm-size=2gb \
--cap-add=SYS_ADMIN \ --cap-add=SYS_ADMIN \
--name neko \ --name neko \
@ -202,6 +204,8 @@ services:
NEKO_PASSWORD_ADMIN: admin NEKO_PASSWORD_ADMIN: admin
NEKO_EPR: 56000-56100 NEKO_EPR: 56000-56100
NEKO_NAT1TO1: 192.168.1.10 NEKO_NAT1TO1: 192.168.1.10
NEKO_VIDEO_CODEC: h264
NEKO_HWENC: nvenc
deploy: deploy:
resources: resources:
reservations: reservations:
@ -211,7 +215,9 @@ services:
capabilities: [gpu] capabilities: [gpu]
``` ```
Note, currently only browser GPU acceleration is supported, not encoding. - You can verify that GPU is available inside the container by running `docker exec -it neko nvidia-smi` command.
- You can verify that GPU is used for encoding by searching for `nvh264enc` in `docker logs neko` output.
- If you don'ŧ specify `NEKO_HWENC: nvenc` environment variable, CPU encoding will be used but GPU will still be available for browser rendering.
### Want to use VPN for your n.eko browsing? ### Want to use VPN for your n.eko browsing?
- Check this out: https://github.com/m1k1o/neko-vpn - Check this out: https://github.com/m1k1o/neko-vpn