From 435ec8d0f6db98238721608c4f91162eb1da849b Mon Sep 17 00:00:00 2001 From: m1k1o Date: Sun, 5 Apr 2020 10:58:52 +0200 Subject: [PATCH 1/3] NEKO_ADMIN -> NEKO_PASSWORD_ADMIN --- Dockerfile | 2 +- docs/configuration.md | 10 +++++----- docs/docker.md | 4 ++-- docs/server.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Dockerfile b/Dockerfile index 8ac257d6..6815e30a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -68,7 +68,7 @@ COPY server/bin/neko /usr/bin/neko # # neko env ENV NEKO_PASSWORD=neko -ENV NEKO_ADMIN=admin +ENV NEKO_PASSWORD_ADMIN=admin ENV NEKO_BIND=:8080 # diff --git a/docs/configuration.md b/docs/configuration.md index ed163ad4..da909e68 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -2,9 +2,9 @@ ## Docker Basic Configuration ``` -NEKO_PASSWORD=neko // Password -NEKO_ADMIN=neko // Admin Password -NEKO_BIND=0.0.0.0:8080 // Bind -NEKO_KEY= // (SSL) Key, needed for clipboard sync -NEKO_CERT= // (SSL) Cert, needed for clipboard sync +NEKO_PASSWORD=neko // Password +NEKO_PASSWORD_ADMIN=admin // Admin Password +NEKO_BIND=0.0.0.0:8080 // Bind +NEKO_KEY= // (SSL) Key, needed for clipboard sync +NEKO_CERT= // (SSL) Cert, needed for clipboard sync ``` \ No newline at end of file diff --git a/docs/docker.md b/docs/docker.md index ea53e15e..88549219 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -3,13 +3,13 @@ ## Running: ### Chromium container: ``` -sudo docker run -p 80:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_ADMIN='secret' --cap-add SYS_ADMIN --shm-size=1gb nurdism/neko:chromium +sudo docker run -p 80:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_PASSWORD_ADMIN='secret' --cap-add SYS_ADMIN --shm-size=1gb nurdism/neko:chromium ``` *Note:* `--cap-add SYS_ADMIN` & `--shm-size=1gb` is required for chromium to run properly ---- ### Firefox container: ``` -sudo docker run -p 8080:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_ADMIN='secret' --shm-size=1gb nurdism/neko:firefox +sudo docker run -p 8080:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_PASSWORD_ADMIN='secret' --shm-size=1gb nurdism/neko:firefox ``` *Note:* `--shm-size=1gb` is required for firefox, tabs will crash otherwise \ No newline at end of file diff --git a/docs/server.md b/docs/server.md index b2a8489d..f9d14ed6 100644 --- a/docs/server.md +++ b/docs/server.md @@ -24,7 +24,7 @@ Server for n.eko, as of right now this will *only* work on Linux systems, only t --pcmu // (bool) use PCMU audio codec --pcma // (bool) use PCMA audio codec --password "neko" // (string) password for connecting to stream ---admin "admin" // (string) admin password for connecting to stream +--password_admin "admin" // (string) admin password for connecting to stream ``` Config can be set via environment variables with the prefix `NEKO_` (I.E. NEKO_BIND="127.0.0.1:8080") From 048094e85096136c3f6b374b040177df3390e790 Mon Sep 17 00:00:00 2001 From: m1k1o Date: Sun, 5 Apr 2020 11:03:45 +0200 Subject: [PATCH 2/3] aduio <- typo --- docs/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server.md b/docs/server.md index f9d14ed6..1909b459 100644 --- a/docs/server.md +++ b/docs/server.md @@ -13,7 +13,7 @@ Server for n.eko, as of right now this will *only* work on Linux systems, only t --static "./www" // (string) path to neko client files to serve --device "auto_null.monitor" // (string) audio device to capture --display ":99.0" // (string) XDisplay to capture ---aduio "" // (string) audio codec parameters to use for streaming (unused) +--audio "" // (string) audio codec parameters to use for streaming (unused) --video "" // (string) video codec parameters to use for streaming (unused) --epr "59000-59100" // (string) limits the pool of ephemeral ports that ICE UDP connections can allocate from --vp8 // (bool) use VP8 video codec From 9284c23771dea91d1a22ad6d529d39704108d0b4 Mon Sep 17 00:00:00 2001 From: m1k1o Date: Sun, 5 Apr 2020 11:13:09 +0200 Subject: [PATCH 3/3] servers configs from code to docs --- docs/server.md | 46 +++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/docs/server.md b/docs/server.md index 1909b459..2b1a332c 100644 --- a/docs/server.md +++ b/docs/server.md @@ -4,27 +4,31 @@ Server for n.eko, as of right now this will *only* work on Linux systems, only t ## Configuration ------ ``` ---debug // (bool) enable debug mode ---logs // (bool) save logs to file ---config "" // (string) configuration file path ---bind "127.0.0.1:8080" // (string) address/port/socket to serve neko ---cert "" // (string) path to the SSL cert used to secure the neko server ---key "" // (string) path to the SSL key used to secure the neko server ---static "./www" // (string) path to neko client files to serve ---device "auto_null.monitor" // (string) audio device to capture ---display ":99.0" // (string) XDisplay to capture ---audio "" // (string) audio codec parameters to use for streaming (unused) ---video "" // (string) video codec parameters to use for streaming (unused) ---epr "59000-59100" // (string) limits the pool of ephemeral ports that ICE UDP connections can allocate from ---vp8 // (bool) use VP8 video codec ---vp9 // (bool) use VP9 video codec ---h264 // (bool) use H264 video codec ---opus // (bool) use Opus audio codec ---g722 // (bool) use G722 audio codec ---pcmu // (bool) use PCMU audio codec ---pcma // (bool) use PCMA audio codec ---password "neko" // (string) password for connecting to stream ---password_admin "admin" // (string) admin password for connecting to stream +--debug // (bool) enable debug mode +--logs // (bool) save logs to file +--config "" // (string) configuration file path +--bind "127.0.0.1:8080" // (string) address/port/socket to serve neko +--cert "" // (string) path to the SSL cert used to secure the neko server +--key "" // (string) path to the SSL key used to secure the neko server +--static "./www" // (string) path to neko client files to serve +--device "auto_null.monitor" // (string) audio device to capture +--display ":99.0" // (string) XDisplay to capture +--audio "" // (string) audio codec parameters to use for streaming (unused) +--video "" // (string) video codec parameters to use for streaming (unused) +--screen "1280x720@30" // (string) default screen resolution and framerate +--epr "59000-59100" // (string) limits the pool of ephemeral ports that ICE UDP connections can allocate from +--vp8 // (bool) use VP8 video codec +--vp9 // (bool) use VP9 video codec +--h264 // (bool) use H264 video codec +--opus // (bool) use Opus audio codec +--g722 // (bool) use G722 audio codec +--pcmu // (bool) use PCMU audio codec +--pcma // (bool) use PCMA audio codec +--nat1to1 // ([]string) sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used +--icelite // (bool) configures whether or not the ice agent should be a lite agent +--iceserver "stun:stun.l.google.com:19302" // ([]string) describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer +--password "neko" // (string) password for connecting to stream +--password_admin "admin" // (string) admin password for connecting to stream ``` Config can be set via environment variables with the prefix `NEKO_` (I.E. NEKO_BIND="127.0.0.1:8080")