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 22KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604
  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. // w3c spec-compliant video constraints to use for video capture. Currently
  92. // used by browsers that return true from lib-jitsi-meet's
  93. // util#browser#usesNewGumFlow. The constraints are independent from
  94. // this config's resolution value. Defaults to requesting an ideal
  95. // resolution of 720p.
  96. // constraints: {
  97. // video: {
  98. // height: {
  99. // ideal: 720,
  100. // max: 720,
  101. // min: 240
  102. // }
  103. // }
  104. // },
  105. // Enable / disable simulcast support.
  106. // disableSimulcast: false,
  107. // Enable / disable layer suspension. If enabled, endpoints whose HD
  108. // layers are not in use will be suspended (no longer sent) until they
  109. // are requested again.
  110. // enableLayerSuspension: false,
  111. // Every participant after the Nth will start video muted.
  112. // startVideoMuted: 10,
  113. // Start calls with video muted. Unlike the option above, this one is only
  114. // applied locally. FIXME: having these 2 options is confusing.
  115. // startWithVideoMuted: false,
  116. // If set to true, prefer to use the H.264 video codec (if supported).
  117. // Note that it's not recommended to do this because simulcast is not
  118. // supported when using H.264. For 1-to-1 calls this setting is enabled by
  119. // default and can be toggled in the p2p section.
  120. // preferH264: true,
  121. // If set to true, disable H.264 video codec by stripping it out of the
  122. // SDP.
  123. // disableH264: false,
  124. // Desktop sharing
  125. // Optional desktop sharing frame rate options. Default value: min:5, max:5.
  126. // desktopSharingFrameRate: {
  127. // min: 5,
  128. // max: 5
  129. // },
  130. // Try to start calls with screen-sharing instead of camera video.
  131. // startScreenSharing: false,
  132. // Recording
  133. // Whether to enable file recording or not.
  134. // fileRecordingsEnabled: false,
  135. // Enable the dropbox integration.
  136. // dropbox: {
  137. // appKey: '<APP_KEY>' // Specify your app key here.
  138. // // A URL to redirect the user to, after authenticating
  139. // // by default uses:
  140. // // 'https://jitsi-meet.example.com/static/oauth.html'
  141. // redirectURI:
  142. // 'https://jitsi-meet.example.com/subfolder/static/oauth.html'
  143. // },
  144. // When integrations like dropbox are enabled only that will be shown,
  145. // by enabling fileRecordingsServiceEnabled, we show both the integrations
  146. // and the generic recording service (its configuration and storage type
  147. // depends on jibri configuration)
  148. // fileRecordingsServiceEnabled: false,
  149. // Whether to show the possibility to share file recording with other people
  150. // (e.g. meeting participants), based on the actual implementation
  151. // on the backend.
  152. // fileRecordingsServiceSharingEnabled: false,
  153. // Whether to enable live streaming or not.
  154. // liveStreamingEnabled: false,
  155. // Transcription (in interface_config,
  156. // subtitles and buttons can be configured)
  157. // transcribingEnabled: false,
  158. // Enables automatic turning on captions when recording is started
  159. // autoCaptionOnRecord: false,
  160. // Misc
  161. // Default value for the channel "last N" attribute. -1 for unlimited.
  162. channelLastN: -1,
  163. // // Options for the recording limit notification.
  164. // recordingLimit: {
  165. //
  166. // // The recording limit in minutes. Note: This number appears in the notification text
  167. // // but doesn't enforce the actual recording time limit. This should be configured in
  168. // // jibri!
  169. // limit: 60,
  170. //
  171. // // The name of the app with unlimited recordings.
  172. // appName: 'Unlimited recordings APP',
  173. //
  174. // // The URL of the app with unlimited recordings.
  175. // appURL: 'https://unlimited.recordings.app.com/'
  176. // },
  177. // Disables or enables RTX (RFC 4588) (defaults to false).
  178. // disableRtx: false,
  179. // Disables or enables TCC (the default is in Jicofo and set to true)
  180. // (draft-holmer-rmcat-transport-wide-cc-extensions-01). This setting
  181. // affects congestion control, it practically enables send-side bandwidth
  182. // estimations.
  183. // enableTcc: true,
  184. // Disables or enables REMB (the default is in Jicofo and set to false)
  185. // (draft-alvestrand-rmcat-remb-03). This setting affects congestion
  186. // control, it practically enables recv-side bandwidth estimations. When
  187. // both TCC and REMB are enabled, TCC takes precedence. When both are
  188. // disabled, then bandwidth estimations are disabled.
  189. // enableRemb: false,
  190. // Enables ICE restart logic in LJM and displays the page reload overlay on
  191. // ICE failure. Current disabled by default because it's causing issues with
  192. // signaling when Octo is enabled. Also when we do an "ICE restart"(which is
  193. // not a real ICE restart), the client maintains the TCC sequence number
  194. // counter, but the bridge resets it. The bridge sends media packets with
  195. // TCC sequence numbers starting from 0.
  196. // enableIceRestart: false,
  197. // Defines the minimum number of participants to start a call (the default
  198. // is set in Jicofo and set to 2).
  199. // minParticipants: 2,
  200. // Use the TURN servers discovered via XEP-0215 for the jitsi-videobridge
  201. // connection
  202. // useStunTurn: true,
  203. // Use TURN/UDP servers for the jitsi-videobridge connection (by default
  204. // we filter out TURN/UDP because it is usually not needed since the
  205. // bridge itself is reachable via UDP)
  206. // useTurnUdp: false
  207. // Enables / disables a data communication channel with the Videobridge.
  208. // Values can be 'datachannel', 'websocket', true (treat it as
  209. // 'datachannel'), undefined (treat it as 'datachannel') and false (don't
  210. // open any channel).
  211. // openBridgeChannel: true,
  212. // UI
  213. //
  214. // Require users to always specify a display name.
  215. // requireDisplayName: true,
  216. // Whether to use a welcome page or not. In case it's false a random room
  217. // will be joined when no room is specified.
  218. enableWelcomePage: true,
  219. // Enabling the close page will ignore the welcome page redirection when
  220. // a call is hangup.
  221. // enableClosePage: false,
  222. // Disable hiding of remote thumbnails when in a 1-on-1 conference call.
  223. // disable1On1Mode: false,
  224. // Default language for the user interface.
  225. // defaultLanguage: 'en',
  226. // If true all users without a token will be considered guests and all users
  227. // with token will be considered non-guests. Only guests will be allowed to
  228. // edit their profile.
  229. enableUserRolesBasedOnToken: false,
  230. // Whether or not some features are checked based on token.
  231. // enableFeaturesBasedOnToken: false,
  232. // Enable lock room for all moderators, even when userRolesBasedOnToken is enabled and participants are guests.
  233. // lockRoomGuestEnabled: false,
  234. // When enabled the password used for locking a room is restricted to up to the number of digits specified
  235. // roomPasswordNumberOfDigits: 10,
  236. // default: roomPasswordNumberOfDigits: false,
  237. // Message to show the users. Example: 'The service will be down for
  238. // maintenance at 01:00 AM GMT,
  239. // noticeMessage: '',
  240. // Enables calendar integration, depends on googleApiApplicationClientID
  241. // and microsoftApiApplicationClientID
  242. // enableCalendarIntegration: false,
  243. // When 'true', it shows an intermediate page before joining, where the user can configure their devices.
  244. // prejoinPageEnabled: false,
  245. // If true, shows the unsafe room name warning label when a room name is
  246. // deemed unsafe (due to the simplicity in the name) and a password is not
  247. // set or the lobby is not enabled.
  248. // enableInsecureRoomNameWarning: false,
  249. // Stats
  250. //
  251. // Whether to enable stats collection or not in the TraceablePeerConnection.
  252. // This can be useful for debugging purposes (post-processing/analysis of
  253. // the webrtc stats) as it is done in the jitsi-meet-torture bandwidth
  254. // estimation tests.
  255. // gatherStats: false,
  256. // The interval at which PeerConnection.getStats() is called. Defaults to 10000
  257. // pcStatsInterval: 10000,
  258. // To enable sending statistics to callstats.io you must provide the
  259. // Application ID and Secret.
  260. // callStatsID: '',
  261. // callStatsSecret: '',
  262. // Enables sending participants' display names to callstats
  263. // enableDisplayNameInStats: false,
  264. // Enables sending participants' emails (if available) to callstats and other analytics
  265. // enableEmailInStats: false,
  266. // Privacy
  267. //
  268. // If third party requests are disabled, no other server will be contacted.
  269. // This means avatars will be locally generated and callstats integration
  270. // will not function.
  271. // disableThirdPartyRequests: false,
  272. // Peer-To-Peer mode: used (if enabled) when there are just 2 participants.
  273. //
  274. p2p: {
  275. // Enables peer to peer mode. When enabled the system will try to
  276. // establish a direct connection when there are exactly 2 participants
  277. // in the room. If that succeeds the conference will stop sending data
  278. // through the JVB and use the peer to peer connection instead. When a
  279. // 3rd participant joins the conference will be moved back to the JVB
  280. // connection.
  281. enabled: true,
  282. // Use XEP-0215 to fetch STUN and TURN servers.
  283. // useStunTurn: true,
  284. // The STUN servers that will be used in the peer to peer connections
  285. stunServers: [
  286. // { urls: 'stun:jitsi-meet.example.com:3478' },
  287. { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' }
  288. ]
  289. // Sets the ICE transport policy for the p2p connection. At the time
  290. // of this writing the list of possible values are 'all' and 'relay',
  291. // but that is subject to change in the future. The enum is defined in
  292. // the WebRTC standard:
  293. // https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum.
  294. // If not set, the effective value is 'all'.
  295. // iceTransportPolicy: 'all',
  296. // If set to true, it will prefer to use H.264 for P2P calls (if H.264
  297. // is supported).
  298. // preferH264: true
  299. // If set to true, disable H.264 video codec by stripping it out of the
  300. // SDP.
  301. // disableH264: false,
  302. // How long we're going to wait, before going back to P2P after the 3rd
  303. // participant has left the conference (to filter out page reload).
  304. // backToP2PDelay: 5
  305. },
  306. analytics: {
  307. // The Google Analytics Tracking ID:
  308. // googleAnalyticsTrackingId: 'your-tracking-id-UA-123456-1'
  309. // Matomo configuration:
  310. // matomoEndpoint: 'https://your-matomo-endpoint/',
  311. // matomoSiteID: '42',
  312. // The Amplitude APP Key:
  313. // amplitudeAPPKey: '<APP_KEY>'
  314. // Configuration for the rtcstats server:
  315. // In order to enable rtcstats one needs to provide a endpoint url.
  316. // rtcstatsEndpoint: wss://rtcstats-server-pilot.jitsi.net/,
  317. // The interval at which rtcstats will poll getStats, defaults to 1000ms.
  318. // If the value is set to 0 getStats won't be polled and the rtcstats client
  319. // will only send data related to RTCPeerConnection events.
  320. // rtcstatsPolIInterval: 1000
  321. // Array of script URLs to load as lib-jitsi-meet "analytics handlers".
  322. // scriptURLs: [
  323. // "libs/analytics-ga.min.js", // google-analytics
  324. // "https://example.com/my-custom-analytics.js"
  325. // ],
  326. },
  327. // Information about the jitsi-meet instance we are connecting to, including
  328. // the user region as seen by the server.
  329. deploymentInfo: {
  330. // shard: "shard1",
  331. // region: "europe",
  332. // userRegion: "asia"
  333. },
  334. // Decides whether the start/stop recording audio notifications should play on record.
  335. // disableRecordAudioNotification: false,
  336. // Information for the chrome extension banner
  337. // chromeExtensionBanner: {
  338. // // The chrome extension to be installed address
  339. // url: 'https://chrome.google.com/webstore/detail/jitsi-meetings/kglhbbefdnlheedjiejgomgmfplipfeb',
  340. // // Extensions info which allows checking if they are installed or not
  341. // chromeExtensionsInfo: [
  342. // {
  343. // id: 'kglhbbefdnlheedjiejgomgmfplipfeb',
  344. // path: 'jitsi-logo-48x48.png'
  345. // }
  346. // ]
  347. // },
  348. // Local Recording
  349. //
  350. // localRecording: {
  351. // Enables local recording.
  352. // Additionally, 'localrecording' (all lowercase) needs to be added to
  353. // TOOLBAR_BUTTONS in interface_config.js for the Local Recording
  354. // button to show up on the toolbar.
  355. //
  356. // enabled: true,
  357. //
  358. // The recording format, can be one of 'ogg', 'flac' or 'wav'.
  359. // format: 'flac'
  360. //
  361. // },
  362. // Options related to end-to-end (participant to participant) ping.
  363. // e2eping: {
  364. // // The interval in milliseconds at which pings will be sent.
  365. // // Defaults to 10000, set to <= 0 to disable.
  366. // pingInterval: 10000,
  367. //
  368. // // The interval in milliseconds at which analytics events
  369. // // with the measured RTT will be sent. Defaults to 60000, set
  370. // // to <= 0 to disable.
  371. // analyticsInterval: 60000,
  372. // },
  373. // If set, will attempt to use the provided video input device label when
  374. // triggering a screenshare, instead of proceeding through the normal flow
  375. // for obtaining a desktop stream.
  376. // NOTE: This option is experimental and is currently intended for internal
  377. // use only.
  378. // _desktopSharingSourceDevice: 'sample-id-or-label',
  379. // If true, any checks to handoff to another application will be prevented
  380. // and instead the app will continue to display in the current browser.
  381. // disableDeepLinking: false,
  382. // A property to disable the right click context menu for localVideo
  383. // the menu has option to flip the locally seen video for local presentations
  384. // disableLocalVideoFlip: false,
  385. // Mainly privacy related settings
  386. // Disables all invite functions from the app (share, invite, dial out...etc)
  387. // disableInviteFunctions: true,
  388. // Disables storing the room name to the recents list
  389. // doNotStoreRoom: true,
  390. // Deployment specific URLs.
  391. // deploymentUrls: {
  392. // // If specified a 'Help' button will be displayed in the overflow menu with a link to the specified URL for
  393. // // user documentation.
  394. // userDocumentationURL: 'https://docs.example.com/video-meetings.html',
  395. // // If specified a 'Download our apps' button will be displayed in the overflow menu with a link
  396. // // to the specified URL for an app download page.
  397. // downloadAppsUrl: 'https://docs.example.com/our-apps.html'
  398. // },
  399. // Options related to the remote participant menu.
  400. // remoteVideoMenu: {
  401. // // If set to true the 'Kick out' button will be disabled.
  402. // disableKick: true
  403. // },
  404. // If set to true all muting operations of remote participants will be disabled.
  405. // disableRemoteMute: true,
  406. /**
  407. External API url used to receive branding specific information.
  408. If there is no url set or there are missing fields, the defaults are applied.
  409. None of the fields are mandatory and the response must have the shape:
  410. {
  411. // The hex value for the colour used as background
  412. backgroundColor: '#fff',
  413. // The url for the image used as background
  414. backgroundImageUrl: 'https://example.com/background-img.png',
  415. // The anchor url used when clicking the logo image
  416. logoClickUrl: 'https://example-company.org',
  417. // The url used for the image used as logo
  418. logoImageUrl: 'https://example.com/logo-img.png'
  419. }
  420. */
  421. // brandingDataUrl: '',
  422. // The URL of the moderated rooms microservice, if available. If it
  423. // is present, a link to the service will be rendered on the welcome page,
  424. // otherwise the app doesn't render it.
  425. // moderatedRoomServiceUrl: 'https://moderated.jitsi-meet.example.com',
  426. // List of undocumented settings used in jitsi-meet
  427. /**
  428. _immediateReloadThreshold
  429. autoRecord
  430. autoRecordToken
  431. debug
  432. debugAudioLevels
  433. deploymentInfo
  434. dialInConfCodeUrl
  435. dialInNumbersUrl
  436. dialOutAuthUrl
  437. dialOutCodesUrl
  438. disableRemoteControl
  439. displayJids
  440. etherpad_base
  441. externalConnectUrl
  442. firefox_fake_device
  443. googleApiApplicationClientID
  444. iAmRecorder
  445. iAmSipGateway
  446. microsoftApiApplicationClientID
  447. peopleSearchQueryTypes
  448. peopleSearchUrl
  449. requireDisplayName
  450. tokenAuthUrl
  451. */
  452. // List of undocumented settings used in lib-jitsi-meet
  453. /**
  454. _peerConnStatusOutOfLastNTimeout
  455. _peerConnStatusRtcMuteTimeout
  456. abTesting
  457. avgRtpStatsN
  458. callStatsConfIDNamespace
  459. callStatsCustomScriptUrl
  460. desktopSharingSources
  461. disableAEC
  462. disableAGC
  463. disableAP
  464. disableHPF
  465. disableNS
  466. enableLipSync
  467. enableTalkWhileMuted
  468. forceJVB121Ratio
  469. hiddenDomain
  470. ignoreStartMuted
  471. nick
  472. startBitrate
  473. */
  474. // Allow all above example options to include a trailing comma and
  475. // prevent fear when commenting out the last value.
  476. makeJsonParserHappy: 'even if last key had a trailing comma'
  477. // no configuration value should follow this line.
  478. };
  479. /* eslint-enable no-unused-vars, no-var */