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

fix some typos

Browse Source
This commit is contained in:
mbattista 2021-03-21 23:00:33 +00:00
parent 39f5c0e7fa
commit 0d54b71055
2 changed files with 8 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.m1k1o/vlc/Dockerfile
View File

@ -1,4 +1,4 @@
FROM m1k1o1/neko:base FROM m1k1o/neko:base
# #
# install firefox-esr # install firefox-esr

31
README.md
View File

@ -58,12 +58,16 @@ For n.eko room management software visit https://github.com/m1k1o/neko-rooms.
- Added `m1k1o/neko:vncviewer` tag, use `NEKO_VNC_URL` to specify VNC target and use n.eko as a bridge. - Added `m1k1o/neko:vncviewer` tag, use `NEKO_VNC_URL` to specify VNC target and use n.eko as a bridge.
- Abiltiy to include neko as a component in another Vue.Js project (by @gbrian). - Abiltiy to include neko as a component in another Vue.Js project (by @gbrian).
- Added HEALTHCHECK to Dockerfile. - Added HEALTHCHECK to Dockerfile.
- Added `m1k1o/neko:vlc` tag, use VLC to watch local files together (by @mbattista).
- Added `m1k1o/neko:wesnoth` tag, as an non video related showcase (by @mbattista).
# Getting started & FAQ # Getting started & FAQ
Use following docker images: Use following docker images:
- `m1k1o/neko:latest` - for Firefox. - `m1k1o/neko:latest` - for Firefox.
- `m1k1o/neko:chromium` - for Chromium Ungoogled (needs `--cap-add=SYS_ADMIN`). - `m1k1o/neko:chromium` - for Chromium Ungoogled (needs `--cap-add=SYS_ADMIN`).
- `m1k1o/neko:vlc` - for VLC Video player (needs `volumes` folder with local video files)
- `m1k1o/neko:wesnoth` - for playing wesnoth
- `m1k1o/neko:base` - for custom base. - `m1k1o/neko:base` - for custom base.
Networking: Networking:
@ -162,30 +166,6 @@ services:
NEKO_NAT1TO1: <your-IP> NEKO_NAT1TO1: <your-IP>
``` ```
## Wesnoth
Neko can share any application via docker.
For example the round-based strategy game wesnoth.
```yaml
version: "3.4"
services:
neko:
image: "m1k1o/neko:wesnoth"
restart: "unless-stopped"
shm_size: "2gb"
ports:
- "8080:8080"
- "52000-52100:52000-52100/udp"
cap_add:
- SYS_ADMIN
environment:
NEKO_SCREEN: '1920x1080@30'
NEKO_PASSWORD: neko
NEKO_PASSWORD_ADMIN: admin
NEKO_EPR: 52000-52100
NEKO_NAT1TO1: <your-IP>
```
## Mobile support ## Mobile support
Neko is now working on iOS and Android! Also, the UI screens have been fixed for small screens. Neko is now working on iOS and Android! Also, the UI screens have been fixed for small screens.
@ -238,6 +218,9 @@ NEKO_PCMU:
NEKO_PCMA: NEKO_PCMA:
- If pcma should be used as audio encoder for the stream - If pcma should be used as audio encoder for the stream
- e.g. 'false' - e.g. 'false'
NEKO_AUDIO_BITRATE:
- Bitrate of the audio stream in kb/s
- e.g. 196
NEKO_CERT: NEKO_CERT:
- Path to the SSL-Certificate - Path to the SSL-Certificate
- e.g. '/certs/cert.pem' - e.g. '/certs/cert.pem'