You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

config.js 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639
  1. /* eslint-disable no-unused-vars, no-var */
  2. var config = {
  3. // Connection
  4. //
  5. hosts: {
  6. // XMPP domain.
  7. domain: 'jitsi-meet.example.com',
  8. // When using authentication, domain for guest users.
  9. // anonymousdomain: 'guest.example.com',
  10. // Domain for authenticated users. Defaults to <domain>.
  11. // authdomain: 'jitsi-meet.example.com',
  12. // Jirecon recording component domain.
  13. // jirecon: 'jirecon.jitsi-meet.example.com',
  14. // Call control component (Jigasi).
  15. // call_control: 'callcontrol.jitsi-meet.example.com',
  16. // Focus component domain. Defaults to focus.<domain>.
  17. // focus: 'focus.jitsi-meet.example.com',
  18. // XMPP MUC domain. FIXME: use XEP-0030 to discover it.
  19. muc: 'conference.jitsi-meet.example.com'
  20. },
  21. // BOSH URL. FIXME: use XEP-0156 to discover it.
  22. bosh: '//jitsi-meet.example.com/http-bind',
  23. // Websocket URL
  24. // websocket: 'wss://jitsi-meet.example.com/xmpp-websocket',
  25. // The name of client node advertised in XEP-0115 'c' stanza
  26. clientNode: 'http://jitsi.org/jitsimeet',
  27. // The real JID of focus participant - can be overridden here
  28. // Do not change username - FIXME: Make focus username configurable
  29. // https://github.com/jitsi/jitsi-meet/issues/7376
  30. // focusUserJid: 'focus@auth.jitsi-meet.example.com',
  31. // Testing / experimental features.
  32. //
  33. testing: {
  34. // Disables the End to End Encryption feature. Useful for debugging
  35. // issues related to insertable streams.
  36. // disableE2EE: false,
  37. // P2P test mode disables automatic switching to P2P when there are 2
  38. // participants in the conference.
  39. p2pTestMode: false
  40. // Enables the test specific features consumed by jitsi-meet-torture
  41. // testMode: false
  42. // Disables the auto-play behavior of *all* newly created video element.
  43. // This is useful when the client runs on a host with limited resources.
  44. // noAutoPlayVideo: false
  45. // Enable / disable 500 Kbps bitrate cap on desktop tracks. When enabled,
  46. // simulcast is turned off for the desktop share. If presenter is turned
  47. // on while screensharing is in progress, the max bitrate is automatically
  48. // adjusted to 2.5 Mbps. This takes a value between 0 and 1 which determines
  49. // the probability for this to be enabled.
  50. // capScreenshareBitrate: 1 // 0 to disable
  51. },
  52. // Disables ICE/UDP by filtering out local and remote UDP candidates in
  53. // signalling.
  54. // webrtcIceUdpDisable: false,
  55. // Disables ICE/TCP by filtering out local and remote TCP candidates in
  56. // signalling.
  57. // webrtcIceTcpDisable: false,
  58. // Media
  59. //
  60. // Audio
  61. // Disable measuring of audio levels.
  62. // disableAudioLevels: false,
  63. // audioLevelsInterval: 200,
  64. // Enabling this will run the lib-jitsi-meet no audio detection module which
  65. // will notify the user if the current selected microphone has no audio
  66. // input and will suggest another valid device if one is present.
  67. enableNoAudioDetection: true,
  68. // Enabling this will run the lib-jitsi-meet noise detection module which will
  69. // notify the user if there is noise, other than voice, coming from the current
  70. // selected microphone. The purpose it to let the user know that the input could
  71. // be potentially unpleasant for other meeting participants.
  72. enableNoisyMicDetection: true,
  73. // Start the conference in audio only mode (no video is being received nor
  74. // sent).
  75. // startAudioOnly: false,
  76. // Every participant after the Nth will start audio muted.
  77. // startAudioMuted: 10,
  78. // Start calls with audio muted. Unlike the option above, this one is only
  79. // applied locally. FIXME: having these 2 options is confusing.
  80. // startWithAudioMuted: false,
  81. // Enabling it (with #params) will disable local audio output of remote
  82. // participants and to enable it back a reload is needed.
  83. // startSilent: false
  84. // Sets the preferred target bitrate for the Opus audio codec by setting its
  85. // 'maxaveragebitrate' parameter. Currently not available in p2p mode.
  86. // Valid values are in the range 6000 to 510000
  87. // opusMaxAverageBitrate: 20000,
  88. // Video
  89. // Sets the preferred resolution (height) for local video. Defaults to 720.
  90. // resolution: 720,
  91. // How many participants while in the tile view mode, before the receiving video quality is reduced from HD to SD.
  92. // Use -1 to disable.
  93. // maxFullResolutionParticipants: 2
  94. // w3c spec-compliant video constraints to use for video capture. Currently
  95. // used by browsers that return true from lib-jitsi-meet's
  96. // util#browser#usesNewGumFlow. The constraints are independent from
  97. // this config's resolution value. Defaults to requesting an ideal
  98. // resolution of 720p.
  99. // constraints: {
  100. // video: {
  101. // height: {
  102. // ideal: 720,
  103. // max: 720,
  104. // min: 240
  105. // }
  106. // }
  107. // },
  108. // Enable / disable simulcast support.
  109. // disableSimulcast: false,
  110. // Enable / disable layer suspension. If enabled, endpoints whose HD
  111. // layers are not in use will be suspended (no longer sent) until they
  112. // are requested again.
  113. // enableLayerSuspension: false,
  114. // Every participant after the Nth will start video muted.
  115. // startVideoMuted: 10,
  116. // Start calls with video muted. Unlike the option above, this one is only
  117. // applied locally. FIXME: having these 2 options is confusing.
  118. // startWithVideoMuted: false,
  119. // If set to true, prefer to use the H.264 video codec (if supported).
  120. // Note that it's not recommended to do this because simulcast is not
  121. // supported when using H.264. For 1-to-1 calls this setting is enabled by
  122. // default and can be toggled in the p2p section.
  123. // preferH264: true,
  124. // If set to true, disable H.264 video codec by stripping it out of the
  125. // SDP.
  126. // disableH264: false,
  127. // Desktop sharing
  128. // Optional desktop sharing frame rate options. Default value: min:5, max:5.
  129. // desktopSharingFrameRate: {
  130. // min: 5,
  131. // max: 5
  132. // },
  133. // Try to start calls with screen-sharing instead of camera video.
  134. // startScreenSharing: false,
  135. // Recording
  136. // Whether to enable file recording or not.
  137. // fileRecordingsEnabled: false,
  138. // Enable the dropbox integration.
  139. // dropbox: {
  140. // appKey: '<APP_KEY>' // Specify your app key here.
  141. // // A URL to redirect the user to, after authenticating
  142. // // by default uses:
  143. // // 'https://jitsi-meet.example.com/static/oauth.html'
  144. // redirectURI:
  145. // 'https://jitsi-meet.example.com/subfolder/static/oauth.html'
  146. // },
  147. // When integrations like dropbox are enabled only that will be shown,
  148. // by enabling fileRecordingsServiceEnabled, we show both the integrations
  149. // and the generic recording service (its configuration and storage type
  150. // depends on jibri configuration)
  151. // fileRecordingsServiceEnabled: false,
  152. // Whether to show the possibility to share file recording with other people
  153. // (e.g. meeting participants), based on the actual implementation
  154. // on the backend.
  155. // fileRecordingsServiceSharingEnabled: false,
  156. // Whether to enable live streaming or not.
  157. // liveStreamingEnabled: false,
  158. // Transcription (in interface_config,
  159. // subtitles and buttons can be configured)
  160. // transcribingEnabled: false,
  161. // Enables automatic turning on captions when recording is started
  162. // autoCaptionOnRecord: false,
  163. // Misc
  164. // Default value for the channel "last N" attribute. -1 for unlimited.
  165. channelLastN: -1,
  166. // Provides a way to use different "last N" values based on the number of participants in the conference.
  167. // The keys in an Object represent number of participants and the values are "last N" to be used when number of
  168. // participants gets to or above the number.
  169. //
  170. // For the given example mapping, "last N" will be set to 20 as long as there are at least 5, but less than
  171. // 29 participants in the call and it will be lowered to 15 when the 30th participant joins. The 'channelLastN'
  172. // will be used as default until the first threshold is reached.
  173. //
  174. // lastNLimits: {
  175. // 5: 20,
  176. // 30: 15,
  177. // 50: 10,
  178. // 70: 5,
  179. // 90: 2
  180. // },
  181. // Specify the settings for video quality optimizations on the client.
  182. // videoQuality: {
  183. //
  184. // // Provides a way to configure the maximum bitrates that will be enforced on the simulcast streams for
  185. // // video tracks. The keys in the object represent the type of the stream (LD, SD or HD) and the values
  186. // // are the max.bitrates to be set on that particular type of stream. The actual send may vary based on
  187. // // the available bandwidth calculated by the browser, but it will be capped by the values specified here.
  188. // // This is currently not implemented on app based clients on mobile.
  189. // maxBitratesVideo: {
  190. // low: 200000,
  191. // standard: 500000,
  192. // high: 1500000
  193. // }
  194. // },
  195. // // Options for the recording limit notification.
  196. // recordingLimit: {
  197. //
  198. // // The recording limit in minutes. Note: This number appears in the notification text
  199. // // but doesn't enforce the actual recording time limit. This should be configured in
  200. // // jibri!
  201. // limit: 60,
  202. //
  203. // // The name of the app with unlimited recordings.
  204. // appName: 'Unlimited recordings APP',
  205. //
  206. // // The URL of the app with unlimited recordings.
  207. // appURL: 'https://unlimited.recordings.app.com/'
  208. // },
  209. // Disables or enables RTX (RFC 4588) (defaults to false).
  210. // disableRtx: false,
  211. // Disables or enables TCC (the default is in Jicofo and set to true)
  212. // (draft-holmer-rmcat-transport-wide-cc-extensions-01). This setting
  213. // affects congestion control, it practically enables send-side bandwidth
  214. // estimations.
  215. // enableTcc: true,
  216. // Disables or enables REMB (the default is in Jicofo and set to false)
  217. // (draft-alvestrand-rmcat-remb-03). This setting affects congestion
  218. // control, it practically enables recv-side bandwidth estimations. When
  219. // both TCC and REMB are enabled, TCC takes precedence. When both are
  220. // disabled, then bandwidth estimations are disabled.
  221. // enableRemb: false,
  222. // Enables ICE restart logic in LJM and displays the page reload overlay on
  223. // ICE failure. Current disabled by default because it's causing issues with
  224. // signaling when Octo is enabled. Also when we do an "ICE restart"(which is
  225. // not a real ICE restart), the client maintains the TCC sequence number
  226. // counter, but the bridge resets it. The bridge sends media packets with
  227. // TCC sequence numbers starting from 0.
  228. // enableIceRestart: false,
  229. // Defines the minimum number of participants to start a call (the default
  230. // is set in Jicofo and set to 2).
  231. // minParticipants: 2,
  232. // Use the TURN servers discovered via XEP-0215 for the jitsi-videobridge
  233. // connection
  234. // useStunTurn: true,
  235. // Use TURN/UDP servers for the jitsi-videobridge connection (by default
  236. // we filter out TURN/UDP because it is usually not needed since the
  237. // bridge itself is reachable via UDP)
  238. // useTurnUdp: false
  239. // Enables / disables a data communication channel with the Videobridge.
  240. // Values can be 'datachannel', 'websocket', true (treat it as
  241. // 'datachannel'), undefined (treat it as 'datachannel') and false (don't
  242. // open any channel).
  243. // openBridgeChannel: true,
  244. // UI
  245. //
  246. // Require users to always specify a display name.
  247. // requireDisplayName: true,
  248. // Whether to use a welcome page or not. In case it's false a random room
  249. // will be joined when no room is specified.
  250. enableWelcomePage: true,
  251. // Enabling the close page will ignore the welcome page redirection when
  252. // a call is hangup.
  253. // enableClosePage: false,
  254. // Disable hiding of remote thumbnails when in a 1-on-1 conference call.
  255. // disable1On1Mode: false,
  256. // Default language for the user interface.
  257. // defaultLanguage: 'en',
  258. // If true all users without a token will be considered guests and all users
  259. // with token will be considered non-guests. Only guests will be allowed to
  260. // edit their profile.
  261. enableUserRolesBasedOnToken: false,
  262. // Whether or not some features are checked based on token.
  263. // enableFeaturesBasedOnToken: false,
  264. // Enable lock room for all moderators, even when userRolesBasedOnToken is enabled and participants are guests.
  265. // lockRoomGuestEnabled: false,
  266. // When enabled the password used for locking a room is restricted to up to the number of digits specified
  267. // roomPasswordNumberOfDigits: 10,
  268. // default: roomPasswordNumberOfDigits: false,
  269. // Message to show the users. Example: 'The service will be down for
  270. // maintenance at 01:00 AM GMT,
  271. // noticeMessage: '',
  272. // Enables calendar integration, depends on googleApiApplicationClientID
  273. // and microsoftApiApplicationClientID
  274. // enableCalendarIntegration: false,
  275. // When 'true', it shows an intermediate page before joining, where the user can configure their devices.
  276. // prejoinPageEnabled: false,
  277. // If true, shows the unsafe room name warning label when a room name is
  278. // deemed unsafe (due to the simplicity in the name) and a password is not
  279. // set or the lobby is not enabled.
  280. // enableInsecureRoomNameWarning: false,
  281. // Stats
  282. //
  283. // Whether to enable stats collection or not in the TraceablePeerConnection.
  284. // This can be useful for debugging purposes (post-processing/analysis of
  285. // the webrtc stats) as it is done in the jitsi-meet-torture bandwidth
  286. // estimation tests.
  287. // gatherStats: false,
  288. // The interval at which PeerConnection.getStats() is called. Defaults to 10000
  289. // pcStatsInterval: 10000,
  290. // To enable sending statistics to callstats.io you must provide the
  291. // Application ID and Secret.
  292. // callStatsID: '',
  293. // callStatsSecret: '',
  294. // Enables sending participants' display names to callstats
  295. // enableDisplayNameInStats: false,
  296. // Enables sending participants' emails (if available) to callstats and other analytics
  297. // enableEmailInStats: false,
  298. // Privacy
  299. //
  300. // If third party requests are disabled, no other server will be contacted.
  301. // This means avatars will be locally generated and callstats integration
  302. // will not function.
  303. // disableThirdPartyRequests: false,
  304. // Peer-To-Peer mode: used (if enabled) when there are just 2 participants.
  305. //
  306. p2p: {
  307. // Enables peer to peer mode. When enabled the system will try to
  308. // establish a direct connection when there are exactly 2 participants
  309. // in the room. If that succeeds the conference will stop sending data
  310. // through the JVB and use the peer to peer connection instead. When a
  311. // 3rd participant joins the conference will be moved back to the JVB
  312. // connection.
  313. enabled: true,
  314. // Use XEP-0215 to fetch STUN and TURN servers.
  315. // useStunTurn: true,
  316. // The STUN servers that will be used in the peer to peer connections
  317. stunServers: [
  318. // { urls: 'stun:jitsi-meet.example.com:3478' },
  319. { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' }
  320. ]
  321. // Sets the ICE transport policy for the p2p connection. At the time
  322. // of this writing the list of possible values are 'all' and 'relay',
  323. // but that is subject to change in the future. The enum is defined in
  324. // the WebRTC standard:
  325. // https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum.
  326. // If not set, the effective value is 'all'.
  327. // iceTransportPolicy: 'all',
  328. // If set to true, it will prefer to use H.264 for P2P calls (if H.264
  329. // is supported).
  330. // preferH264: true
  331. // If set to true, disable H.264 video codec by stripping it out of the
  332. // SDP.
  333. // disableH264: false,
  334. // How long we're going to wait, before going back to P2P after the 3rd
  335. // participant has left the conference (to filter out page reload).
  336. // backToP2PDelay: 5
  337. },
  338. analytics: {
  339. // The Google Analytics Tracking ID:
  340. // googleAnalyticsTrackingId: 'your-tracking-id-UA-123456-1'
  341. // Matomo configuration:
  342. // matomoEndpoint: 'https://your-matomo-endpoint/',
  343. // matomoSiteID: '42',
  344. // The Amplitude APP Key:
  345. // amplitudeAPPKey: '<APP_KEY>'
  346. // Configuration for the rtcstats server:
  347. // In order to enable rtcstats one needs to provide a endpoint url.
  348. // rtcstatsEndpoint: wss://rtcstats-server-pilot.jitsi.net/,
  349. // The interval at which rtcstats will poll getStats, defaults to 1000ms.
  350. // If the value is set to 0 getStats won't be polled and the rtcstats client
  351. // will only send data related to RTCPeerConnection events.
  352. // rtcstatsPolIInterval: 1000
  353. // Array of script URLs to load as lib-jitsi-meet "analytics handlers".
  354. // scriptURLs: [
  355. // "libs/analytics-ga.min.js", // google-analytics
  356. // "https://example.com/my-custom-analytics.js"
  357. // ],
  358. },
  359. // Information about the jitsi-meet instance we are connecting to, including
  360. // the user region as seen by the server.
  361. deploymentInfo: {
  362. // shard: "shard1",
  363. // region: "europe",
  364. // userRegion: "asia"
  365. },
  366. // Decides whether the start/stop recording audio notifications should play on record.
  367. // disableRecordAudioNotification: false,
  368. // Information for the chrome extension banner
  369. // chromeExtensionBanner: {
  370. // // The chrome extension to be installed address
  371. // url: 'https://chrome.google.com/webstore/detail/jitsi-meetings/kglhbbefdnlheedjiejgomgmfplipfeb',
  372. // // Extensions info which allows checking if they are installed or not
  373. // chromeExtensionsInfo: [
  374. // {
  375. // id: 'kglhbbefdnlheedjiejgomgmfplipfeb',
  376. // path: 'jitsi-logo-48x48.png'
  377. // }
  378. // ]
  379. // },
  380. // Local Recording
  381. //
  382. // localRecording: {
  383. // Enables local recording.
  384. // Additionally, 'localrecording' (all lowercase) needs to be added to
  385. // TOOLBAR_BUTTONS in interface_config.js for the Local Recording
  386. // button to show up on the toolbar.
  387. //
  388. // enabled: true,
  389. //
  390. // The recording format, can be one of 'ogg', 'flac' or 'wav'.
  391. // format: 'flac'
  392. //
  393. // },
  394. // Options related to end-to-end (participant to participant) ping.
  395. // e2eping: {
  396. // // The interval in milliseconds at which pings will be sent.
  397. // // Defaults to 10000, set to <= 0 to disable.
  398. // pingInterval: 10000,
  399. //
  400. // // The interval in milliseconds at which analytics events
  401. // // with the measured RTT will be sent. Defaults to 60000, set
  402. // // to <= 0 to disable.
  403. // analyticsInterval: 60000,
  404. // },
  405. // If set, will attempt to use the provided video input device label when
  406. // triggering a screenshare, instead of proceeding through the normal flow
  407. // for obtaining a desktop stream.
  408. // NOTE: This option is experimental and is currently intended for internal
  409. // use only.
  410. // _desktopSharingSourceDevice: 'sample-id-or-label',
  411. // If true, any checks to handoff to another application will be prevented
  412. // and instead the app will continue to display in the current browser.
  413. // disableDeepLinking: false,
  414. // A property to disable the right click context menu for localVideo
  415. // the menu has option to flip the locally seen video for local presentations
  416. // disableLocalVideoFlip: false,
  417. // Mainly privacy related settings
  418. // Disables all invite functions from the app (share, invite, dial out...etc)
  419. // disableInviteFunctions: true,
  420. // Disables storing the room name to the recents list
  421. // doNotStoreRoom: true,
  422. // Deployment specific URLs.
  423. // deploymentUrls: {
  424. // // If specified a 'Help' button will be displayed in the overflow menu with a link to the specified URL for
  425. // // user documentation.
  426. // userDocumentationURL: 'https://docs.example.com/video-meetings.html',
  427. // // If specified a 'Download our apps' button will be displayed in the overflow menu with a link
  428. // // to the specified URL for an app download page.
  429. // downloadAppsUrl: 'https://docs.example.com/our-apps.html'
  430. // },
  431. // Options related to the remote participant menu.
  432. // remoteVideoMenu: {
  433. // // If set to true the 'Kick out' button will be disabled.
  434. // disableKick: true
  435. // },
  436. // If set to true all muting operations of remote participants will be disabled.
  437. // disableRemoteMute: true,
  438. /**
  439. External API url used to receive branding specific information.
  440. If there is no url set or there are missing fields, the defaults are applied.
  441. None of the fields are mandatory and the response must have the shape:
  442. {
  443. // The hex value for the colour used as background
  444. backgroundColor: '#fff',
  445. // The url for the image used as background
  446. backgroundImageUrl: 'https://example.com/background-img.png',
  447. // The anchor url used when clicking the logo image
  448. logoClickUrl: 'https://example-company.org',
  449. // The url used for the image used as logo
  450. logoImageUrl: 'https://example.com/logo-img.png'
  451. }
  452. */
  453. // brandingDataUrl: '',
  454. // The URL of the moderated rooms microservice, if available. If it
  455. // is present, a link to the service will be rendered on the welcome page,
  456. // otherwise the app doesn't render it.
  457. // moderatedRoomServiceUrl: 'https://moderated.jitsi-meet.example.com',
  458. // List of undocumented settings used in jitsi-meet
  459. /**
  460. _immediateReloadThreshold
  461. autoRecord
  462. autoRecordToken
  463. debug
  464. debugAudioLevels
  465. deploymentInfo
  466. dialInConfCodeUrl
  467. dialInNumbersUrl
  468. dialOutAuthUrl
  469. dialOutCodesUrl
  470. disableRemoteControl
  471. displayJids
  472. etherpad_base
  473. externalConnectUrl
  474. firefox_fake_device
  475. googleApiApplicationClientID
  476. iAmRecorder
  477. iAmSipGateway
  478. microsoftApiApplicationClientID
  479. peopleSearchQueryTypes
  480. peopleSearchUrl
  481. requireDisplayName
  482. tokenAuthUrl
  483. */
  484. // List of undocumented settings used in lib-jitsi-meet
  485. /**
  486. _peerConnStatusOutOfLastNTimeout
  487. _peerConnStatusRtcMuteTimeout
  488. abTesting
  489. avgRtpStatsN
  490. callStatsConfIDNamespace
  491. callStatsCustomScriptUrl
  492. desktopSharingSources
  493. disableAEC
  494. disableAGC
  495. disableAP
  496. disableHPF
  497. disableNS
  498. enableLipSync
  499. enableTalkWhileMuted
  500. forceJVB121Ratio
  501. hiddenDomain
  502. ignoreStartMuted
  503. nick
  504. startBitrate
  505. */
  506. // Allow all above example options to include a trailing comma and
  507. // prevent fear when commenting out the last value.
  508. makeJsonParserHappy: 'even if last key had a trailing comma'
  509. // no configuration value should follow this line.
  510. };
  511. /* eslint-enable no-unused-vars, no-var */