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 mux docs.

Browse Source
This commit is contained in:
Miroslav Šedivý 2022-07-31 12:19:05 +02:00
parent 629369487c
commit 45b0657858
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -38,10 +38,9 @@ Images (except `arm-`) are built using GitHub actions on every push and on weekl
- You can change API port (8080). - You can change API port (8080).
- This **WILL** work: `3000:8080` - This **WILL** work: `3000:8080`
#### But there is a hope! ### Using mux instead of epr
There has been an attempt to implement [single port ice using tcp and udp mux](https://github.com/m1k1o/neko/commit/c97b1fc4541caabf6b00331d081b02d2f9c58751) ([#106](https://github.com/m1k1o/neko/pull/106)), that allows using one port instead (each for TCP and/or UDP). This feature is not properly tested yet and only experimental.
We can use TCP mux and/or UDP mux, example: When using a mux, not so many ports are needed.
```yaml ```yaml
version: "3.4" version: "3.4"
@ -63,6 +62,13 @@ services:
NEKO_ICELITE: 1 NEKO_ICELITE: 1
``` ```
- When using mux, `NEKO_EPR` is ignored.
- You only need to expose maximum two ports for WebRTC on your router/firewall and have many users connected.
- It can even be the same port number, so e.g. `NEKO_TCPMUX: 8081` and `NEKO_UDPMUX: 8081`.
- You can use them alone (either TCP or UDP) when needed.
- UDP is generally better for latency. But some networks block UDP so it is good to have TCP available as fallback.
- Still, using `NEKO_ICELITE=true` is recommended.
### Want to customize and install own add-ons, set custom bookmarks? ### Want to customize and install own add-ons, set custom bookmarks?
- You would need to modify the existing policy file and mount it to your container. - You would need to modify the existing policy file and mount it to your container.
- For Firefox, copy [this](https://github.com/m1k1o/neko/blob/master/.docker/firefox/policies.json) file, modify and mount it as: ` -v '${PWD}/policies.json:/usr/lib/firefox/distribution/policies.json'` - For Firefox, copy [this](https://github.com/m1k1o/neko/blob/master/.docker/firefox/policies.json) file, modify and mount it as: ` -v '${PWD}/policies.json:/usr/lib/firefox/distribution/policies.json'`