mirror of
https://github.com/m1k1o/neko.git
synced 2025-08-06 10:20:26 +02:00
docs: add missing filetransfer config to v2.
This commit is contained in:
Miroslav Šedivý
parent
3a8a5c30ef
commit
972d16031e
3 changed files with 120 additions and 101 deletions
|
|
@ -15,6 +15,102 @@
|
||||||
"defaultValue": "false",
|
"defaultValue": "false",
|
||||||
"description": "save logs to file"
|
"description": "save logs to file"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"cert"
|
||||||
|
],
|
||||||
|
"type": "string",
|
||||||
|
"description": "path to the SSL cert used to secure the neko server"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"key"
|
||||||
|
],
|
||||||
|
"type": "string",
|
||||||
|
"description": "path to the SSL key used to secure the neko server"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"bind"
|
||||||
|
],
|
||||||
|
"type": "string",
|
||||||
|
"description": "address/port/socket to serve neko"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"proxy"
|
||||||
|
],
|
||||||
|
"type": "boolean",
|
||||||
|
"defaultValue": "false",
|
||||||
|
"description": "enable reverse proxy mode"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"static"
|
||||||
|
],
|
||||||
|
"type": "string",
|
||||||
|
"description": "path to neko client files to serve"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"path_prefix"
|
||||||
|
],
|
||||||
|
"type": "string",
|
||||||
|
"description": "path prefix for HTTP requests"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"cors"
|
||||||
|
],
|
||||||
|
"type": "strings",
|
||||||
|
"description": "list of allowed origins for CORS"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"locks"
|
||||||
|
],
|
||||||
|
"type": "strings",
|
||||||
|
"description": "resources, that will be locked when starting (control, login)"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"implicit_control"
|
||||||
|
],
|
||||||
|
"type": "boolean",
|
||||||
|
"defaultValue": "false",
|
||||||
|
"description": "if enabled members can gain control implicitly"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"control_protection"
|
||||||
|
],
|
||||||
|
"type": "boolean",
|
||||||
|
"defaultValue": "false",
|
||||||
|
"description": "control protection means, users can gain control only if at least one admin is in the room"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"heartbeat_interval"
|
||||||
|
],
|
||||||
|
"type": "int",
|
||||||
|
"defaultValue": "120",
|
||||||
|
"description": "heartbeat interval in seconds"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"file_transfer_enabled"
|
||||||
|
],
|
||||||
|
"type": "boolean",
|
||||||
|
"defaultValue": "false",
|
||||||
|
"description": "enable file transfer feature"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": [
|
||||||
|
"file_transfer_path"
|
||||||
|
],
|
||||||
|
"type": "string",
|
||||||
|
"description": "path to use for file transfer"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"key": [
|
"key": [
|
||||||
"display"
|
"display"
|
||||||
|
|
@ -192,93 +288,12 @@
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "admin password for connecting to stream"
|
"description": "admin password for connecting to stream"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"cert"
|
|
||||||
],
|
|
||||||
"type": "string",
|
|
||||||
"description": "path to the SSL cert used to secure the neko server"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"key"
|
|
||||||
],
|
|
||||||
"type": "string",
|
|
||||||
"description": "path to the SSL key used to secure the neko server"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"bind"
|
|
||||||
],
|
|
||||||
"type": "string",
|
|
||||||
"description": "address/port/socket to serve neko"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"proxy"
|
|
||||||
],
|
|
||||||
"type": "boolean",
|
|
||||||
"defaultValue": "false",
|
|
||||||
"description": "enable reverse proxy mode"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"static"
|
|
||||||
],
|
|
||||||
"type": "string",
|
|
||||||
"description": "path to neko client files to serve"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"path_prefix"
|
|
||||||
],
|
|
||||||
"type": "string",
|
|
||||||
"description": "path prefix for HTTP requests"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"cors"
|
|
||||||
],
|
|
||||||
"type": "strings",
|
|
||||||
"description": "list of allowed origins for CORS"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"locks"
|
|
||||||
],
|
|
||||||
"type": "strings",
|
|
||||||
"description": "resources, that will be locked when starting (control, login)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"implicit_control"
|
|
||||||
],
|
|
||||||
"type": "boolean",
|
|
||||||
"defaultValue": "false",
|
|
||||||
"description": "if enabled members can gain control implicitly"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"control_protection"
|
|
||||||
],
|
|
||||||
"type": "boolean",
|
|
||||||
"defaultValue": "false",
|
|
||||||
"description": "control protection means, users can gain control only if at least one admin is in the room"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": [
|
|
||||||
"heartbeat_interval"
|
|
||||||
],
|
|
||||||
"type": "int",
|
|
||||||
"defaultValue": "120",
|
|
||||||
"description": "heartbeat interval in seconds"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"key": [
|
"key": [
|
||||||
"nat1to1"
|
"nat1to1"
|
||||||
],
|
],
|
||||||
"type": "strings",
|
"type": "strings",
|
||||||
"description": "sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP "
|
"description": "sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"key": [
|
"key": [
|
||||||
|
|
@ -307,14 +322,14 @@
|
||||||
"iceserver"
|
"iceserver"
|
||||||
],
|
],
|
||||||
"type": "strings",
|
"type": "strings",
|
||||||
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection "
|
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"key": [
|
"key": [
|
||||||
"iceservers"
|
"iceservers"
|
||||||
],
|
],
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection "
|
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"key": [
|
"key": [
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,22 @@
|
||||||
|
|
||||||
--legacy enable legacy mode (default true)
|
--legacy enable legacy mode (default true)
|
||||||
|
|
||||||
--logs save logs to file
|
--logs save logs to file
|
||||||
|
|
||||||
|
--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
|
||||||
|
--bind string address/port/socket to serve neko
|
||||||
|
--proxy enable reverse proxy mode
|
||||||
|
--static string path to neko client files to serve
|
||||||
|
--path_prefix string path prefix for HTTP requests
|
||||||
|
--cors strings list of allowed origins for CORS
|
||||||
|
--locks strings resources, that will be locked when starting (control, login)
|
||||||
|
--implicit_control if enabled members can gain control implicitly
|
||||||
|
--control_protection control protection means, users can gain control only if at least one admin is in the room
|
||||||
|
--heartbeat_interval int heartbeat interval in seconds (default 120)
|
||||||
|
--file_transfer_enabled enable file transfer feature
|
||||||
|
--file_transfer_path string path to use for file transfer
|
||||||
|
|
||||||
--display string XDisplay to capture
|
--display string XDisplay to capture
|
||||||
--video_codec string video codec to be used
|
--video_codec string video codec to be used
|
||||||
--av1 DEPRECATED: use video_codec
|
--av1 DEPRECATED: use video_codec
|
||||||
|
|
@ -12,6 +27,7 @@
|
||||||
--video_bitrate int video bitrate in kbit/s
|
--video_bitrate int video bitrate in kbit/s
|
||||||
--hwenc string use hardware accelerated encoding
|
--hwenc string use hardware accelerated encoding
|
||||||
--max_fps int maximum fps delivered via WebRTC, 0 is for no maximum
|
--max_fps int maximum fps delivered via WebRTC, 0 is for no maximum
|
||||||
|
|
||||||
--device string audio device to capture
|
--device string audio device to capture
|
||||||
--audio_codec string audio codec to be used
|
--audio_codec string audio codec to be used
|
||||||
--g722 DEPRECATED: use audio_codec
|
--g722 DEPRECATED: use audio_codec
|
||||||
|
|
@ -20,6 +36,7 @@
|
||||||
--pcmu DEPRECATED: use audio_codec
|
--pcmu DEPRECATED: use audio_codec
|
||||||
--audio string audio codec parameters to use for streaming
|
--audio string audio codec parameters to use for streaming
|
||||||
--audio_bitrate int audio bitrate in kbit/s
|
--audio_bitrate int audio bitrate in kbit/s
|
||||||
|
|
||||||
--broadcast_pipeline string custom gst pipeline used for broadcasting, strings {url} {device} {display} will be replaced
|
--broadcast_pipeline string custom gst pipeline used for broadcasting, strings {url} {device} {display} will be replaced
|
||||||
--broadcast_url string a default default URL for broadcast streams, can be disabled/changed later by admins in the GUI
|
--broadcast_url string a default default URL for broadcast streams, can be disabled/changed later by admins in the GUI
|
||||||
--broadcast_autostart automatically start broadcasting when neko starts and broadcast_url is set
|
--broadcast_autostart automatically start broadcasting when neko starts and broadcast_url is set
|
||||||
|
|
@ -29,24 +46,11 @@
|
||||||
--password string password for connecting to stream
|
--password string password for connecting to stream
|
||||||
--password_admin string admin password for connecting to stream
|
--password_admin string admin password for connecting to stream
|
||||||
|
|
||||||
--cert string path to the SSL cert used to secure the neko server
|
--nat1to1 strings sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used
|
||||||
--key string path to the SSL key used to secure the neko server
|
|
||||||
--bind string address/port/socket to serve neko
|
|
||||||
--proxy enable reverse proxy mode
|
|
||||||
--static string path to neko client files to serve
|
|
||||||
--path_prefix string path prefix for HTTP requests
|
|
||||||
--cors strings list of allowed origins for CORS
|
|
||||||
|
|
||||||
--locks strings resources, that will be locked when starting (control, login)
|
|
||||||
--implicit_control if enabled members can gain control implicitly
|
|
||||||
--control_protection control protection means, users can gain control only if at least one admin is in the room
|
|
||||||
--heartbeat_interval int heartbeat interval in seconds (default 120)
|
|
||||||
|
|
||||||
--nat1to1 strings sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP
|
|
||||||
--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
|
||||||
--icelite configures whether or not the ice agent should be a lite agent
|
--icelite configures whether or not the ice agent should be a lite agent
|
||||||
--iceserver strings describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection
|
--iceserver strings describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer
|
||||||
--iceservers string describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection
|
--iceservers string describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer
|
||||||
--ipfetch string automatically fetch IP address from given URL when nat1to1 is not present
|
--ipfetch string automatically fetch IP address from given URL when nat1to1 is not present
|
||||||
--epr string limits the pool of ephemeral ports that ICE UDP connections can allocate from
|
--epr string limits the pool of ephemeral ports that ICE UDP connections can allocate from
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@
|
||||||
"clear": "docusaurus clear",
|
"clear": "docusaurus clear",
|
||||||
"serve": "docusaurus serve",
|
"serve": "docusaurus serve",
|
||||||
"gen-config": "node ./src/components/Configuration/generate.js ./docs/configuration/help.txt ./docs/configuration/help.json",
|
"gen-config": "node ./src/components/Configuration/generate.js ./docs/configuration/help.txt ./docs/configuration/help.json",
|
||||||
"gen-config:v2": "node ./src/components/Configuration/generate.js ./docs/v2-migration/help.txt ./docs/v2-migration/help.json",
|
"gen-config:v2": "node ./src/components/Configuration/generate.js ./docs/migration-from-v2/help.txt ./docs/migration-from-v2/help.json",
|
||||||
"write-translations": "docusaurus write-translations",
|
"write-translations": "docusaurus write-translations",
|
||||||
"write-heading-ids": "docusaurus write-heading-ids",
|
"write-heading-ids": "docusaurus write-heading-ids",
|
||||||
"gen-api-docs": "./gen-api-docs.sh",
|
"gen-api-docs": "./gen-api-docs.sh",
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue