From 159e3ec99b2e4f59b92984b7bf1aa7989387744d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20=C5=A0ediv=C3=BD?= Date: Thu, 13 Jan 2022 20:47:25 +0100 Subject: [PATCH] add tcp & udp mux to docs, #118. --- docs/getting-started/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index a744a5a5..858226fa 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -35,6 +35,31 @@ Images (except `arm-`) are built using GitHub actions on every push and on weekl - You can change API port (8080). - This **WILL** work: `3000:8080` +#### But there is a hope! +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: + +```yaml +version: "3.4" +services: + neko: + image: "m1k1o/neko:firefox" + restart: "unless-stopped" + shm_size: "2gb" + ports: + - "8080:8080" + - "8081:8081/tcp" + - "8082:8082/udp" + environment: + NEKO_SCREEN: 1920x1080@30 + NEKO_PASSWORD: neko + NEKO_PASSWORD_ADMIN: admin + NEKO_TCPMUX: 8081 + NEKO_UDPMUX: 8082 + NEKO_ICELITE: 1 +``` + ### 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. - 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'`