settings-config.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  1. {{ $DEPLOYMENTINFO_USERREGION := .Env.DEPLOYMENTINFO_USERREGION | default "" -}}
  2. {{ $ENABLE_AUDIO_PROCESSING := .Env.ENABLE_AUDIO_PROCESSING | default "true" | toBool -}}
  3. {{ $ENABLE_BREAKOUT_ROOMS := .Env.ENABLE_BREAKOUT_ROOMS | default "true" | toBool -}}
  4. {{ $ENABLE_CALENDAR := .Env.ENABLE_CALENDAR | default "false" | toBool -}}
  5. {{ $ENABLE_FILE_RECORDING_SERVICE := .Env.ENABLE_FILE_RECORDING_SERVICE | default "false" | toBool -}}
  6. {{ $ENABLE_FILE_RECORDING_SERVICE_SHARING := .Env.ENABLE_FILE_RECORDING_SERVICE_SHARING | default "false" | toBool -}}
  7. {{ $ENABLE_IPV6 := .Env.ENABLE_IPV6 | default "true" | toBool -}}
  8. {{ $ENABLE_LIPSYNC := .Env.ENABLE_LIPSYNC | default "false" | toBool -}}
  9. {{ $ENABLE_NO_AUDIO_DETECTION := .Env.ENABLE_NO_AUDIO_DETECTION | default "true" | toBool -}}
  10. {{ $ENABLE_P2P := .Env.ENABLE_P2P | default "true" | toBool -}}
  11. {{ $ENABLE_PREJOIN_PAGE := .Env.ENABLE_PREJOIN_PAGE | default "true" | toBool -}}
  12. {{ $ENABLE_WELCOME_PAGE := .Env.ENABLE_WELCOME_PAGE | default "true" | toBool -}}
  13. {{ $ENABLE_CLOSE_PAGE := .Env.ENABLE_CLOSE_PAGE | default "false" | toBool -}}
  14. {{ $ENABLE_RECORDING := .Env.ENABLE_RECORDING | default "false" | toBool -}}
  15. {{ $ENABLE_REMB := .Env.ENABLE_REMB | default "true" | toBool -}}
  16. {{ $ENABLE_REQUIRE_DISPLAY_NAME := .Env.ENABLE_REQUIRE_DISPLAY_NAME | default "false" | toBool -}}
  17. {{ $ENABLE_SIMULCAST := .Env.ENABLE_SIMULCAST | default "true" | toBool -}}
  18. {{ $ENABLE_STATS_ID := .Env.ENABLE_STATS_ID | default "false" | toBool -}}
  19. {{ $ENABLE_STEREO := .Env.ENABLE_STEREO | default "false" | toBool -}}
  20. {{ $ENABLE_TALK_WHILE_MUTED := .Env.ENABLE_TALK_WHILE_MUTED | default "false" | toBool -}}
  21. {{ $ENABLE_TCC := .Env.ENABLE_TCC | default "true" | toBool -}}
  22. {{ $ENABLE_TRANSCRIPTIONS := .Env.ENABLE_TRANSCRIPTIONS | default "false" | toBool -}}
  23. {{ $RESOLUTION := .Env.RESOLUTION | default "720" -}}
  24. {{ $RESOLUTION_MIN := .Env.RESOLUTION_MIN | default "180" -}}
  25. {{ $RESOLUTION_WIDTH := .Env.RESOLUTION_WIDTH | default "1280" -}}
  26. {{ $RESOLUTION_WIDTH_MIN := .Env.RESOLUTION_WIDTH_MIN | default "320" -}}
  27. {{ $START_AUDIO_ONLY := .Env.START_AUDIO_ONLY | default "false" | toBool -}}
  28. {{ $START_AUDIO_MUTED := .Env.START_AUDIO_MUTED | default 10 -}}
  29. {{ $START_WITH_AUDIO_MUTED := .Env.START_WITH_AUDIO_MUTED | default "false" | toBool -}}
  30. {{ $START_SILENT := .Env.START_SILENT | default "false" | toBool -}}
  31. {{ $DISABLE_AUDIO_LEVELS := .Env.DISABLE_AUDIO_LEVELS | default "false" | toBool -}}
  32. {{ $ENABLE_NOISY_MIC_DETECTION := .Env.ENABLE_NOISY_MIC_DETECTION | default "true" | toBool -}}
  33. {{ $START_VIDEO_MUTED := .Env.START_VIDEO_MUTED | default 10 -}}
  34. {{ $START_WITH_VIDEO_MUTED := .Env.START_WITH_VIDEO_MUTED | default "false" | toBool -}}
  35. {{ $DESKTOP_SHARING_FRAMERATE_MIN := .Env.DESKTOP_SHARING_FRAMERATE_MIN | default 5 -}}
  36. {{ $DESKTOP_SHARING_FRAMERATE_MAX := .Env.DESKTOP_SHARING_FRAMERATE_MAX | default 5 -}}
  37. {{ $TESTING_OCTO_PROBABILITY := .Env.TESTING_OCTO_PROBABILITY | default "0" -}}
  38. {{ $TESTING_CAP_SCREENSHARE_BITRATE := .Env.TESTING_CAP_SCREENSHARE_BITRATE | default "1" -}}
  39. {{ $XMPP_DOMAIN := .Env.XMPP_DOMAIN -}}
  40. {{ $XMPP_RECORDER_DOMAIN := .Env.XMPP_RECORDER_DOMAIN -}}
  41. {{ $DISABLE_DEEP_LINKING := .Env.DISABLE_DEEP_LINKING | default "false" | toBool -}}
  42. {{ $VIDEOQUALITY_ENFORCE_PREFERRED_CODEC := .Env.VIDEOQUALITY_ENFORCE_PREFERRED_CODEC | default "false" | toBool -}}
  43. {{ $DISABLE_POLLS := .Env.DISABLE_POLLS | default "false" | toBool -}}
  44. {{ $DISABLE_REACTIONS := .Env.DISABLE_REACTIONS | default "false" | toBool -}}
  45. // Video configuration.
  46. //
  47. if (!config.hasOwnProperty('constraints')) config.constraints = {};
  48. if (!config.constraints.hasOwnProperty('video')) config.constraints.video = {};
  49. config.resolution = {{ $RESOLUTION }};
  50. config.constraints.video.height = { ideal: {{ $RESOLUTION }}, max: {{ $RESOLUTION }}, min: {{ $RESOLUTION_MIN }} };
  51. config.constraints.video.width = { ideal: {{ $RESOLUTION_WIDTH }}, max: {{ $RESOLUTION_WIDTH }}, min: {{ $RESOLUTION_WIDTH_MIN }}};
  52. config.disableSimulcast = {{ not $ENABLE_SIMULCAST }};
  53. config.startVideoMuted = {{ $START_VIDEO_MUTED }};
  54. config.startWithVideoMuted = {{ $START_WITH_VIDEO_MUTED }};
  55. {{ if .Env.START_BITRATE -}}
  56. config.startBitrate = '{{ .Env.START_BITRATE }}';
  57. {{ end -}}
  58. // ScreenShare Configuration.
  59. //
  60. config.desktopSharingFrameRate = { min: {{ $DESKTOP_SHARING_FRAMERATE_MIN }}, max: {{ $DESKTOP_SHARING_FRAMERATE_MAX }} };
  61. // Audio configuration.
  62. //
  63. config.enableNoAudioDetection = {{ $ENABLE_NO_AUDIO_DETECTION }};
  64. config.enableTalkWhileMuted = {{ $ENABLE_TALK_WHILE_MUTED }};
  65. config.disableAP = {{ not $ENABLE_AUDIO_PROCESSING }};
  66. config.stereo = {{ $ENABLE_STEREO }};
  67. config.startAudioOnly = {{ $START_AUDIO_ONLY }};
  68. config.startAudioMuted = {{ $START_AUDIO_MUTED }};
  69. config.startWithAudioMuted = {{ $START_WITH_AUDIO_MUTED }};
  70. config.startSilent = {{ $START_SILENT }};
  71. config.disableAudioLevels = {{ $DISABLE_AUDIO_LEVELS }};
  72. config.enableNoisyMicDetection = {{ $ENABLE_NOISY_MIC_DETECTION }};
  73. // Peer-to-Peer options.
  74. //
  75. if (!config.hasOwnProperty('p2p')) config.p2p = {};
  76. config.p2p.enabled = {{ $ENABLE_P2P }};
  77. // Breakout Rooms
  78. //
  79. config.hideAddRoomButton = {{ $ENABLE_BREAKOUT_ROOMS | not }};
  80. // Etherpad
  81. //
  82. {{ if .Env.ETHERPAD_PUBLIC_URL -}}
  83. config.etherpad_base = '{{ .Env.ETHERPAD_PUBLIC_URL }}';
  84. {{ else if .Env.ETHERPAD_URL_BASE -}}
  85. config.etherpad_base = '{{.Env.PUBLIC_URL}}/etherpad/p/';
  86. {{ end -}}
  87. // Recording.
  88. //
  89. {{ if $ENABLE_RECORDING -}}
  90. config.hiddenDomain = '{{ $XMPP_RECORDER_DOMAIN }}';
  91. // Whether to enable file recording or not
  92. config.fileRecordingsEnabled = true;
  93. // Whether to enable live streaming or not.
  94. config.liveStreamingEnabled = true;
  95. {{ if .Env.DROPBOX_APPKEY -}}
  96. // Enable the dropbox integration.
  97. if (!config.hasOwnProperty('dropbox')) config.dropbox = {};
  98. config.dropbox.appKey = '{{ .Env.DROPBOX_APPKEY }}';
  99. {{ if .Env.DROPBOX_REDIRECT_URI -}}
  100. // A URL to redirect the user to, after authenticating
  101. // by default uses:
  102. // 'https://jitsi-meet.example.com/static/oauth.html'
  103. config.dropbox.redirectURI = '{{ .Env.DROPBOX_REDIRECT_URI }}';
  104. {{ end -}}
  105. {{ end -}}
  106. {{ if $ENABLE_FILE_RECORDING_SERVICE -}}
  107. // When integrations like dropbox are enabled only that will be shown,
  108. // by enabling fileRecordingsServiceEnabled, we show both the integrations
  109. // and the generic recording service (its configuration and storage type
  110. // depends on jibri configuration)
  111. config.fileRecordingsServiceEnabled = true;
  112. {{ end -}}
  113. {{ if $ENABLE_FILE_RECORDING_SERVICE_SHARING -}}
  114. // Whether to show the possibility to share file recording with other people
  115. // (e.g. meeting participants), based on the actual implementation
  116. // on the backend.
  117. config.fileRecordingsServiceSharingEnabled = true;
  118. {{ end -}}
  119. {{ end -}}
  120. // Analytics.
  121. //
  122. if (!config.hasOwnProperty('analytics')) config.analytics = {};
  123. {{ if .Env.AMPLITUDE_ID -}}
  124. // The Amplitude APP Key:
  125. config.analytics.amplitudeAPPKey = '{{ .Env.AMPLITUDE_ID }}';
  126. {{ end -}}
  127. {{ if .Env.GOOGLE_ANALYTICS_ID -}}
  128. // The Google Analytics Tracking ID:
  129. config.analytics.googleAnalyticsTrackingId = '{{ .Env.GOOGLE_ANALYTICS_ID }}';
  130. {{ end -}}
  131. {{ if .Env.MATOMO_ENDPOINT -}}
  132. // Matomo endpoint:
  133. config.analytics.matomoEndpoint = '{{ .Env.MATOMO_ENDPOINT }}';
  134. {{ end -}}
  135. {{ if .Env.MATOMO_SITE_ID -}}
  136. // Matomo site ID:
  137. config.analytics.matomoSiteID = '{{ .Env.MATOMO_SITE_ID }}';
  138. {{ end -}}
  139. {{ if .Env.ANALYTICS_SCRIPT_URLS -}}
  140. // Array of script URLs to load as lib-jitsi-meet "analytics handlers".
  141. config.analytics.scriptURLs = [ '{{ join "','" (splitList "," .Env.ANALYTICS_SCRIPT_URLS) }}' ];
  142. {{ end -}}
  143. {{ if .Env.ANALYTICS_WHITELISTED_EVENTS -}}
  144. config.analytics.whiteListedEvents = [ '{{ join "','" (splitList "," .Env.ANALYTICS_WHITELISTED_EVENTS) }}' ];
  145. {{ end -}}
  146. {{ if .Env.CALLSTATS_CUSTOM_SCRIPT_URL -}}
  147. config.callStatsCustomScriptUrl = '{{ .Env.CALLSTATS_CUSTOM_SCRIPT_URL }}';
  148. {{ end -}}
  149. {{ if .Env.CALLSTATS_ID -}}
  150. // To enable sending statistics to callstats.io you must provide the
  151. // Application ID and Secret.
  152. config.callStatsID = '{{ .Env.CALLSTATS_ID }}';
  153. {{ end -}}
  154. {{ if .Env.CALLSTATS_ID -}}
  155. config.callStatsSecret = '{{ .Env.CALLSTATS_SECRET }}';
  156. {{ end -}}
  157. // Enables callstatsUsername to be reported as statsId and used
  158. // by callstats as repoted remote id.
  159. config.enableStatsID = {{ $ENABLE_STATS_ID }};
  160. // Dial in/out services.
  161. //
  162. {{ if .Env.CONFCODE_URL -}}
  163. config.dialInConfCodeUrl = '{{ .Env.CONFCODE_URL }}';
  164. {{ end -}}
  165. {{ if .Env.DIALIN_NUMBERS_URL -}}
  166. config.dialInNumbersUrl = '{{ .Env.DIALIN_NUMBERS_URL }}';
  167. {{ end -}}
  168. {{ if .Env.DIALOUT_AUTH_URL -}}
  169. config.dialOutAuthUrl = '{{ .Env.DIALOUT_AUTH_URL }}';
  170. {{ end -}}
  171. {{ if .Env.DIALOUT_CODES_URL -}}
  172. config.dialOutCodesUrl = '{{ .Env.DIALOUT_CODES_URL }}';
  173. {{ end -}}
  174. // Calendar service integration.
  175. //
  176. config.enableCalendarIntegration = {{ $ENABLE_CALENDAR }};
  177. {{ if .Env.GOOGLE_API_APP_CLIENT_ID -}}
  178. config.googleApiApplicationClientID = '{{ .Env.GOOGLE_API_APP_CLIENT_ID }}';
  179. {{ end -}}
  180. {{ if .Env.MICROSOFT_API_APP_CLIENT_ID -}}
  181. config.microsoftApiApplicationClientID = '{{ .Env.MICROSOFT_API_APP_CLIENT_ID }}';
  182. {{ end -}}
  183. // Invitation service.
  184. //
  185. {{ if .Env.INVITE_SERVICE_URL -}}
  186. config.inviteServiceUrl = '{{ .Env.INVITE_SERVICE_URL }}';
  187. {{ end -}}
  188. {{ if .Env.PEOPLE_SEARCH_URL -}}
  189. config.peopleSearchUrl = '{{ .Env.PEOPLE_SEARCH_URL }}';
  190. config.peopleSearchQueryTypes = ['user','conferenceRooms'];
  191. {{ end -}}
  192. // Miscellaneous.
  193. //
  194. // Prejoin page.
  195. config.prejoinPageEnabled = {{ $ENABLE_PREJOIN_PAGE }};
  196. // Welcome page.
  197. config.enableWelcomePage = {{ $ENABLE_WELCOME_PAGE }};
  198. // Close page.
  199. config.enableClosePage = {{ $ENABLE_CLOSE_PAGE }};
  200. // Default language.
  201. {{ if .Env.DEFAULT_LANGUAGE -}}
  202. config.defaultLanguage = '{{ .Env.DEFAULT_LANGUAGE }}';
  203. {{ end -}}
  204. // Require users to always specify a display name.
  205. config.requireDisplayName = {{ $ENABLE_REQUIRE_DISPLAY_NAME }};
  206. // Chrome extension banner.
  207. {{ if .Env.CHROME_EXTENSION_BANNER_JSON -}}
  208. config.chromeExtensionBanner = {{ .Env.CHROME_EXTENSION_BANNER_JSON }};
  209. {{ end -}}
  210. // Advanced.
  211. //
  212. // Lipsync hack in jicofo, may not be safe.
  213. config.enableLipSync = {{ $ENABLE_LIPSYNC }};
  214. config.enableRemb = {{ $ENABLE_REMB }};
  215. config.enableTcc = {{ $ENABLE_TCC }};
  216. // Enable IPv6 support.
  217. config.useIPv6 = {{ $ENABLE_IPV6 }};
  218. // Transcriptions (subtitles and buttons can be configured in interface_config)
  219. config.transcribingEnabled = {{ $ENABLE_TRANSCRIPTIONS }};
  220. {{ if .Env.DYNAMIC_BRANDING_URL -}}
  221. // External API url used to receive branding specific information.
  222. config.dynamicBrandingUrl = '{{ .Env.DYNAMIC_BRANDING_URL }}';
  223. {{ end -}}
  224. {{ if .Env.TOKEN_AUTH_URL -}}
  225. // Authenticate using external service or just focus external auth window if there is one already.
  226. config.tokenAuthUrl = '{{ .Env.TOKEN_AUTH_URL }}';
  227. {{ end -}}
  228. // Deployment information.
  229. //
  230. if (!config.hasOwnProperty('deploymentInfo')) config.deploymentInfo = {};
  231. {{ if .Env.DEPLOYMENTINFO_ENVIRONMENT -}}
  232. config.deploymentInfo.environment = '{{ .Env.DEPLOYMENTINFO_ENVIRONMENT }}';
  233. {{ end -}}
  234. {{ if .Env.DEPLOYMENTINFO_SHARD -}}
  235. config.deploymentInfo.shard = '{{ .Env.DEPLOYMENTINFO_SHARD }}';
  236. {{ end -}}
  237. {{ if .Env.DEPLOYMENTINFO_ENVIRONMENT_TYPE -}}
  238. config.deploymentInfo.envType = '{{ .Env.DEPLOYMENTINFO_ENVIRONMENT_TYPE }}';
  239. {{ end -}}
  240. {{ if .Env.DEPLOYMENTINFO_REGION -}}
  241. config.deploymentInfo.region = '{{ .Env.DEPLOYMENTINFO_REGION }}';
  242. {{ end -}}
  243. {{ if $DEPLOYMENTINFO_USERREGION -}}
  244. config.deploymentInfo.userRegion = '{{ $DEPLOYMENTINFO_USERREGION }}';
  245. {{ end -}}
  246. // Testing
  247. //
  248. if (!config.hasOwnProperty('testing')) config.testing = {};
  249. if (!config.testing.hasOwnProperty('octo')) config.testing.octo = {};
  250. config.testing.capScreenshareBitrate = {{ $TESTING_CAP_SCREENSHARE_BITRATE }};
  251. config.testing.octo.probability = {{ $TESTING_OCTO_PROBABILITY }};
  252. // Deep Linking
  253. config.disableDeepLinking = {{ $DISABLE_DEEP_LINKING }};
  254. // P2P preferred codec
  255. {{ if .Env.P2P_PREFERRED_CODEC -}}
  256. config.p2p.preferredCodec = '{{ .Env.P2P_PREFERRED_CODEC }}';
  257. {{ end -}}
  258. // enable preffered video Codec
  259. if (!config.hasOwnProperty('videoQuality')) config.videoQuality = {};
  260. {{ if .Env.VIDEOQUALITY_PREFERRED_CODEC -}}
  261. config.videoQuality.preferredCodec = '{{ .Env.VIDEOQUALITY_PREFERRED_CODEC }}';
  262. {{ end -}}
  263. config.videoQuality.enforcePreferredCodec = {{ $VIDEOQUALITY_ENFORCE_PREFERRED_CODEC }};
  264. if (!config.videoQuality.hasOwnProperty('maxBitratesVideo')) config.videoQuality.maxBitratesVideo = {};
  265. {{ if and .Env.VIDEOQUALITY_BITRATE_H264_LOW .Env.VIDEOQUALITY_BITRATE_H264_STANDARD .Env.VIDEOQUALITY_BITRATE_H264_HIGH -}}
  266. config.videoQuality.maxBitratesVideo.H264 = { low: {{ .Env.VIDEOQUALITY_BITRATE_H264_LOW }}, standard: {{ .Env.VIDEOQUALITY_BITRATE_H264_STANDARD }}, high: {{ .Env.VIDEOQUALITY_BITRATE_H264_HIGH }} };
  267. {{ end -}}
  268. {{ if and .Env.VIDEOQUALITY_BITRATE_VP8_LOW .Env.VIDEOQUALITY_BITRATE_VP8_STANDARD .Env.VIDEOQUALITY_BITRATE_VP8_HIGH -}}
  269. config.videoQuality.maxBitratesVideo.VP8 = { low: {{ .Env.VIDEOQUALITY_BITRATE_VP8_LOW }}, standard: {{ .Env.VIDEOQUALITY_BITRATE_VP8_STANDARD }}, high: {{ .Env.VIDEOQUALITY_BITRATE_VP8_HIGH }} };
  270. {{ end -}}
  271. {{ if and .Env.VIDEOQUALITY_BITRATE_VP9_LOW .Env.VIDEOQUALITY_BITRATE_VP9_STANDARD .Env.VIDEOQUALITY_BITRATE_VP9_HIGH -}}
  272. config.videoQuality.maxBitratesVideo.VP9 = { low: {{ .Env.VIDEOQUALITY_BITRATE_VP9_LOW }}, standard: {{ .Env.VIDEOQUALITY_BITRATE_VP9_STANDARD }}, high: {{ .Env.VIDEOQUALITY_BITRATE_VP9_HIGH }} };
  273. {{ end -}}
  274. // Reactions
  275. config.disableReactions = {{ $DISABLE_REACTIONS }};
  276. // Polls
  277. config.disablePolls = {{ $DISABLE_POLLS }};
  278. // Configure toolbar buttons
  279. {{ if .Env.TOOLBAR_BUTTONS -}}
  280. config.toolbarButtons = [ '{{ join "','" (splitList "," .Env.TOOLBAR_BUTTONS) }}' ];
  281. {{ end -}}
  282. // Hides the buttons at pre-join screen
  283. {{ if .Env.HIDE_PREMEETING_BUTTONS -}}
  284. config.hiddenPremeetingButtons = [ '{{ join "','" (splitList "," .Env.HIDE_PREMEETING_BUTTONS) }}' ];
  285. {{ end -}}
  286. // Configure remote participant video menu
  287. if (!config.hasOwnProperty('remoteVideoMenu')) config.remoteVideoMenu = {};
  288. {{ if .Env.DISABLE_KICKOUT -}}
  289. config.remoteVideoMenu.disableKick = {{ .Env.DISABLE_KICKOUT }};
  290. {{ end -}}
  291. {{ if .Env.DISABLE_GRANT_MODERATOR -}}
  292. config.remoteVideoMenu.disableGrantModerator = {{ .Env.DISABLE_GRANT_MODERATOR }};
  293. {{ end -}}