iridium/neko-custom
Archived
2
0
Fork 0
Code Pull Requests Activity

updated configuration

Browse Source
This commit is contained in:
William Harrell 2022-11-16 22:30:50 -05:00
parent bbfa0d5834
commit 42ee7477a0
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/getting-started/configuration.md
View File

@ -126,6 +126,19 @@ nat1to1: <ip>
- Path prefix for HTTP requests. - Path prefix for HTTP requests.
- e.g. `/neko/` - 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 ### Expert settings
#### `NEKO_DISPLAY`: #### `NEKO_DISPLAY`:
@ -155,6 +168,8 @@ Flags:
--device string audio device to capture (default "auto_null.monitor") --device string audio device to capture (default "auto_null.monitor")
--display string XDisplay to capture (default ":99.0") --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") --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 --g722 DEPRECATED: use audio_codec
--h264 DEPRECATED: use video_codec --h264 DEPRECATED: use video_codec
-h, --help help for serve -h, --help help for serve
@ -179,6 +194,7 @@ Flags:
--static string path to neko client files to serve (default "./www") --static string path to neko client files to serve (default "./www")
--tcpmux int single TCP mux port for all peers --tcpmux int single TCP mux port for all peers
--udpmux int single UDP 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 string video codec parameters to use for streaming
--video_bitrate int video bitrate in kbit/s (default 3072) --video_bitrate int video bitrate in kbit/s (default 3072)
--video_codec string video codec to be used (default "vp8") --video_codec string video codec to be used (default "vp8")