From 42ee7477a017c9700bfbca487fe5c393175e99c6 Mon Sep 17 00:00:00 2001 From: William Harrell Date: Wed, 16 Nov 2022 22:30:50 -0500 Subject: [PATCH] updated configuration --- docs/getting-started/configuration.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index 8026d0c..26a8db2 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -126,6 +126,19 @@ nat1to1: - Path prefix for HTTP requests. - e.g. `/neko/` +### File Transfer + +#### `NEKO_FILE_TRANSFER`: + - Enable file transfer for admins at start + - e.g. `1` +#### `NEKO_UNPRIV_FILE_TRANSFER`: + - Enable file transfer for all users at start. Ignored if NEKO_FILE_TRANSFER not enabled. + - e.g. `1` +#### `NEKO_FILE_TRANSFER_PATH`: + - Path where files will be transferred between the host and users. By default this is + /home/neko/Downloads. If the path doesn't exist, it will be created. + - e.g. `/home/neko/Desktop` + ### Expert settings #### `NEKO_DISPLAY`: @@ -155,6 +168,8 @@ Flags: --device string audio device to capture (default "auto_null.monitor") --display string XDisplay to capture (default ":99.0") --epr string limits the pool of ephemeral ports that ICE UDP connections can allocate from (default "59000-59100") + --file_transfer allow file transfer for admins + --file_transfer_path string path to use for file transfer (default "/home/neko/Downloads") --g722 DEPRECATED: use audio_codec --h264 DEPRECATED: use video_codec -h, --help help for serve @@ -179,6 +194,7 @@ Flags: --static string path to neko client files to serve (default "./www") --tcpmux int single TCP mux port for all peers --udpmux int single UDP mux port for all peers + --unpriv_file_transfer allow file transfer for non admins --video string video codec parameters to use for streaming --video_bitrate int video bitrate in kbit/s (default 3072) --video_codec string video codec to be used (default "vp8")