neko/webpage/docs/migration-from-v2/help.json

[
  {
    "key": [
      "legacy"
    ],
    "type": "boolean",
    "defaultValue": "true",
    "description": "enable legacy mode"
  },
  {
    "key": [
      "logs"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "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": [
      "display"
    ],
    "type": "string",
    "description": "XDisplay to capture"
  },
  {
    "key": [
      "video_codec"
    ],
    "type": "string",
    "description": "video codec to be used"
  },
  {
    "key": [
      "av1"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use video_codec"
  },
  {
    "key": [
      "h264"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use video_codec"
  },
  {
    "key": [
      "vp8"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use video_codec"
  },
  {
    "key": [
      "vp9"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use video_codec"
  },
  {
    "key": [
      "video"
    ],
    "type": "string",
    "description": "video codec parameters to use for streaming"
  },
  {
    "key": [
      "video_bitrate"
    ],
    "type": "int",
    "description": "video bitrate in kbit/s"
  },
  {
    "key": [
      "hwenc"
    ],
    "type": "string",
    "description": "use hardware accelerated encoding"
  },
  {
    "key": [
      "max_fps"
    ],
    "type": "int",
    "description": "maximum fps delivered via WebRTC, 0 is for no maximum"
  },
  {
    "key": [
      "device"
    ],
    "type": "string",
    "description": "audio device to capture"
  },
  {
    "key": [
      "audio_codec"
    ],
    "type": "string",
    "description": "audio codec to be used"
  },
  {
    "key": [
      "g722"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use audio_codec"
  },
  {
    "key": [
      "opus"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use audio_codec"
  },
  {
    "key": [
      "pcma"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use audio_codec"
  },
  {
    "key": [
      "pcmu"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "DEPRECATED: use audio_codec"
  },
  {
    "key": [
      "audio"
    ],
    "type": "string",
    "description": "audio codec parameters to use for streaming"
  },
  {
    "key": [
      "audio_bitrate"
    ],
    "type": "int",
    "description": "audio bitrate in kbit/s"
  },
  {
    "key": [
      "broadcast_pipeline"
    ],
    "type": "string",
    "description": "custom gst pipeline used for broadcasting, strings {url} {device} {display} will be replaced"
  },
  {
    "key": [
      "broadcast_url"
    ],
    "type": "string",
    "description": "a default default URL for broadcast streams, can be disabled/changed later by admins in the GUI"
  },
  {
    "key": [
      "broadcast_autostart"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "automatically start broadcasting when neko starts and broadcast_url is set"
  },
  {
    "key": [
      "screen"
    ],
    "type": "string",
    "description": "default screen resolution and framerate"
  },
  {
    "key": [
      "password"
    ],
    "type": "string",
    "description": "password for connecting to stream"
  },
  {
    "key": [
      "password_admin"
    ],
    "type": "string",
    "description": "admin password for connecting to stream"
  },
  {
    "key": [
      "nat1to1"
    ],
    "type": "strings",
    "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": [
      "tcpmux"
    ],
    "type": "int",
    "description": "single TCP mux port for all peers"
  },
  {
    "key": [
      "udpmux"
    ],
    "type": "int",
    "description": "single UDP mux port for all peers"
  },
  {
    "key": [
      "icelite"
    ],
    "type": "boolean",
    "defaultValue": "false",
    "description": "configures whether or not the ice agent should be a lite agent"
  },
  {
    "key": [
      "iceserver"
    ],
    "type": "strings",
    "description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer"
  },
  {
    "key": [
      "iceservers"
    ],
    "type": "string",
    "description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer"
  },
  {
    "key": [
      "ipfetch"
    ],
    "type": "string",
    "description": "automatically fetch IP address from given URL when nat1to1 is not present"
  },
  {
    "key": [
      "epr"
    ],
    "type": "string",
    "description": "limits the pool of ephemeral ports that ICE UDP connections can allocate from"
  }
]