diff --git a/404.html b/404.html index ac6e2e128..f8e94608d 100644 --- a/404.html +++ b/404.html @@ -4,8 +4,8 @@ Page Not Found | Jitsi Meet - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/assets/js/00635824.adafacce.js b/assets/js/00635824.b63e2bcd.js similarity index 99% rename from assets/js/00635824.adafacce.js rename to assets/js/00635824.b63e2bcd.js index 6c104ab47..8d7ee5987 100644 --- a/assets/js/00635824.adafacce.js +++ b/assets/js/00635824.b63e2bcd.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[9807],{1492:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>s,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=t(4848),n=t(8453);const r={id:"dev-guide-web-integrations",title:"Web integrations",sidebar_label:"Integrations"},a=void 0,d={id:"dev-guide/dev-guide-web-integrations",title:"Web integrations",description:"Creating the Google API client for Google Calendar and YouTube integration",source:"@site/docs/dev-guide/web-integrations.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-web-integrations",permalink:"/handbook/docs/dev-guide/dev-guide-web-integrations",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/web-integrations.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"dev-guide-web-integrations",title:"Web integrations",sidebar_label:"Integrations"},sidebar:"docs",previous:{title:"Modifying lib-jitsi-meet",permalink:"/handbook/docs/dev-guide/dev-guide-ljm"},next:{title:"IFrame API",permalink:"/handbook/docs/dev-guide/dev-guide-iframe"}},s={},l=[{value:"Creating the Google API client for Google Calendar and YouTube integration",id:"creating-the-google-api-client-for-google-calendar-and-youtube-integration",level:2},{value:"Creating the Microsoft app for Microsoft Outlook integration",id:"creating-the-microsoft-app-for-microsoft-outlook-integration",level:2},{value:"Creating the Dropbox app for Dropbox recording integration",id:"creating-the-dropbox-app-for-dropbox-recording-integration",level:2}];function c(e){const o={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",pre:"pre",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(o.h2,{id:"creating-the-google-api-client-for-google-calendar-and-youtube-integration",children:"Creating the Google API client for Google Calendar and YouTube integration"}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsx)(o.li,{children:"Log into a Google admin account."}),"\n",(0,i.jsxs)(o.li,{children:["Go to Google cloud platform dashboard. ",(0,i.jsx)(o.a,{href:"https://console.cloud.google.com/apis/dashboard",children:"https://console.cloud.google.com/apis/dashboard"})]}),"\n",(0,i.jsx)(o.li,{children:"In the Select a Project dropdown, click New Project."}),"\n",(0,i.jsx)(o.li,{children:"Give the project a name."}),"\n",(0,i.jsx)(o.li,{children:"Proceed to the Credentials settings of the new project."}),"\n",(0,i.jsx)(o.li,{children:"In the Credentials tab of the Credentials settings, click Create Credentials and select the type OAuth client ID."}),"\n",(0,i.jsxs)(o.li,{children:["Proceed with creating a Web application and add the domains (origins) on which the application will be hosted. Local development environments (",(0,i.jsx)(o.a,{href:"http://localhost:8000",children:"http://localhost:8000"})," for example) can be added here."]}),"\n",(0,i.jsx)(o.li,{children:"While still in the Google cloud platform dashboard, click the Library settings for the calendar project."}),"\n",(0,i.jsx)(o.li,{children:"Search for the Google Calendar API (used for calendar accessing), click its result, and enable it."}),"\n",(0,i.jsx)(o.li,{children:"Do the same for YouTube Data API v3"}),"\n"]}),"\n",(0,i.jsx)(o.h2,{id:"creating-the-microsoft-app-for-microsoft-outlook-integration",children:"Creating the Microsoft app for Microsoft Outlook integration"}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsxs)(o.li,{children:["Go to ",(0,i.jsx)(o.a,{href:"https://apps.dev.microsoft.com/",children:"https://apps.dev.microsoft.com/"})]}),"\n",(0,i.jsx)(o.li,{children:'Proceed through the "Add an app" flow. Once created, a page with several Graph Permissions fields should display.'}),"\n",(0,i.jsx)(o.li,{children:'Under "Platforms" add "Web"'}),"\n",(0,i.jsxs)(o.li,{children:["Add a redirect URL for the Microsoft auth flow to visit once a user has confirmed authentication. Target domain if available is just 'yourdomain.com' (the deployment address) and the redirect URL is ",(0,i.jsx)(o.code,{children:"https://yourdomain.com/static/msredirect.html"}),"."]}),"\n",(0,i.jsx)(o.li,{children:"Add Microsoft Graph delegated permissions, if this option is available: Calendars.Read, Calendars.ReadWrite, Calendars.Read.Shared, Calendars.ReadWrite.Shared."}),"\n",(0,i.jsxs)(o.li,{children:["Check ",(0,i.jsx)(o.code,{children:"Allow Implicit Flow"})," (and ",(0,i.jsx)(o.code,{children:"Restrict token issuing to this app"})," if available)."]}),"\n",(0,i.jsx)(o.li,{children:"Save the changes."}),"\n"]}),"\n",(0,i.jsx)(o.h2,{id:"creating-the-dropbox-app-for-dropbox-recording-integration",children:"Creating the Dropbox app for Dropbox recording integration"}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsxs)(o.li,{children:["You need a Dropbox account (If you don't already have one, you can sign up for a free account ",(0,i.jsx)(o.a,{href:"https://www.dropbox.com/register",children:"here"}),".)"]}),"\n",(0,i.jsxs)(o.li,{children:["Create new App as described in ",(0,i.jsx)(o.a,{href:"https://www.dropbox.com/developers/reference/getting-started?_tk=guides_lp&_ad=guides2&_camp=get_started#app%20console",children:"Getting Started Guide"})," in App Console section."]}),"\n",(0,i.jsxs)(o.li,{children:["Choose","\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsx)(o.li,{children:"'Dropbox API - For apps that need to access files in Dropbox.'"}),"\n",(0,i.jsx)(o.li,{children:"'App folder\u2013 Access to a single folder created specifically for your app.'"}),"\n",(0,i.jsx)(o.li,{children:"Fill in the name of your app"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(o.li,{children:["You need only, the newly created App key, goes in ",(0,i.jsx)(o.code,{children:"/etc/jitsi/meet/yourdeployment.com-config.js"})," in","\n",(0,i.jsx)(o.pre,{children:(0,i.jsx)(o.code,{className:'language-title="/etc/jitsi/meet/yourdeployment.com-config.js"',children:" dropbox: {\n appKey: '__dropbox_app_key__',\n redirectURI: 'https://yourdeployment.com/static/oauth.html'\n }\n"})}),"\n"]}),"\n",(0,i.jsxs)(o.li,{children:["Add your Dropbox Redirect URIs in the Dropbox form ",(0,i.jsx)(o.code,{children:"https://yourdeployment.com/static/oauth.html"})]}),"\n",(0,i.jsx)(o.li,{children:"Fill in Branding"}),"\n"]})]})}function h(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>a,x:()=>d});var i=t(6540);const n={},r=i.createContext(n);function a(e){const o=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function d(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),i.createElement(r.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[9807],{1492:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>s,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=t(4848),n=t(8453);const r={id:"dev-guide-web-integrations",title:"Web integrations",sidebar_label:"Integrations"},a=void 0,d={id:"dev-guide/dev-guide-web-integrations",title:"Web integrations",description:"Creating the Google API client for Google Calendar and YouTube integration",source:"@site/docs/dev-guide/web-integrations.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-web-integrations",permalink:"/handbook/docs/dev-guide/dev-guide-web-integrations",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/web-integrations.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"dev-guide-web-integrations",title:"Web integrations",sidebar_label:"Integrations"},sidebar:"docs",previous:{title:"Modifying lib-jitsi-meet",permalink:"/handbook/docs/dev-guide/dev-guide-ljm"},next:{title:"IFrame API",permalink:"/handbook/docs/dev-guide/dev-guide-iframe"}},s={},l=[{value:"Creating the Google API client for Google Calendar and YouTube integration",id:"creating-the-google-api-client-for-google-calendar-and-youtube-integration",level:2},{value:"Creating the Microsoft app for Microsoft Outlook integration",id:"creating-the-microsoft-app-for-microsoft-outlook-integration",level:2},{value:"Creating the Dropbox app for Dropbox recording integration",id:"creating-the-dropbox-app-for-dropbox-recording-integration",level:2}];function c(e){const o={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",pre:"pre",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(o.h2,{id:"creating-the-google-api-client-for-google-calendar-and-youtube-integration",children:"Creating the Google API client for Google Calendar and YouTube integration"}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsx)(o.li,{children:"Log into a Google admin account."}),"\n",(0,i.jsxs)(o.li,{children:["Go to Google cloud platform dashboard. ",(0,i.jsx)(o.a,{href:"https://console.cloud.google.com/apis/dashboard",children:"https://console.cloud.google.com/apis/dashboard"})]}),"\n",(0,i.jsx)(o.li,{children:"In the Select a Project dropdown, click New Project."}),"\n",(0,i.jsx)(o.li,{children:"Give the project a name."}),"\n",(0,i.jsx)(o.li,{children:"Proceed to the Credentials settings of the new project."}),"\n",(0,i.jsx)(o.li,{children:"In the Credentials tab of the Credentials settings, click Create Credentials and select the type OAuth client ID."}),"\n",(0,i.jsxs)(o.li,{children:["Proceed with creating a Web application and add the domains (origins) on which the application will be hosted. Local development environments (",(0,i.jsx)(o.a,{href:"http://localhost:8000",children:"http://localhost:8000"})," for example) can be added here."]}),"\n",(0,i.jsx)(o.li,{children:"While still in the Google cloud platform dashboard, click the Library settings for the calendar project."}),"\n",(0,i.jsx)(o.li,{children:"Search for the Google Calendar API (used for calendar accessing), click its result, and enable it."}),"\n",(0,i.jsx)(o.li,{children:"Do the same for YouTube Data API v3"}),"\n"]}),"\n",(0,i.jsx)(o.h2,{id:"creating-the-microsoft-app-for-microsoft-outlook-integration",children:"Creating the Microsoft app for Microsoft Outlook integration"}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsxs)(o.li,{children:["Go to ",(0,i.jsx)(o.a,{href:"https://apps.dev.microsoft.com/",children:"https://apps.dev.microsoft.com/"})]}),"\n",(0,i.jsx)(o.li,{children:'Proceed through the "Add an app" flow. Once created, a page with several Graph Permissions fields should display.'}),"\n",(0,i.jsx)(o.li,{children:'Under "Platforms" add "Web"'}),"\n",(0,i.jsxs)(o.li,{children:["Add a redirect URL for the Microsoft auth flow to visit once a user has confirmed authentication. Target domain if available is just 'yourdomain.com' (the deployment address) and the redirect URL is ",(0,i.jsx)(o.code,{children:"https://yourdomain.com/static/msredirect.html"}),"."]}),"\n",(0,i.jsx)(o.li,{children:"Add Microsoft Graph delegated permissions, if this option is available: Calendars.Read, Calendars.ReadWrite, Calendars.Read.Shared, Calendars.ReadWrite.Shared."}),"\n",(0,i.jsxs)(o.li,{children:["Check ",(0,i.jsx)(o.code,{children:"Allow Implicit Flow"})," (and ",(0,i.jsx)(o.code,{children:"Restrict token issuing to this app"})," if available)."]}),"\n",(0,i.jsx)(o.li,{children:"Save the changes."}),"\n"]}),"\n",(0,i.jsx)(o.h2,{id:"creating-the-dropbox-app-for-dropbox-recording-integration",children:"Creating the Dropbox app for Dropbox recording integration"}),"\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsxs)(o.li,{children:["You need a Dropbox account (If you don't already have one, you can sign up for a free account ",(0,i.jsx)(o.a,{href:"https://www.dropbox.com/register",children:"here"}),".)"]}),"\n",(0,i.jsxs)(o.li,{children:["Create new App as described in ",(0,i.jsx)(o.a,{href:"https://www.dropbox.com/developers/reference/getting-started?_tk=guides_lp&_ad=guides2&_camp=get_started#app%20console",children:"Getting Started Guide"})," in App Console section."]}),"\n",(0,i.jsxs)(o.li,{children:["Choose","\n",(0,i.jsxs)(o.ol,{children:["\n",(0,i.jsx)(o.li,{children:"'Dropbox API - For apps that need to access files in Dropbox.'"}),"\n",(0,i.jsx)(o.li,{children:"'App folder\u2013 Access to a single folder created specifically for your app.'"}),"\n",(0,i.jsx)(o.li,{children:"Fill in the name of your app"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(o.li,{children:["You need only, the newly created App key, goes in ",(0,i.jsx)(o.code,{children:"/etc/jitsi/meet/yourdeployment.com-config.js"})," in","\n",(0,i.jsx)(o.pre,{children:(0,i.jsx)(o.code,{className:'language-title="/etc/jitsi/meet/yourdeployment.com-config.js"',children:" dropbox: {\n appKey: '__dropbox_app_key__',\n redirectURI: 'https://yourdeployment.com/static/oauth.html'\n }\n"})}),"\n"]}),"\n",(0,i.jsxs)(o.li,{children:["Add your Dropbox Redirect URIs in the Dropbox form ",(0,i.jsx)(o.code,{children:"https://yourdeployment.com/static/oauth.html"})]}),"\n",(0,i.jsx)(o.li,{children:"Fill in Branding"}),"\n"]})]})}function h(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>a,x:()=>d});var i=t(6540);const n={},r=i.createContext(n);function a(e){const o=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function d(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),i.createElement(r.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0480b142.9106f96d.js b/assets/js/0480b142.648fb367.js similarity index 99% rename from assets/js/0480b142.9106f96d.js rename to assets/js/0480b142.648fb367.js index fe5c78179..e461f5981 100644 --- a/assets/js/0480b142.9106f96d.js +++ b/assets/js/0480b142.648fb367.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[8070],{2453:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=n(4848),i=n(8453);const r={id:"faq",title:"FAQ"},s=void 0,a={id:"faq",title:"FAQ",description:"How to tell if my server instance is behind NAT?",source:"@site/docs/faq.md",sourceDirName:".",slug:"/faq",permalink:"/handbook/docs/faq",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/faq.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"faq",title:"FAQ"},sidebar:"docs",previous:{title:"Security",permalink:"/handbook/docs/security"},next:{title:"Our community",permalink:"/handbook/docs/community/community-intro"}},c={},d=[{value:"How to tell if my server instance is behind NAT?",id:"how-to-tell-if-my-server-instance-is-behind-nat",level:2},{value:"Clients could communicate well in the room created at meet.jit.si. The same clients still could connect to my self-hosted instance but could neither hear nor see one another. What's wrong?",id:"clients-could-communicate-well-in-the-room-created-at-meetjitsi-the-same-clients-still-could-connect-to-my-self-hosted-instance-but-could-neither-hear-nor-see-one-another-whats-wrong",level:2},{value:"It works with two participants but crashes or does not work properly when a third joins",id:"it-works-with-two-participants-but-crashes-or-does-not-work-properly-when-a-third-joins",level:2},{value:"Can I mute and unmute other participants?",id:"can-i-mute-and-unmute-other-participants",level:2},{value:"How can I protect my meetings with Jitsi?",id:"how-can-i-protect-my-meetings-with-jitsi",level:2},{value:"1. Create a "strong" room name.",id:"1-create-a-strong-room-name",level:3},{value:"2. Use a different room name for each meeting / conference you have.",id:"2-use-a-different-room-name-for-each-meeting--conference-you-have",level:3},{value:"3. Add a password to the room.",id:"3-add-a-password-to-the-room",level:3},{value:"4. Enable "secure domain" if you are using your instance of Jitsi.",id:"4-enable-secure-domain-if-you-are-using-your-instance-of-jitsi",level:3},{value:"It's working when I connect from a browser, but not from the iOS or Android apps",id:"its-working-when-i-connect-from-a-browser-but-not-from-the-ios-or-android-apps",level:2},{value:"Can I record and save the video?",id:"can-i-record-and-save-the-video",level:2},{value:"I set the password in meeting but it is not working the next time",id:"i-set-the-password-in-meeting-but-it-is-not-working-the-next-time",level:2},{value:"How to limit the number of participants?",id:"how-to-limit-the-number-of-participants",level:2},{value:"Other participants complain my screen sharing is very bright and appears washed out?",id:"other-participants-complain-my-screen-sharing-is-very-bright-and-appears-washed-out",level:2}];function l(e){const o={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.h2,{id:"how-to-tell-if-my-server-instance-is-behind-nat",children:"How to tell if my server instance is behind NAT?"}),"\n",(0,t.jsx)(o.p,{children:"In general, if the tool ifconfig (or ipconfig) shows the assigned IPv4 address to be a private / local address (10.x.x.x, or 172.16.x.x - 172.31.x.x, or 192.168.x.x) but you know that its public IPv4 address is different from that, the server is most probably behind NAT."}),"\n",(0,t.jsx)(o.p,{children:"If you are hosting your server on a VPS, and you are not sure, ask your VPS provider's support team."}),"\n",(0,t.jsxs)(o.h2,{id:"clients-could-communicate-well-in-the-room-created-at-meetjitsi-the-same-clients-still-could-connect-to-my-self-hosted-instance-but-could-neither-hear-nor-see-one-another-whats-wrong",children:["Clients could communicate well in the room created at ",(0,t.jsx)(o.code,{children:"meet.jit.si"}),". The same clients still could connect to my self-hosted instance but could neither hear nor see one another. What's wrong?"]}),"\n",(0,t.jsxs)(o.p,{children:["Most probably, the server is behind NAT, but you haven't added the NAT-specific configuration. See this ",(0,t.jsx)(o.a,{href:"https://community.jitsi.org/t/cannot-see-video-or-hear-audio-on-self-hosted-instance/",children:"resolved question"}),". You need to follow the steps detailed ",(0,t.jsx)(o.a,{href:"devops-guide/devops-guide-quickstart#advanced-configuration",children:"here"}),"."]}),"\n",(0,t.jsx)(o.h2,{id:"it-works-with-two-participants-but-crashes-or-does-not-work-properly-when-a-third-joins",children:"It works with two participants but crashes or does not work properly when a third joins"}),"\n",(0,t.jsx)(o.p,{children:"P2P mode is working, but it fails when you are trying to pass traffic via jitsi-videobridge2."}),"\n",(0,t.jsxs)(o.p,{children:["Check you've got your firewall / NAT set up correctly \u2014 especially UDP 10000. For more information, see ",(0,t.jsx)(o.a,{href:"devops-guide/devops-guide-quickstart#setup-and-configure-your-firewall",children:"here"}),"."]}),"\n",(0,t.jsx)(o.h2,{id:"can-i-mute-and-unmute-other-participants",children:"Can I mute and unmute other participants?"}),"\n",(0,t.jsx)(o.p,{children:"If you are the moderator of a conference, you can mute everyone's microphone. You cannot unmute other people's microphones, and they can unmute their microphones at any time."}),"\n",(0,t.jsx)(o.p,{children:'You may want to set some "ground rules" for who can talk and when, just as with any physical meeting or classroom.'}),"\n",(0,t.jsxs)(o.p,{children:['If you would like to limit who can become a moderator, you need to set up your instance of Jitsi and enable "secure domain". Please see ',(0,t.jsx)(o.a,{href:"#4-enable-secure-domain-if-you-are-using-your-instance-of-jitsi",children:"here"})," for more information."]}),"\n",(0,t.jsx)(o.h2,{id:"how-can-i-protect-my-meetings-with-jitsi",children:"How can I protect my meetings with Jitsi?"}),"\n",(0,t.jsx)(o.h3,{id:"1-create-a-strong-room-name",children:(0,t.jsx)(o.em,{children:'1. Create a "strong" room name.'})}),"\n",(0,t.jsx)(o.p,{children:'Use a strong room name, that no one else is likely to be using. Use the name generator on the welcome page, or else generate your own "strong" name.'}),"\n",(0,t.jsxs)(o.p,{children:["For example, on macOS, in the terminal, you can use ",(0,t.jsx)(o.code,{children:"uuidgen"})," to generate a string of letters of numbers (e.g. B741B63E-C5E6-4D82-BAC4-048BE25D8CC7)."]}),"\n",(0,t.jsxs)(o.p,{children:["Your room name would be ",(0,t.jsx)(o.code,{children:"meet.jit.si/B741B63E-C5E6-4D82-BAC4-048BE25D8CC7"})," on the hosted ",(0,t.jsx)(o.code,{children:"meet.jit.si"})," platform."]}),"\n",(0,t.jsx)(o.p,{children:'If you use "test" or "LucysMeeting" "pilates" or similar, then it\'s highly likely that other users will have had the same idea.'}),"\n",(0,t.jsx)(o.h3,{id:"2-use-a-different-room-name-for-each-meeting--conference-you-have",children:(0,t.jsx)(o.em,{children:"2. Use a different room name for each meeting / conference you have."})}),"\n",(0,t.jsx)(o.p,{children:"If you are going to have multiple meetings, ideally use a different room name for each one."}),"\n",(0,t.jsx)(o.p,{children:"If that is not practical, at least use a different room name for each group of people."}),"\n",(0,t.jsx)(o.h3,{id:"3-add-a-password-to-the-room",children:(0,t.jsx)(o.em,{children:"3. Add a password to the room."})}),"\n",(0,t.jsx)(o.p,{children:"Once you have started your room, set a password for it. Only people who have the password can join from that point on, but it does not affect people who have already joined."}),"\n",(0,t.jsx)(o.p,{children:"You will need to tell everyone the password."}),"\n",(0,t.jsx)(o.p,{children:"If they give the password to others, those other people can also join."}),"\n",(0,t.jsx)(o.h3,{id:"4-enable-secure-domain-if-you-are-using-your-instance-of-jitsi",children:(0,t.jsx)(o.em,{children:'4. Enable "secure domain" if you are using your instance of Jitsi.'})}),"\n",(0,t.jsxs)(o.p,{children:["In addition to the tips above, consider enabling the ",(0,t.jsx)(o.a,{href:"https://jitsi.github.io/handbook/docs/devops-guide/secure-domain",children:'"secure domain" configuration'}),". This requires you (or someone else) to enter a username and password to open a room. It also allows you to become a moderator."]}),"\n",(0,t.jsx)(o.h2,{id:"its-working-when-i-connect-from-a-browser-but-not-from-the-ios-or-android-apps",children:"It's working when I connect from a browser, but not from the iOS or Android apps"}),"\n",(0,t.jsxs)(o.p,{children:["This probably means that you are not serving the fullchain for your TLS certificate. You can check if your cert chain\nis properly configured ",(0,t.jsx)(o.a,{href:"https://whatsmychaincert.com/",children:"here"}),"."]}),"\n",(0,t.jsx)(o.p,{children:"In nginx, if you are using Let's Encrypt, you should have a line like this:"}),"\n",(0,t.jsx)(o.p,{children:(0,t.jsx)(o.code,{children:"ssl_certificate /etc/letsencrypt/live/jitsi.example.com/fullchain.pem;"})}),"\n",(0,t.jsx)(o.h2,{id:"can-i-record-and-save-the-video",children:"Can I record and save the video?"}),"\n",(0,t.jsx)(o.p,{children:"Yes. There are multiple methods (using external software or services):"}),"\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.em,{children:"Note"}),": If you want to use a privacy-friendly method, use method 1 or 2."]}),"\n",(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"OBS"}),": Use ",(0,t.jsx)(o.a,{href:"https://obsproject.com/",children:"OBS"})," to record your Session (e.g. your browser window)."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"RTMP-Server"}),": For this you have to setup your own RTMP-Server and then use your RTMP URL + Stream key instead of the Youtube Stream key as described ",(0,t.jsx)(o.a,{href:"https://jitsi.org/blog/live-streaming-with-jitsi-and-youtube/",children:"here"}),". Self-installed Jitsi Meet deployments will need to setup Jibri to do this."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"Dropbox"}),": ",(0,t.jsx)(o.a,{href:"/handbook/docs/dev-guide/dev-guide-web-integrations#creating-the-dropbox-app-for-dropbox-recording-integration",children:"Connect to Dropbox with Jitsi Meet"})," and save the video in the Dropbox."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"Video Services/Websites"}),": Stream your conference to YouTube or other sites (e.g. Twitch) and access the recording there (see ",(0,t.jsx)(o.a,{href:"https://jitsi.org/blog/live-streaming-with-jitsi-and-youtube/",children:"howto"}),"). Self-installed Jitsi Meet deployments will need to setup Jibri to do this."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(o.p,{children:["More methods might be implemented in the future, but are not ready yet (e.g. ",(0,t.jsx)(o.a,{href:"https://github.com/jitsi/jitsi-meet/issues/6014",children:"Local Recording"}),"."]}),"\n",(0,t.jsx)(o.h2,{id:"i-set-the-password-in-meeting-but-it-is-not-working-the-next-time",children:"I set the password in meeting but it is not working the next time"}),"\n",(0,t.jsx)(o.p,{children:"Once the meeting ends it's password also gets removed, so you need to set the password again for next meeting."}),"\n",(0,t.jsx)(o.h2,{id:"how-to-limit-the-number-of-participants",children:"How to limit the number of participants?"}),"\n",(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["Use the command ",(0,t.jsx)(o.code,{children:"prosodyctl about"})," to view the version of prosody and plug directory, similar to the output below."]}),"\n"]}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{children:"Prosody 0.11.6\n\n# Prosody directories\n\nData directory: /var/lib/prosody\n\nConfig directory: /etc/prosody\n\nSource directory: /usr/lib/prosody\n\nPlugin directories:\n\n/usr/share/jitsi-meet/prosody-plugins/\n\n/usr/lib/prosody/modules/\n"})}),"\n",(0,t.jsxs)(o.ol,{start:"2",children:["\n",(0,t.jsxs)(o.li,{children:["Check if there is a ",(0,t.jsx)(o.code,{children:"mod_muc_max_occupants.lua"})," file in your plugin directory."]}),"\n"]}),"\n",(0,t.jsxs)(o.p,{children:["If not, please create a new file ",(0,t.jsx)(o.code,{children:"mod_muc_max_occupants.lua"})," in the plugin directory And copy everything from ",(0,t.jsx)(o.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/resources/prosody-plugins/mod_muc_max_occupants.lua",children:"here"})," to paste."]}),"\n",(0,t.jsx)(o.p,{children:"If it exists, please ignore this step."}),"\n",(0,t.jsxs)(o.p,{children:["3.Edit your ",(0,t.jsx)(o.code,{children:"/etc/prosody/conf.avail/meet.example.com.cfg.lua"})," file and add ",(0,t.jsx)(o.code,{children:"muc_max_occupants"}),' as a module_enabled in the conference.meet.example.com "muc" section.']}),"\n",(0,t.jsxs)(o.p,{children:["Then, add the options below that. You need both ",(0,t.jsx)(o.code,{children:"muc_max_occupants"})," and ",(0,t.jsx)(o.code,{children:"muc_access_whitelist"})," defined."]}),"\n",(0,t.jsx)(o.p,{children:"Example:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{children:'Component "conference.meet.example.com" "muc"\n storage = "memory"\n modules_enabled = {\n "muc_meeting_id";\n "muc_domain_mapper";\n "muc_max_occupants"; \n }\n muc_max_occupants = "5"\n muc_access_whitelist = { "focus@auth.meet.example.com" }\n admins = { "focus@auth.meet.example.com" }\n muc_room_locking = false\n muc_room_default_public_jids = true\n'})}),"\n",(0,t.jsx)(o.p,{children:'Note: the relationship between storage = "" and your prosody version, and you need to modify all storage="" .'}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:'Prosody nightly747 storage = "null"'}),"\n",(0,t.jsx)(o.li,{children:'Prosody 0.10 storage = "none"'}),"\n",(0,t.jsx)(o.li,{children:'Prosody 0.11 storage = "memory"'}),"\n"]}),"\n",(0,t.jsxs)(o.ol,{start:"4",children:["\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:["You need to use the command ",(0,t.jsx)(o.code,{children:"prosodyctl restart"})," to see the effect."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:["If you want to update to use prosody, you can check ",(0,t.jsx)(o.a,{href:"https://community.jitsi.org/t/how-to-how-do-i-update-prosody/72205",children:"here"}),"."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"other-participants-complain-my-screen-sharing-is-very-bright-and-appears-washed-out",children:"Other participants complain my screen sharing is very bright and appears washed out?"}),"\n",(0,t.jsxs)(o.p,{children:["You might have HDR streaming enabled in your OS display or graphic card settings. If you are on Windows, you can quickly toggle HDR on/off using ",(0,t.jsx)(o.code,{children:"Win + Alt + B"})," for all your HDR-capable screens at any time, even while screen sharing."]})]})}function h(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,o,n)=>{n.d(o,{R:()=>s,x:()=>a});var t=n(6540);const i={},r=t.createContext(i);function s(e){const o=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(r.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[8070],{2453:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=n(4848),i=n(8453);const r={id:"faq",title:"FAQ"},s=void 0,a={id:"faq",title:"FAQ",description:"How to tell if my server instance is behind NAT?",source:"@site/docs/faq.md",sourceDirName:".",slug:"/faq",permalink:"/handbook/docs/faq",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/faq.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"faq",title:"FAQ"},sidebar:"docs",previous:{title:"Security",permalink:"/handbook/docs/security"},next:{title:"Our community",permalink:"/handbook/docs/community/community-intro"}},c={},d=[{value:"How to tell if my server instance is behind NAT?",id:"how-to-tell-if-my-server-instance-is-behind-nat",level:2},{value:"Clients could communicate well in the room created at meet.jit.si. The same clients still could connect to my self-hosted instance but could neither hear nor see one another. What's wrong?",id:"clients-could-communicate-well-in-the-room-created-at-meetjitsi-the-same-clients-still-could-connect-to-my-self-hosted-instance-but-could-neither-hear-nor-see-one-another-whats-wrong",level:2},{value:"It works with two participants but crashes or does not work properly when a third joins",id:"it-works-with-two-participants-but-crashes-or-does-not-work-properly-when-a-third-joins",level:2},{value:"Can I mute and unmute other participants?",id:"can-i-mute-and-unmute-other-participants",level:2},{value:"How can I protect my meetings with Jitsi?",id:"how-can-i-protect-my-meetings-with-jitsi",level:2},{value:"1. Create a "strong" room name.",id:"1-create-a-strong-room-name",level:3},{value:"2. Use a different room name for each meeting / conference you have.",id:"2-use-a-different-room-name-for-each-meeting--conference-you-have",level:3},{value:"3. Add a password to the room.",id:"3-add-a-password-to-the-room",level:3},{value:"4. Enable "secure domain" if you are using your instance of Jitsi.",id:"4-enable-secure-domain-if-you-are-using-your-instance-of-jitsi",level:3},{value:"It's working when I connect from a browser, but not from the iOS or Android apps",id:"its-working-when-i-connect-from-a-browser-but-not-from-the-ios-or-android-apps",level:2},{value:"Can I record and save the video?",id:"can-i-record-and-save-the-video",level:2},{value:"I set the password in meeting but it is not working the next time",id:"i-set-the-password-in-meeting-but-it-is-not-working-the-next-time",level:2},{value:"How to limit the number of participants?",id:"how-to-limit-the-number-of-participants",level:2},{value:"Other participants complain my screen sharing is very bright and appears washed out?",id:"other-participants-complain-my-screen-sharing-is-very-bright-and-appears-washed-out",level:2}];function l(e){const o={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.h2,{id:"how-to-tell-if-my-server-instance-is-behind-nat",children:"How to tell if my server instance is behind NAT?"}),"\n",(0,t.jsx)(o.p,{children:"In general, if the tool ifconfig (or ipconfig) shows the assigned IPv4 address to be a private / local address (10.x.x.x, or 172.16.x.x - 172.31.x.x, or 192.168.x.x) but you know that its public IPv4 address is different from that, the server is most probably behind NAT."}),"\n",(0,t.jsx)(o.p,{children:"If you are hosting your server on a VPS, and you are not sure, ask your VPS provider's support team."}),"\n",(0,t.jsxs)(o.h2,{id:"clients-could-communicate-well-in-the-room-created-at-meetjitsi-the-same-clients-still-could-connect-to-my-self-hosted-instance-but-could-neither-hear-nor-see-one-another-whats-wrong",children:["Clients could communicate well in the room created at ",(0,t.jsx)(o.code,{children:"meet.jit.si"}),". The same clients still could connect to my self-hosted instance but could neither hear nor see one another. What's wrong?"]}),"\n",(0,t.jsxs)(o.p,{children:["Most probably, the server is behind NAT, but you haven't added the NAT-specific configuration. See this ",(0,t.jsx)(o.a,{href:"https://community.jitsi.org/t/cannot-see-video-or-hear-audio-on-self-hosted-instance/",children:"resolved question"}),". You need to follow the steps detailed ",(0,t.jsx)(o.a,{href:"devops-guide/devops-guide-quickstart#advanced-configuration",children:"here"}),"."]}),"\n",(0,t.jsx)(o.h2,{id:"it-works-with-two-participants-but-crashes-or-does-not-work-properly-when-a-third-joins",children:"It works with two participants but crashes or does not work properly when a third joins"}),"\n",(0,t.jsx)(o.p,{children:"P2P mode is working, but it fails when you are trying to pass traffic via jitsi-videobridge2."}),"\n",(0,t.jsxs)(o.p,{children:["Check you've got your firewall / NAT set up correctly \u2014 especially UDP 10000. For more information, see ",(0,t.jsx)(o.a,{href:"devops-guide/devops-guide-quickstart#setup-and-configure-your-firewall",children:"here"}),"."]}),"\n",(0,t.jsx)(o.h2,{id:"can-i-mute-and-unmute-other-participants",children:"Can I mute and unmute other participants?"}),"\n",(0,t.jsx)(o.p,{children:"If you are the moderator of a conference, you can mute everyone's microphone. You cannot unmute other people's microphones, and they can unmute their microphones at any time."}),"\n",(0,t.jsx)(o.p,{children:'You may want to set some "ground rules" for who can talk and when, just as with any physical meeting or classroom.'}),"\n",(0,t.jsxs)(o.p,{children:['If you would like to limit who can become a moderator, you need to set up your instance of Jitsi and enable "secure domain". Please see ',(0,t.jsx)(o.a,{href:"#4-enable-secure-domain-if-you-are-using-your-instance-of-jitsi",children:"here"})," for more information."]}),"\n",(0,t.jsx)(o.h2,{id:"how-can-i-protect-my-meetings-with-jitsi",children:"How can I protect my meetings with Jitsi?"}),"\n",(0,t.jsx)(o.h3,{id:"1-create-a-strong-room-name",children:(0,t.jsx)(o.em,{children:'1. Create a "strong" room name.'})}),"\n",(0,t.jsx)(o.p,{children:'Use a strong room name, that no one else is likely to be using. Use the name generator on the welcome page, or else generate your own "strong" name.'}),"\n",(0,t.jsxs)(o.p,{children:["For example, on macOS, in the terminal, you can use ",(0,t.jsx)(o.code,{children:"uuidgen"})," to generate a string of letters of numbers (e.g. B741B63E-C5E6-4D82-BAC4-048BE25D8CC7)."]}),"\n",(0,t.jsxs)(o.p,{children:["Your room name would be ",(0,t.jsx)(o.code,{children:"meet.jit.si/B741B63E-C5E6-4D82-BAC4-048BE25D8CC7"})," on the hosted ",(0,t.jsx)(o.code,{children:"meet.jit.si"})," platform."]}),"\n",(0,t.jsx)(o.p,{children:'If you use "test" or "LucysMeeting" "pilates" or similar, then it\'s highly likely that other users will have had the same idea.'}),"\n",(0,t.jsx)(o.h3,{id:"2-use-a-different-room-name-for-each-meeting--conference-you-have",children:(0,t.jsx)(o.em,{children:"2. Use a different room name for each meeting / conference you have."})}),"\n",(0,t.jsx)(o.p,{children:"If you are going to have multiple meetings, ideally use a different room name for each one."}),"\n",(0,t.jsx)(o.p,{children:"If that is not practical, at least use a different room name for each group of people."}),"\n",(0,t.jsx)(o.h3,{id:"3-add-a-password-to-the-room",children:(0,t.jsx)(o.em,{children:"3. Add a password to the room."})}),"\n",(0,t.jsx)(o.p,{children:"Once you have started your room, set a password for it. Only people who have the password can join from that point on, but it does not affect people who have already joined."}),"\n",(0,t.jsx)(o.p,{children:"You will need to tell everyone the password."}),"\n",(0,t.jsx)(o.p,{children:"If they give the password to others, those other people can also join."}),"\n",(0,t.jsx)(o.h3,{id:"4-enable-secure-domain-if-you-are-using-your-instance-of-jitsi",children:(0,t.jsx)(o.em,{children:'4. Enable "secure domain" if you are using your instance of Jitsi.'})}),"\n",(0,t.jsxs)(o.p,{children:["In addition to the tips above, consider enabling the ",(0,t.jsx)(o.a,{href:"https://jitsi.github.io/handbook/docs/devops-guide/secure-domain",children:'"secure domain" configuration'}),". This requires you (or someone else) to enter a username and password to open a room. It also allows you to become a moderator."]}),"\n",(0,t.jsx)(o.h2,{id:"its-working-when-i-connect-from-a-browser-but-not-from-the-ios-or-android-apps",children:"It's working when I connect from a browser, but not from the iOS or Android apps"}),"\n",(0,t.jsxs)(o.p,{children:["This probably means that you are not serving the fullchain for your TLS certificate. You can check if your cert chain\nis properly configured ",(0,t.jsx)(o.a,{href:"https://whatsmychaincert.com/",children:"here"}),"."]}),"\n",(0,t.jsx)(o.p,{children:"In nginx, if you are using Let's Encrypt, you should have a line like this:"}),"\n",(0,t.jsx)(o.p,{children:(0,t.jsx)(o.code,{children:"ssl_certificate /etc/letsencrypt/live/jitsi.example.com/fullchain.pem;"})}),"\n",(0,t.jsx)(o.h2,{id:"can-i-record-and-save-the-video",children:"Can I record and save the video?"}),"\n",(0,t.jsx)(o.p,{children:"Yes. There are multiple methods (using external software or services):"}),"\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.em,{children:"Note"}),": If you want to use a privacy-friendly method, use method 1 or 2."]}),"\n",(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"OBS"}),": Use ",(0,t.jsx)(o.a,{href:"https://obsproject.com/",children:"OBS"})," to record your Session (e.g. your browser window)."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"RTMP-Server"}),": For this you have to setup your own RTMP-Server and then use your RTMP URL + Stream key instead of the Youtube Stream key as described ",(0,t.jsx)(o.a,{href:"https://jitsi.org/blog/live-streaming-with-jitsi-and-youtube/",children:"here"}),". Self-installed Jitsi Meet deployments will need to setup Jibri to do this."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"Dropbox"}),": ",(0,t.jsx)(o.a,{href:"/handbook/docs/dev-guide/dev-guide-web-integrations#creating-the-dropbox-app-for-dropbox-recording-integration",children:"Connect to Dropbox with Jitsi Meet"})," and save the video in the Dropbox."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"Video Services/Websites"}),": Stream your conference to YouTube or other sites (e.g. Twitch) and access the recording there (see ",(0,t.jsx)(o.a,{href:"https://jitsi.org/blog/live-streaming-with-jitsi-and-youtube/",children:"howto"}),"). Self-installed Jitsi Meet deployments will need to setup Jibri to do this."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(o.p,{children:["More methods might be implemented in the future, but are not ready yet (e.g. ",(0,t.jsx)(o.a,{href:"https://github.com/jitsi/jitsi-meet/issues/6014",children:"Local Recording"}),"."]}),"\n",(0,t.jsx)(o.h2,{id:"i-set-the-password-in-meeting-but-it-is-not-working-the-next-time",children:"I set the password in meeting but it is not working the next time"}),"\n",(0,t.jsx)(o.p,{children:"Once the meeting ends it's password also gets removed, so you need to set the password again for next meeting."}),"\n",(0,t.jsx)(o.h2,{id:"how-to-limit-the-number-of-participants",children:"How to limit the number of participants?"}),"\n",(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["Use the command ",(0,t.jsx)(o.code,{children:"prosodyctl about"})," to view the version of prosody and plug directory, similar to the output below."]}),"\n"]}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{children:"Prosody 0.11.6\n\n# Prosody directories\n\nData directory: /var/lib/prosody\n\nConfig directory: /etc/prosody\n\nSource directory: /usr/lib/prosody\n\nPlugin directories:\n\n/usr/share/jitsi-meet/prosody-plugins/\n\n/usr/lib/prosody/modules/\n"})}),"\n",(0,t.jsxs)(o.ol,{start:"2",children:["\n",(0,t.jsxs)(o.li,{children:["Check if there is a ",(0,t.jsx)(o.code,{children:"mod_muc_max_occupants.lua"})," file in your plugin directory."]}),"\n"]}),"\n",(0,t.jsxs)(o.p,{children:["If not, please create a new file ",(0,t.jsx)(o.code,{children:"mod_muc_max_occupants.lua"})," in the plugin directory And copy everything from ",(0,t.jsx)(o.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/resources/prosody-plugins/mod_muc_max_occupants.lua",children:"here"})," to paste."]}),"\n",(0,t.jsx)(o.p,{children:"If it exists, please ignore this step."}),"\n",(0,t.jsxs)(o.p,{children:["3.Edit your ",(0,t.jsx)(o.code,{children:"/etc/prosody/conf.avail/meet.example.com.cfg.lua"})," file and add ",(0,t.jsx)(o.code,{children:"muc_max_occupants"}),' as a module_enabled in the conference.meet.example.com "muc" section.']}),"\n",(0,t.jsxs)(o.p,{children:["Then, add the options below that. You need both ",(0,t.jsx)(o.code,{children:"muc_max_occupants"})," and ",(0,t.jsx)(o.code,{children:"muc_access_whitelist"})," defined."]}),"\n",(0,t.jsx)(o.p,{children:"Example:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{children:'Component "conference.meet.example.com" "muc"\n storage = "memory"\n modules_enabled = {\n "muc_meeting_id";\n "muc_domain_mapper";\n "muc_max_occupants"; \n }\n muc_max_occupants = "5"\n muc_access_whitelist = { "focus@auth.meet.example.com" }\n admins = { "focus@auth.meet.example.com" }\n muc_room_locking = false\n muc_room_default_public_jids = true\n'})}),"\n",(0,t.jsx)(o.p,{children:'Note: the relationship between storage = "" and your prosody version, and you need to modify all storage="" .'}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:'Prosody nightly747 storage = "null"'}),"\n",(0,t.jsx)(o.li,{children:'Prosody 0.10 storage = "none"'}),"\n",(0,t.jsx)(o.li,{children:'Prosody 0.11 storage = "memory"'}),"\n"]}),"\n",(0,t.jsxs)(o.ol,{start:"4",children:["\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:["You need to use the command ",(0,t.jsx)(o.code,{children:"prosodyctl restart"})," to see the effect."]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsxs)(o.p,{children:["If you want to update to use prosody, you can check ",(0,t.jsx)(o.a,{href:"https://community.jitsi.org/t/how-to-how-do-i-update-prosody/72205",children:"here"}),"."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"other-participants-complain-my-screen-sharing-is-very-bright-and-appears-washed-out",children:"Other participants complain my screen sharing is very bright and appears washed out?"}),"\n",(0,t.jsxs)(o.p,{children:["You might have HDR streaming enabled in your OS display or graphic card settings. If you are on Windows, you can quickly toggle HDR on/off using ",(0,t.jsx)(o.code,{children:"Win + Alt + B"})," for all your HDR-capable screens at any time, even while screen sharing."]})]})}function h(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,o,n)=>{n.d(o,{R:()=>s,x:()=>a});var t=n(6540);const i={},r=t.createContext(i);function s(e){const o=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(r.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/04af5f46.24596c65.js b/assets/js/04af5f46.cc025dcf.js similarity index 98% rename from assets/js/04af5f46.24596c65.js rename to assets/js/04af5f46.cc025dcf.js index 0588ea266..88ac55d94 100644 --- a/assets/js/04af5f46.24596c65.js +++ b/assets/js/04af5f46.cc025dcf.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7497],{4530:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var o=i(4848),t=i(8453);const s={id:"secure-domain",title:"Secure Domain setup",sidebar_label:"Authentication (Secure Domain)"},a=void 0,r={id:"devops-guide/secure-domain",title:"Secure Domain setup",description:"It is possible to allow only authenticated users to create new conference",source:"@site/docs/devops-guide/secure-domain.md",sourceDirName:"devops-guide",slug:"/devops-guide/secure-domain",permalink:"/handbook/docs/devops-guide/secure-domain",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/secure-domain.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"secure-domain",title:"Secure Domain setup",sidebar_label:"Authentication (Secure Domain)"},sidebar:"docs",previous:{title:"Configuration",permalink:"/handbook/docs/category/configuration"},next:{title:"LDAP Authentication",permalink:"/handbook/docs/devops-guide/ldap-authentication"}},c={},d=[{value:"Prosody configuration",id:"prosody-configuration",level:2},{value:"Enable authentication",id:"enable-authentication",level:3},{value:"Enable anonymous login for guests",id:"enable-anonymous-login-for-guests",level:3},{value:"Jitsi Meet configuration",id:"jitsi-meet-configuration",level:2},{value:"Jicofo configuration",id:"jicofo-configuration",level:2},{value:"Create users in Prosody (internal auth)",id:"create-users-in-prosody-internal-auth",level:2},{value:"Optional: Jigasi configuration",id:"optional-jigasi-configuration",level:2},{value:"Enable Authentication",id:"enable-authentication-1",level:3},{value:"Debugging",id:"debugging",level:3}];function l(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"It is possible to allow only authenticated users to create new conference\nrooms. Whenever a new room is about to be created, Jitsi Meet will prompt for\na user name and password. After the room is created, others will be able to join\nfrom anonymous domain. Here's what has to be configured:"}),"\n",(0,o.jsx)(n.h2,{id:"prosody-configuration",children:"Prosody configuration"}),"\n",(0,o.jsxs)(n.p,{children:["If you have installed Jitsi Meet from the Debian package, these changes should be made in ",(0,o.jsx)(n.code,{children:"/etc/prosody/conf.avail/[your-hostname].cfg.lua"})]}),"\n",(0,o.jsx)(n.h3,{id:"enable-authentication",children:"Enable authentication"}),"\n",(0,o.jsxs)(n.p,{children:["Inside the ",(0,o.jsx)(n.code,{children:'VirtualHost "[your-hostname]"'})," block, replace anonymous authentication with hashed password authentication:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'VirtualHost "jitsi-meet.example.com"\n authentication = "internal_hashed"\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Replace ",(0,o.jsx)(n.code,{children:"jitsi-meet.example.com"})," with your hostname."]}),"\n",(0,o.jsx)(n.h3,{id:"enable-anonymous-login-for-guests",children:"Enable anonymous login for guests"}),"\n",(0,o.jsxs)(n.p,{children:["Add this block ",(0,o.jsx)(n.strong,{children:"after the previous VirtualHost"})," to enable the anonymous login method for guests:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'VirtualHost "guest.jitsi-meet.example.com"\n authentication = "anonymous"\n c2s_require_encryption = false\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsxs)(n.em,{children:["Note that ",(0,o.jsx)(n.code,{children:"guest.jitsi-meet.example.com"})," is internal to Jitsi, and you do not need to (and should not) create a DNS record for it, or generate an SSL/TLS certificate, or do any web server configuration. While it is internal, you should still replace ",(0,o.jsx)(n.code,{children:"jitsi-meet.example.com"})," with your hostname."]})}),"\n",(0,o.jsx)(n.h2,{id:"jitsi-meet-configuration",children:"Jitsi Meet configuration"}),"\n",(0,o.jsxs)(n.p,{children:["In config.js, the ",(0,o.jsx)(n.code,{children:"anonymousdomain"})," options has to be set."]}),"\n",(0,o.jsxs)(n.p,{children:["If you have installed jitsi-meet from the Debian package, these changes should be made in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/meet/[your-hostname]-config.js"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"var config = {\n hosts: {\n domain: 'jitsi-meet.example.com',\n anonymousdomain: 'guest.jitsi-meet.example.com',\n ...\n },\n ...\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"jicofo-configuration",children:"Jicofo configuration"}),"\n",(0,o.jsxs)(n.p,{children:["When running Jicofo, specify your main domain in an additional configuration\nproperty. Jicofo will accept conference allocation requests only from the\nauthenticated domain. This should go as a new 'authentication' section in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/jicofo/jicofo.conf"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"jicofo {\n authentication: {\n enabled: true\n type: XMPP\n login-url: jitsi-meet.example.com\n }\n ...\n"})}),"\n",(0,o.jsxs)(n.p,{children:["When using token based authentication, the type must use ",(0,o.jsx)(n.code,{children:"JWT"})," as the scheme instead:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"jicofo {\n authentication: {\n enabled: true\n type: JWT\n login-url: jitsi-meet.example.com\n }\n ...\n"})}),"\n",(0,o.jsx)(n.h2,{id:"create-users-in-prosody-internal-auth",children:"Create users in Prosody (internal auth)"}),"\n",(0,o.jsxs)(n.p,{children:["Finally, run ",(0,o.jsx)(n.code,{children:"prosodyctl"})," to create a user in Prosody:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"sudo prosodyctl register jitsi-meet.example.com \n"})}),"\n",(0,o.jsx)(n.p,{children:"and then restart prosody, jicofo and jitsi-videobridge2"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"systemctl restart prosody\nsystemctl restart jicofo\nsystemctl restart jitsi-videobridge2\n"})}),"\n",(0,o.jsxs)(n.admonition,{type:"note",children:[(0,o.jsxs)(n.p,{children:["Docker users may require an alternate config path. Users of the official ",(0,o.jsx)(n.a,{href:"https://github.com/jitsi/docker-jitsi-meet",children:(0,o.jsx)(n.code,{children:"jitsi/prosody"})})," image should invoke ",(0,o.jsx)(n.code,{children:"prosodyctl"})," as follows."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"prosodyctl --config /config/prosody.cfg.lua register meet.jitsi \n"})}),(0,o.jsxs)(n.p,{children:["Full documentation for ",(0,o.jsx)(n.code,{children:"prosodyctl"})," can be found on ",(0,o.jsx)(n.a,{href:"https://prosody.im/doc/prosodyctl",children:"the official site"}),"."]})]}),"\n",(0,o.jsx)(n.h2,{id:"optional-jigasi-configuration",children:"Optional: Jigasi configuration"}),"\n",(0,o.jsx)(n.h3,{id:"enable-authentication-1",children:"Enable Authentication"}),"\n",(0,o.jsxs)(n.p,{children:["If you are using Jigasi, set it to authenticate by editing the following lines in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/jigasi/sip-communicator.properties"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"org.jitsi.jigasi.xmpp.acc.USER_ID=SOME_USER@SOME_DOMAIN\norg.jitsi.jigasi.xmpp.acc.PASS=SOME_PASS\norg.jitsi.jigasi.xmpp.acc.ANONYMOUS_AUTH=false\n"})}),"\n",(0,o.jsx)(n.p,{children:"Note that the password is the actual plaintext password, not a base64 encoding."}),"\n",(0,o.jsx)(n.h3,{id:"debugging",children:"Debugging"}),"\n",(0,o.jsxs)(n.p,{children:["If you experience problems with a certificate chain, you may need to uncomment the following line, also in ",(0,o.jsx)(n.code,{children:"sip-communicator.properties"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"net.java.sip.communicator.service.gui.ALWAYS_TRUST_MODE_ENABLED=true\n"})}),"\n",(0,o.jsx)(n.admonition,{type:"note",children:(0,o.jsx)(n.p,{children:"This should only be used for testing/debugging purposes, or in controlled environments. If you confirm that this is the problem, you should then solve it in another way (e.g. get a signed certificate for Prosody, or add the particular certificate to Jigasi\u2019s trust store)."})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var o=i(6540);const t={},s=o.createContext(t);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7497],{4530:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var o=i(4848),t=i(8453);const s={id:"secure-domain",title:"Secure Domain setup",sidebar_label:"Authentication (Secure Domain)"},a=void 0,r={id:"devops-guide/secure-domain",title:"Secure Domain setup",description:"It is possible to allow only authenticated users to create new conference",source:"@site/docs/devops-guide/secure-domain.md",sourceDirName:"devops-guide",slug:"/devops-guide/secure-domain",permalink:"/handbook/docs/devops-guide/secure-domain",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/secure-domain.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"secure-domain",title:"Secure Domain setup",sidebar_label:"Authentication (Secure Domain)"},sidebar:"docs",previous:{title:"Configuration",permalink:"/handbook/docs/category/configuration"},next:{title:"LDAP Authentication",permalink:"/handbook/docs/devops-guide/ldap-authentication"}},c={},d=[{value:"Prosody configuration",id:"prosody-configuration",level:2},{value:"Enable authentication",id:"enable-authentication",level:3},{value:"Enable anonymous login for guests",id:"enable-anonymous-login-for-guests",level:3},{value:"Jitsi Meet configuration",id:"jitsi-meet-configuration",level:2},{value:"Jicofo configuration",id:"jicofo-configuration",level:2},{value:"Create users in Prosody (internal auth)",id:"create-users-in-prosody-internal-auth",level:2},{value:"Optional: Jigasi configuration",id:"optional-jigasi-configuration",level:2},{value:"Enable Authentication",id:"enable-authentication-1",level:3},{value:"Debugging",id:"debugging",level:3}];function l(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"It is possible to allow only authenticated users to create new conference\nrooms. Whenever a new room is about to be created, Jitsi Meet will prompt for\na user name and password. After the room is created, others will be able to join\nfrom anonymous domain. Here's what has to be configured:"}),"\n",(0,o.jsx)(n.h2,{id:"prosody-configuration",children:"Prosody configuration"}),"\n",(0,o.jsxs)(n.p,{children:["If you have installed Jitsi Meet from the Debian package, these changes should be made in ",(0,o.jsx)(n.code,{children:"/etc/prosody/conf.avail/[your-hostname].cfg.lua"})]}),"\n",(0,o.jsx)(n.h3,{id:"enable-authentication",children:"Enable authentication"}),"\n",(0,o.jsxs)(n.p,{children:["Inside the ",(0,o.jsx)(n.code,{children:'VirtualHost "[your-hostname]"'})," block, replace anonymous authentication with hashed password authentication:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'VirtualHost "jitsi-meet.example.com"\n authentication = "internal_hashed"\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Replace ",(0,o.jsx)(n.code,{children:"jitsi-meet.example.com"})," with your hostname."]}),"\n",(0,o.jsx)(n.h3,{id:"enable-anonymous-login-for-guests",children:"Enable anonymous login for guests"}),"\n",(0,o.jsxs)(n.p,{children:["Add this block ",(0,o.jsx)(n.strong,{children:"after the previous VirtualHost"})," to enable the anonymous login method for guests:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'VirtualHost "guest.jitsi-meet.example.com"\n authentication = "anonymous"\n c2s_require_encryption = false\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsxs)(n.em,{children:["Note that ",(0,o.jsx)(n.code,{children:"guest.jitsi-meet.example.com"})," is internal to Jitsi, and you do not need to (and should not) create a DNS record for it, or generate an SSL/TLS certificate, or do any web server configuration. While it is internal, you should still replace ",(0,o.jsx)(n.code,{children:"jitsi-meet.example.com"})," with your hostname."]})}),"\n",(0,o.jsx)(n.h2,{id:"jitsi-meet-configuration",children:"Jitsi Meet configuration"}),"\n",(0,o.jsxs)(n.p,{children:["In config.js, the ",(0,o.jsx)(n.code,{children:"anonymousdomain"})," options has to be set."]}),"\n",(0,o.jsxs)(n.p,{children:["If you have installed jitsi-meet from the Debian package, these changes should be made in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/meet/[your-hostname]-config.js"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"var config = {\n hosts: {\n domain: 'jitsi-meet.example.com',\n anonymousdomain: 'guest.jitsi-meet.example.com',\n ...\n },\n ...\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"jicofo-configuration",children:"Jicofo configuration"}),"\n",(0,o.jsxs)(n.p,{children:["When running Jicofo, specify your main domain in an additional configuration\nproperty. Jicofo will accept conference allocation requests only from the\nauthenticated domain. This should go as a new 'authentication' section in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/jicofo/jicofo.conf"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"jicofo {\n authentication: {\n enabled: true\n type: XMPP\n login-url: jitsi-meet.example.com\n }\n ...\n"})}),"\n",(0,o.jsxs)(n.p,{children:["When using token based authentication, the type must use ",(0,o.jsx)(n.code,{children:"JWT"})," as the scheme instead:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"jicofo {\n authentication: {\n enabled: true\n type: JWT\n login-url: jitsi-meet.example.com\n }\n ...\n"})}),"\n",(0,o.jsx)(n.h2,{id:"create-users-in-prosody-internal-auth",children:"Create users in Prosody (internal auth)"}),"\n",(0,o.jsxs)(n.p,{children:["Finally, run ",(0,o.jsx)(n.code,{children:"prosodyctl"})," to create a user in Prosody:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"sudo prosodyctl register jitsi-meet.example.com \n"})}),"\n",(0,o.jsx)(n.p,{children:"and then restart prosody, jicofo and jitsi-videobridge2"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"systemctl restart prosody\nsystemctl restart jicofo\nsystemctl restart jitsi-videobridge2\n"})}),"\n",(0,o.jsxs)(n.admonition,{type:"note",children:[(0,o.jsxs)(n.p,{children:["Docker users may require an alternate config path. Users of the official ",(0,o.jsx)(n.a,{href:"https://github.com/jitsi/docker-jitsi-meet",children:(0,o.jsx)(n.code,{children:"jitsi/prosody"})})," image should invoke ",(0,o.jsx)(n.code,{children:"prosodyctl"})," as follows."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"prosodyctl --config /config/prosody.cfg.lua register meet.jitsi \n"})}),(0,o.jsxs)(n.p,{children:["Full documentation for ",(0,o.jsx)(n.code,{children:"prosodyctl"})," can be found on ",(0,o.jsx)(n.a,{href:"https://prosody.im/doc/prosodyctl",children:"the official site"}),"."]})]}),"\n",(0,o.jsx)(n.h2,{id:"optional-jigasi-configuration",children:"Optional: Jigasi configuration"}),"\n",(0,o.jsx)(n.h3,{id:"enable-authentication-1",children:"Enable Authentication"}),"\n",(0,o.jsxs)(n.p,{children:["If you are using Jigasi, set it to authenticate by editing the following lines in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/jigasi/sip-communicator.properties"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"org.jitsi.jigasi.xmpp.acc.USER_ID=SOME_USER@SOME_DOMAIN\norg.jitsi.jigasi.xmpp.acc.PASS=SOME_PASS\norg.jitsi.jigasi.xmpp.acc.ANONYMOUS_AUTH=false\n"})}),"\n",(0,o.jsx)(n.p,{children:"Note that the password is the actual plaintext password, not a base64 encoding."}),"\n",(0,o.jsx)(n.h3,{id:"debugging",children:"Debugging"}),"\n",(0,o.jsxs)(n.p,{children:["If you experience problems with a certificate chain, you may need to uncomment the following line, also in ",(0,o.jsx)(n.code,{children:"sip-communicator.properties"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"net.java.sip.communicator.service.gui.ALWAYS_TRUST_MODE_ENABLED=true\n"})}),"\n",(0,o.jsx)(n.admonition,{type:"note",children:(0,o.jsx)(n.p,{children:"This should only be used for testing/debugging purposes, or in controlled environments. If you confirm that this is the problem, you should then solve it in another way (e.g. get a signed certificate for Prosody, or add the particular certificate to Jigasi\u2019s trust store)."})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var o=i(6540);const t={},s=o.createContext(t);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/095cc5b8.bbd6bbff.js b/assets/js/095cc5b8.2caf14d1.js similarity index 98% rename from assets/js/095cc5b8.bbd6bbff.js rename to assets/js/095cc5b8.2caf14d1.js index e114fe6dc..e85fb9c1b 100644 --- a/assets/js/095cc5b8.bbd6bbff.js +++ b/assets/js/095cc5b8.2caf14d1.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[4952],{5902:(e,i,o)=>{o.r(i),o.d(i,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var n=o(4848),s=o(8453);const t={id:"videosipgw",title:"Configuring a video SIP gateway",sidebar_label:"Video SIP gateway"},r=void 0,d={id:"devops-guide/videosipgw",title:"Configuring a video SIP gateway",description:"This document describes how you can configure jitsi-meet to use sipgw jibri and enable rooms in 'Add people dialog'",source:"@site/docs/devops-guide/video-sipgw.md",sourceDirName:"devops-guide",slug:"/devops-guide/videosipgw",permalink:"/handbook/docs/devops-guide/videosipgw",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/video-sipgw.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"videosipgw",title:"Configuring a video SIP gateway",sidebar_label:"Video SIP gateway"},sidebar:"docs",previous:{title:"Speaker Stats",permalink:"/handbook/docs/devops-guide/speakerstats"},next:{title:"Cloud API",permalink:"/handbook/docs/devops-guide/cloud-api"}},c={},a=[{value:"People search service",id:"people-search-service",level:2}];function l(e){const i={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(i.p,{children:["This document describes how you can configure jitsi-meet to use sipgw jibri and enable rooms in 'Add people dialog'\nYou will need a working deployment of jibri configured to use a regular sip video device, for more info check out the ",(0,n.jsx)(i.a,{href:"https://github.com/jitsi/jibri/blob/master/README.md",children:"jibri documentation"}),"."]}),"\n",(0,n.jsxs)(i.p,{children:["This feature is available for non-guests of the system, so this relies on setting in config.js ",(0,n.jsx)(i.code,{children:"enableUserRolesBasedOnToken: true"})," and providing a jwt token when accessing the conference."]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"Jicofo configuration:\nedit /etc/jitsi/jicofo/sip-communicator.properties (or similar), set the appropriate MUC to look for the Jibri Controllers. This should be the same MUC as is referenced in jibri's config.json file. Restart Jicofo after setting this property."}),"\n"]}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:" org.jitsi.jicofo.jibri.SIP_BREWERY=TheSipBrewery@conference.yourdomain.com\n"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"Jitsi Meet configuration:"}),"\n"]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"config.js: add"}),"\n"]}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:" enableUserRolesBasedOnToken: true,\n peopleSearchQueryTypes: ['conferenceRooms'],\n peopleSearchUrl: 'https://api.yourdomain.com/testpath/searchpeople',\n"})}),"\n",(0,n.jsx)(i.p,{children:"The combination of the above settings and providing a jwt token will enable a button under invite option which will show the dialog 'Add people'."}),"\n",(0,n.jsx)(i.h2,{id:"people-search-service",children:"People search service"}),"\n",(0,n.jsxs)(i.p,{children:["When searching in the dialog, a request for results is made to the ",(0,n.jsx)(i.code,{children:"peopleSearchUrl"})," service."]}),"\n",(0,n.jsx)(i.p,{children:"The request is in the following format:"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:"https://api.yourdomain.com/testpath/searchpeople?query=testroomname&queryTypes=[%22conferenceRooms%22]&jwt=somejwt\n"})}),"\n",(0,n.jsx)(i.p,{children:"The parameters are:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"query - The text entered by the user."}),"\n",(0,n.jsxs)(i.li,{children:["queryTypes - What type of results we want people, rooms, conferenceRooms. This is the value from config.js ",(0,n.jsx)(i.code,{children:"peopleSearchQueryTypes"})]}),"\n",(0,n.jsx)(i.li,{children:"jwt - The token used by the user to access the conference."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"The response of the service is a json in the following format:"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:'[\n {\n "id": "address@sip.domain.com",\n "name": "Some room name",\n "type": "videosipgw"\n },\n {\n "id": "address2@sip.domain.com",\n "name": "Some room name2",\n "type": "videosipgw"\n }\n]\n'})}),"\n",(0,n.jsxs)(i.p,{children:["Type should be ",(0,n.jsx)(i.code,{children:"videosipgw"}),", ",(0,n.jsx)(i.code,{children:"name"})," is the name shown to the user and ",(0,n.jsx)(i.code,{children:"id"})," is the sip address to be called by the sipgw jibri."]})]})}function p(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,i,o)=>{o.d(i,{R:()=>r,x:()=>d});var n=o(6540);const s={},t=n.createContext(s);function r(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[4952],{5902:(e,i,o)=>{o.r(i),o.d(i,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var n=o(4848),s=o(8453);const t={id:"videosipgw",title:"Configuring a video SIP gateway",sidebar_label:"Video SIP gateway"},r=void 0,d={id:"devops-guide/videosipgw",title:"Configuring a video SIP gateway",description:"This document describes how you can configure jitsi-meet to use sipgw jibri and enable rooms in 'Add people dialog'",source:"@site/docs/devops-guide/video-sipgw.md",sourceDirName:"devops-guide",slug:"/devops-guide/videosipgw",permalink:"/handbook/docs/devops-guide/videosipgw",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/video-sipgw.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"videosipgw",title:"Configuring a video SIP gateway",sidebar_label:"Video SIP gateway"},sidebar:"docs",previous:{title:"Speaker Stats",permalink:"/handbook/docs/devops-guide/speakerstats"},next:{title:"Cloud API",permalink:"/handbook/docs/devops-guide/cloud-api"}},c={},a=[{value:"People search service",id:"people-search-service",level:2}];function l(e){const i={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(i.p,{children:["This document describes how you can configure jitsi-meet to use sipgw jibri and enable rooms in 'Add people dialog'\nYou will need a working deployment of jibri configured to use a regular sip video device, for more info check out the ",(0,n.jsx)(i.a,{href:"https://github.com/jitsi/jibri/blob/master/README.md",children:"jibri documentation"}),"."]}),"\n",(0,n.jsxs)(i.p,{children:["This feature is available for non-guests of the system, so this relies on setting in config.js ",(0,n.jsx)(i.code,{children:"enableUserRolesBasedOnToken: true"})," and providing a jwt token when accessing the conference."]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"Jicofo configuration:\nedit /etc/jitsi/jicofo/sip-communicator.properties (or similar), set the appropriate MUC to look for the Jibri Controllers. This should be the same MUC as is referenced in jibri's config.json file. Restart Jicofo after setting this property."}),"\n"]}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:" org.jitsi.jicofo.jibri.SIP_BREWERY=TheSipBrewery@conference.yourdomain.com\n"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"Jitsi Meet configuration:"}),"\n"]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"config.js: add"}),"\n"]}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:" enableUserRolesBasedOnToken: true,\n peopleSearchQueryTypes: ['conferenceRooms'],\n peopleSearchUrl: 'https://api.yourdomain.com/testpath/searchpeople',\n"})}),"\n",(0,n.jsx)(i.p,{children:"The combination of the above settings and providing a jwt token will enable a button under invite option which will show the dialog 'Add people'."}),"\n",(0,n.jsx)(i.h2,{id:"people-search-service",children:"People search service"}),"\n",(0,n.jsxs)(i.p,{children:["When searching in the dialog, a request for results is made to the ",(0,n.jsx)(i.code,{children:"peopleSearchUrl"})," service."]}),"\n",(0,n.jsx)(i.p,{children:"The request is in the following format:"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:"https://api.yourdomain.com/testpath/searchpeople?query=testroomname&queryTypes=[%22conferenceRooms%22]&jwt=somejwt\n"})}),"\n",(0,n.jsx)(i.p,{children:"The parameters are:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:"query - The text entered by the user."}),"\n",(0,n.jsxs)(i.li,{children:["queryTypes - What type of results we want people, rooms, conferenceRooms. This is the value from config.js ",(0,n.jsx)(i.code,{children:"peopleSearchQueryTypes"})]}),"\n",(0,n.jsx)(i.li,{children:"jwt - The token used by the user to access the conference."}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"The response of the service is a json in the following format:"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{children:'[\n {\n "id": "address@sip.domain.com",\n "name": "Some room name",\n "type": "videosipgw"\n },\n {\n "id": "address2@sip.domain.com",\n "name": "Some room name2",\n "type": "videosipgw"\n }\n]\n'})}),"\n",(0,n.jsxs)(i.p,{children:["Type should be ",(0,n.jsx)(i.code,{children:"videosipgw"}),", ",(0,n.jsx)(i.code,{children:"name"})," is the name shown to the user and ",(0,n.jsx)(i.code,{children:"id"})," is the sip address to be called by the sipgw jibri."]})]})}function p(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,i,o)=>{o.d(i,{R:()=>r,x:()=>d});var n=o(6540);const s={},t=n.createContext(s);function r(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.89041e2c.js b/assets/js/0e384e19.d3cac7c0.js similarity index 98% rename from assets/js/0e384e19.89041e2c.js rename to assets/js/0e384e19.d3cac7c0.js index 11b2c1103..c20e4d431 100644 --- a/assets/js/0e384e19.89041e2c.js +++ b/assets/js/0e384e19.d3cac7c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3976],{619:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var o=n(4848),i=n(8453);const s={id:"intro",title:"Introduction"},r=void 0,a={id:"intro",title:"Introduction",description:"What is Jitsi?",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/handbook/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/intro.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"intro",title:"Introduction"},sidebar:"docs",next:{title:"Architecture",permalink:"/handbook/docs/architecture"}},d={},c=[{value:"What is Jitsi?",id:"what-is-jitsi",level:2},{value:"About this handbook",id:"about-this-handbook",level:2},{value:"JaaS customers",id:"jaas-customers",level:2}];function h(e){const t={a:"a",admonition:"admonition",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"what-is-jitsi",children:"What is Jitsi?"}),"\n",(0,o.jsxs)(t.p,{children:["Jitsi is a ",(0,o.jsx)(t.a,{href:"/handbook/docs/architecture",children:"collection of Open Source projects"})," which provide state-of-the-art video conferencing\ncapabilities that are secure, easy to use, and easy to self-host."]}),"\n",(0,o.jsx)(t.h2,{id:"about-this-handbook",children:"About this handbook"}),"\n",(0,o.jsx)(t.p,{children:"This handbook aims to be the one-stop shop for all Jitsi documentation."}),"\n",(0,o.jsx)(t.admonition,{title:"It's work in progress.",type:"note",children:(0,o.jsxs)(t.p,{children:["If you want to help, please create a ",(0,o.jsx)(t.strong,{children:"Pull Request"})," in our ",(0,o.jsx)(t.a,{href:"https://github.com/jitsi/handbook",children:"GitHub repository"}),"!"]})}),"\n",(0,o.jsx)(t.p,{children:"The content is divided into 3 main areas:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.a,{href:"/docs/category/user-guide",children:"User guide"}),": Designed to help users of the service, to better\nunderstand all the available features and how to use them."]}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.a,{href:"/docs/category/developer-guide",children:"Developer guide"}),": Designed to help developers who want to either\nintegrate the Jitsi Meet API / SDK in their products or want to improve Jitsi Meet\nitself by developing new features or fixing bugs."]}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.a,{href:"/handbook/docs/devops-guide/",children:"Self-Hosting guide"}),": Designed for folks wanting to self-host, system administrators\nor anyone who wishes to deploy and operate their own Jitsi Meet instance."]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"jaas-customers",children:"JaaS customers"}),"\n",(0,o.jsxs)(t.p,{children:["Are you a JaaS customer? If so, please start ",(0,o.jsx)(t.a,{href:"https://developer.8x8.com/jaas/docs/jaas-onboarding",children:"here"}),"."]})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var o=n(6540);const i={},s=o.createContext(i);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3976],{619:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var o=n(4848),i=n(8453);const s={id:"intro",title:"Introduction"},r=void 0,a={id:"intro",title:"Introduction",description:"What is Jitsi?",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/handbook/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/intro.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"intro",title:"Introduction"},sidebar:"docs",next:{title:"Architecture",permalink:"/handbook/docs/architecture"}},d={},c=[{value:"What is Jitsi?",id:"what-is-jitsi",level:2},{value:"About this handbook",id:"about-this-handbook",level:2},{value:"JaaS customers",id:"jaas-customers",level:2}];function h(e){const t={a:"a",admonition:"admonition",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"what-is-jitsi",children:"What is Jitsi?"}),"\n",(0,o.jsxs)(t.p,{children:["Jitsi is a ",(0,o.jsx)(t.a,{href:"/handbook/docs/architecture",children:"collection of Open Source projects"})," which provide state-of-the-art video conferencing\ncapabilities that are secure, easy to use, and easy to self-host."]}),"\n",(0,o.jsx)(t.h2,{id:"about-this-handbook",children:"About this handbook"}),"\n",(0,o.jsx)(t.p,{children:"This handbook aims to be the one-stop shop for all Jitsi documentation."}),"\n",(0,o.jsx)(t.admonition,{title:"It's work in progress.",type:"note",children:(0,o.jsxs)(t.p,{children:["If you want to help, please create a ",(0,o.jsx)(t.strong,{children:"Pull Request"})," in our ",(0,o.jsx)(t.a,{href:"https://github.com/jitsi/handbook",children:"GitHub repository"}),"!"]})}),"\n",(0,o.jsx)(t.p,{children:"The content is divided into 3 main areas:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.a,{href:"/docs/category/user-guide",children:"User guide"}),": Designed to help users of the service, to better\nunderstand all the available features and how to use them."]}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.a,{href:"/docs/category/developer-guide",children:"Developer guide"}),": Designed to help developers who want to either\nintegrate the Jitsi Meet API / SDK in their products or want to improve Jitsi Meet\nitself by developing new features or fixing bugs."]}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.a,{href:"/handbook/docs/devops-guide/",children:"Self-Hosting guide"}),": Designed for folks wanting to self-host, system administrators\nor anyone who wishes to deploy and operate their own Jitsi Meet instance."]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"jaas-customers",children:"JaaS customers"}),"\n",(0,o.jsxs)(t.p,{children:["Are you a JaaS customer? If so, please start ",(0,o.jsx)(t.a,{href:"https://developer.8x8.com/jaas/docs/jaas-onboarding",children:"here"}),"."]})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var o=n(6540);const i={},s=o.createContext(i);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1107b5bf.44dd8b24.js b/assets/js/1107b5bf.4a73bf14.js similarity index 98% rename from assets/js/1107b5bf.44dd8b24.js rename to assets/js/1107b5bf.4a73bf14.js index 4678dae21..b78b7a9ec 100644 --- a/assets/js/1107b5bf.44dd8b24.js +++ b/assets/js/1107b5bf.4a73bf14.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[6437],{2149:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var o=t(4848),i=t(8453);const r={id:"faq",title:"FAQ"},s=void 0,d={id:"devops-guide/faq",title:"FAQ",description:"How to migrate away from multiplexing and enable bridge websockets",source:"@site/docs/devops-guide/faq.md",sourceDirName:"devops-guide",slug:"/devops-guide/faq",permalink:"/handbook/docs/devops-guide/faq",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/faq.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"faq",title:"FAQ"},sidebar:"docs",previous:{title:"Video Tutorials",permalink:"/handbook/docs/devops-guide/devops-guide-videotutorials"}},l={},c=[{value:"How to migrate away from multiplexing and enable bridge websockets",id:"how-to-migrate-away-from-multiplexing-and-enable-bridge-websockets",level:2}];function a(e){const n={code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"how-to-migrate-away-from-multiplexing-and-enable-bridge-websockets",children:"How to migrate away from multiplexing and enable bridge websockets"}),"\n",(0,o.jsx)(n.p,{children:"For a while, we were using nginx multiplexing to serve Jitsi Meet's content on https(port 443) and use the same port for running a turn server.\nThis proved to be problematic(you cannot use websockets with this setup) and we moved away from it.\nHere is how to remove multiplexing and enable websockets in favor of WebRTC Data Channels."}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"Dropping multiplexing in nginx"}),"\n"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["delete ",(0,o.jsx)(n.code,{children:"/etc/nginx/modules-enabled/60-jitsi-meet.conf"})]}),"\n",(0,o.jsxs)(n.li,{children:["Then go to ",(0,o.jsx)(n.code,{children:"/etc/nginx/sites-available/your-conf"})," and change your virtual host to listen on 443 instead of 4444."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"2",children:["\n",(0,o.jsx)(n.li,{children:"Edit turnserver config"}),"\n"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["make sure your turnserver is listening on standard port tls port ",(0,o.jsx)(n.code,{children:"5349"}),". Make sure in ",(0,o.jsx)(n.code,{children:"/etc/turnserver.conf"})," you have the following: ",(0,o.jsx)(n.code,{children:"tls-listening-port=5349"})]}),"\n",(0,o.jsxs)(n.li,{children:["In ",(0,o.jsx)(n.code,{children:"/etc/prosody/conf.avail/your-conf.cfg.lua"})," prosody is instructed to announce ",(0,o.jsx)(n.code,{children:"turns"})," turn server on port ",(0,o.jsx)(n.code,{children:"5349"})," by having this line:\n",(0,o.jsx)(n.code,{children:'{ type = "turns", host = "your-domain", port = "5349", transport = "tcp" }'}),". Make sure you replace ",(0,o.jsx)(n.code,{children:"your-domain"})," with the DNS of your deployment."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"3",children:["\n",(0,o.jsxs)(n.li,{children:["Add the bridge websocket location in your nginx config (add it after the ",(0,o.jsx)(n.code,{children:"location = /xmpp-websocket"})," section):"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:' # colibri (JVB) websockets for jvb1\n location ~ ^/colibri-ws/default-id/(.*) {\n proxy_pass http://127.0.0.1:9090/colibri-ws/default-id/$1$is_args$args;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection "upgrade";\n tcp_nodelay on;\n }\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"4",children:["\n",(0,o.jsxs)(n.li,{children:["Enable the websockets in Jitsi Videobridge. Make sure in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/videobridge/jvb.conf"})," you have:"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'videobridge {\n http-servers {\n public {\n port = 9090\n }\n }\n websockets {\n enabled = true\n domain = "your-domain:443"\n tls = true\n }\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Make sure you replace ",(0,o.jsx)(n.code,{children:"your-domain"})," with the DNS of your deployment.\n5. After restarting the bridge (",(0,o.jsx)(n.code,{children:"systemctl restart jitsi-videobridge2"}),") and nginx (",(0,o.jsx)(n.code,{children:"systemctl restart nginx"}),") you are good to go!"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>d});var o=t(6540);const i={},r=o.createContext(i);function s(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[6437],{2149:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var o=t(4848),i=t(8453);const r={id:"faq",title:"FAQ"},s=void 0,d={id:"devops-guide/faq",title:"FAQ",description:"How to migrate away from multiplexing and enable bridge websockets",source:"@site/docs/devops-guide/faq.md",sourceDirName:"devops-guide",slug:"/devops-guide/faq",permalink:"/handbook/docs/devops-guide/faq",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/faq.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"faq",title:"FAQ"},sidebar:"docs",previous:{title:"Video Tutorials",permalink:"/handbook/docs/devops-guide/devops-guide-videotutorials"}},l={},c=[{value:"How to migrate away from multiplexing and enable bridge websockets",id:"how-to-migrate-away-from-multiplexing-and-enable-bridge-websockets",level:2}];function a(e){const n={code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"how-to-migrate-away-from-multiplexing-and-enable-bridge-websockets",children:"How to migrate away from multiplexing and enable bridge websockets"}),"\n",(0,o.jsx)(n.p,{children:"For a while, we were using nginx multiplexing to serve Jitsi Meet's content on https(port 443) and use the same port for running a turn server.\nThis proved to be problematic(you cannot use websockets with this setup) and we moved away from it.\nHere is how to remove multiplexing and enable websockets in favor of WebRTC Data Channels."}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"Dropping multiplexing in nginx"}),"\n"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["delete ",(0,o.jsx)(n.code,{children:"/etc/nginx/modules-enabled/60-jitsi-meet.conf"})]}),"\n",(0,o.jsxs)(n.li,{children:["Then go to ",(0,o.jsx)(n.code,{children:"/etc/nginx/sites-available/your-conf"})," and change your virtual host to listen on 443 instead of 4444."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"2",children:["\n",(0,o.jsx)(n.li,{children:"Edit turnserver config"}),"\n"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["make sure your turnserver is listening on standard port tls port ",(0,o.jsx)(n.code,{children:"5349"}),". Make sure in ",(0,o.jsx)(n.code,{children:"/etc/turnserver.conf"})," you have the following: ",(0,o.jsx)(n.code,{children:"tls-listening-port=5349"})]}),"\n",(0,o.jsxs)(n.li,{children:["In ",(0,o.jsx)(n.code,{children:"/etc/prosody/conf.avail/your-conf.cfg.lua"})," prosody is instructed to announce ",(0,o.jsx)(n.code,{children:"turns"})," turn server on port ",(0,o.jsx)(n.code,{children:"5349"})," by having this line:\n",(0,o.jsx)(n.code,{children:'{ type = "turns", host = "your-domain", port = "5349", transport = "tcp" }'}),". Make sure you replace ",(0,o.jsx)(n.code,{children:"your-domain"})," with the DNS of your deployment."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"3",children:["\n",(0,o.jsxs)(n.li,{children:["Add the bridge websocket location in your nginx config (add it after the ",(0,o.jsx)(n.code,{children:"location = /xmpp-websocket"})," section):"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:' # colibri (JVB) websockets for jvb1\n location ~ ^/colibri-ws/default-id/(.*) {\n proxy_pass http://127.0.0.1:9090/colibri-ws/default-id/$1$is_args$args;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection "upgrade";\n tcp_nodelay on;\n }\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"4",children:["\n",(0,o.jsxs)(n.li,{children:["Enable the websockets in Jitsi Videobridge. Make sure in ",(0,o.jsx)(n.code,{children:"/etc/jitsi/videobridge/jvb.conf"})," you have:"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'videobridge {\n http-servers {\n public {\n port = 9090\n }\n }\n websockets {\n enabled = true\n domain = "your-domain:443"\n tls = true\n }\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Make sure you replace ",(0,o.jsx)(n.code,{children:"your-domain"})," with the DNS of your deployment.\n5. After restarting the bridge (",(0,o.jsx)(n.code,{children:"systemctl restart jitsi-videobridge2"}),") and nginx (",(0,o.jsx)(n.code,{children:"systemctl restart nginx"}),") you are good to go!"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>d});var o=t(6540);const i={},r=o.createContext(i);function s(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/129210bc.4a89eef1.js b/assets/js/129210bc.58bad2cb.js similarity index 98% rename from assets/js/129210bc.4a89eef1.js rename to assets/js/129210bc.58bad2cb.js index 965a108b4..a4725319c 100644 --- a/assets/js/129210bc.4a89eef1.js +++ b/assets/js/129210bc.58bad2cb.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7885],{6697:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>t,default:()=>a,frontMatter:()=>d,metadata:()=>o,toc:()=>c});var i=n(4848),r=n(8453);const d={id:"keyboard-shortcuts",title:"Keyboard shortcuts"},t=void 0,o={id:"user-guide/keyboard-shortcuts",title:"Keyboard shortcuts",description:"* F - Show or hide video thumbnails",source:"@site/docs/user-guide/keyboard-shortcuts.md",sourceDirName:"user-guide",slug:"/user-guide/keyboard-shortcuts",permalink:"/handbook/docs/user-guide/keyboard-shortcuts",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/keyboard-shortcuts.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"keyboard-shortcuts",title:"Keyboard shortcuts"},sidebar:"docs",previous:{title:"Jitsi Meet for Google Calendar",permalink:"/handbook/docs/user-guide/user-guide-jitsi-meet-for-google-calendar"},next:{title:"Basic options",permalink:"/handbook/docs/user-guide/user-guide-basic"}},l={},c=[];function h(e){const s={li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"F"})," - Show or hide video thumbnails"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"M"})," - Mute or unmute your microphone"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"V"})," - Start or stop your camera"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"A"})," - Manage video quality"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"C"})," - Open or close the chat"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"D"})," - Switch between camera and screen sharing"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"P"})," - Show or hide the participants pane"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"R"})," - Raise or lower your hand"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"S"})," - View or exit full screen"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"W"})," - Toggle tile view"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"T"})," - Show participants stats"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"T"})," - Send thumbs up reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"C"})," - Send clap reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"L"})," - Send laugh reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"O"})," - Send surprised reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"B"})," - Send boo reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"S"})," - Send silence reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"G"})," - Toggle GIPHY menu"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"?"})," - Show or hide keyboard shortcuts"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"SPACE"})," - Push to talk"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"0"})," - Focus on your video"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"1"}),"-",(0,i.jsx)("kbd",{children:"9"})," - Focus on another person's video"]}),"\n"]})}function a(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>t,x:()=>o});var i=n(6540);const r={},d=i.createContext(r);function t(e){const s=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7885],{6697:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>t,default:()=>a,frontMatter:()=>d,metadata:()=>o,toc:()=>c});var i=n(4848),r=n(8453);const d={id:"keyboard-shortcuts",title:"Keyboard shortcuts"},t=void 0,o={id:"user-guide/keyboard-shortcuts",title:"Keyboard shortcuts",description:"* F - Show or hide video thumbnails",source:"@site/docs/user-guide/keyboard-shortcuts.md",sourceDirName:"user-guide",slug:"/user-guide/keyboard-shortcuts",permalink:"/handbook/docs/user-guide/keyboard-shortcuts",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/keyboard-shortcuts.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"keyboard-shortcuts",title:"Keyboard shortcuts"},sidebar:"docs",previous:{title:"Jitsi Meet for Google Calendar",permalink:"/handbook/docs/user-guide/user-guide-jitsi-meet-for-google-calendar"},next:{title:"Basic options",permalink:"/handbook/docs/user-guide/user-guide-basic"}},l={},c=[];function h(e){const s={li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"F"})," - Show or hide video thumbnails"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"M"})," - Mute or unmute your microphone"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"V"})," - Start or stop your camera"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"A"})," - Manage video quality"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"C"})," - Open or close the chat"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"D"})," - Switch between camera and screen sharing"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"P"})," - Show or hide the participants pane"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"R"})," - Raise or lower your hand"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"S"})," - View or exit full screen"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"W"})," - Toggle tile view"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"T"})," - Show participants stats"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"T"})," - Send thumbs up reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"C"})," - Send clap reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"L"})," - Send laugh reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"O"})," - Send surprised reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"B"})," - Send boo reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"Alt"})," ",(0,i.jsx)("kbd",{children:"S"})," - Send silence reaction"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"G"})," - Toggle GIPHY menu"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"?"})," - Show or hide keyboard shortcuts"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"SPACE"})," - Push to talk"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"0"})," - Focus on your video"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)("kbd",{children:"1"}),"-",(0,i.jsx)("kbd",{children:"9"})," - Focus on another person's video"]}),"\n"]})}function a(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>t,x:()=>o});var i=n(6540);const r={},d=i.createContext(r);function t(e){const s=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a9b395f.8e558c81.js b/assets/js/1a9b395f.0e9ab5d8.js similarity index 99% rename from assets/js/1a9b395f.8e558c81.js rename to assets/js/1a9b395f.0e9ab5d8.js index 0babea2f1..eb5b90c25 100644 --- a/assets/js/1a9b395f.8e558c81.js +++ b/assets/js/1a9b395f.0e9ab5d8.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2681],{9184:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=s(4848),o=s(8453);const r={id:"devops-guide-log-analyser",title:"Self-Hosting Guide - Log Analyser",sidebar_label:"Log Analyser"},t=void 0,l={id:"devops-guide/devops-guide-log-analyser",title:"Self-Hosting Guide - Log Analyser",description:"Welcome to the Jitsi Meet Log Analyser project! This integration leverages Grafana Loki and OpenTelemetry to enable effective log management and analysis for Jitsi Meet components.",source:"@site/docs/devops-guide/log-analyser.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-log-analyser",permalink:"/handbook/docs/devops-guide/devops-guide-log-analyser",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/log-analyser.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"devops-guide-log-analyser",title:"Self-Hosting Guide - Log Analyser",sidebar_label:"Log Analyser"},sidebar:"docs",previous:{title:"Docker",permalink:"/handbook/docs/devops-guide/devops-guide-docker"},next:{title:"Configuration",permalink:"/handbook/docs/category/configuration"}},a={},d=[{value:"Overview",id:"overview",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Setup",id:"setup",level:3},{value:"Access Grafana",id:"access-grafana",level:3},{value:"Pre-configured Dashboards",id:"pre-configured-dashboards",level:3},{value:"Filtering Logs with LogQL",id:"filtering-logs-with-logql",level:3},{value:"Usage",id:"usage",level:2},{value:"Customizing Dashboards",id:"customizing-dashboards",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Acknowledgements",id:"acknowledgements",level:2}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"Welcome to the Jitsi Meet Log Analyser project! This integration leverages Grafana Loki and OpenTelemetry to enable effective log management and analysis for Jitsi Meet components."}),"\n",(0,i.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(n.p,{children:"This project offers a streamlined setup for collecting, parsing, and visualizing log data generated by Jitsi Meet components. The integration includes:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["A Docker Compose setup file (",(0,i.jsx)(n.code,{children:"log-analyser.yml"}),") for configuring Loki and OpenTelemetry Collector."]}),"\n",(0,i.jsxs)(n.li,{children:["A Docker Compose setup file (",(0,i.jsx)(n.code,{children:"grafana.yml"}),") for configuring Grafana."]}),"\n",(0,i.jsx)(n.li,{children:"A unified Docker Compose command that initiates all services concurrently."}),"\n",(0,i.jsx)(n.li,{children:"Instructions on configuring Grafana with Loki as a log data source for enhanced visualization and analysis."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsx)(n.p,{children:"Before you begin, ensure you have the following installed on your system:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/compose/install/",children:"Docker Compose"})}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"setup",children:"Setup"}),"\n",(0,i.jsx)(n.p,{children:"To set up the project, follow these steps:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Clone the repository:"})}),"\n",(0,i.jsx)(n.p,{children:"Clone the Jitsi Meet repository that contains the necessary Docker Compose files."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/jitsi/docker-jitsi-meet.git\ncd docker-jitsi-meet\n"})}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Update Jitsi Meet Docker Compose Configuration:"})}),"\n",(0,i.jsxs)(n.p,{children:["To enable log collection and analysis, you need to modify the ",(0,i.jsx)(n.code,{children:"docker-compose.yml"})," file for Jitsi Meet components. Add the following configuration to each Jitsi service within the ",(0,i.jsx)(n.code,{children:"docker-compose.yml"})," file:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:'logging:\n driver: "json-file"\n options:\n labels: "service"\n'})}),"\n",(0,i.jsx)(n.p,{children:"This configuration ensures that logs are collected in JSON format and tagged with service labels, which is essential for Loki to properly ingest and index the logs."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Start the Docker containers:"})}),"\n",(0,i.jsx)(n.p,{children:"Use the following command to start all required services, including the Jitsi Meet components, Grafana, Loki, and OpenTelemetry:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"docker-compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d\n"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Explanation:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["The command combines multiple Docker Compose files to launch the entire stack:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"docker-compose.yml"})," launches the Jitsi Meet components."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"log-analyser.yml"})," sets up the log analysis tools, including Loki and OpenTelemetry."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"grafana.yml"})," initializes Grafana for log visualization."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.li,{children:"Logs generated by the Jitsi Meet components are automatically forwarded to Loki via the OpenTelemetry Collector, making them available for analysis in Grafana."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," If you only want to use Grafana for log visualization without the log analysis tools, you can run ",(0,i.jsx)(n.code,{children:"grafana.yml"})," independently. However, for the complete log analysis setup, both ",(0,i.jsx)(n.code,{children:"log-analyser.yml"})," and ",(0,i.jsx)(n.code,{children:"grafana.yml"})," are required."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"access-grafana",children:"Access Grafana"}),"\n",(0,i.jsx)(n.p,{children:"After starting the services, follow these steps to access Grafana:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Open Grafana in your web browser:"})}),"\n",(0,i.jsxs)(n.p,{children:["Navigate to ",(0,i.jsx)(n.a,{href:"http://localhost:3000",children:"http://localhost:3000"})," to access the Grafana interface."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Log in to Grafana:"})}),"\n",(0,i.jsx)(n.p,{children:"Use the default login credentials provided below:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Username:"})," ",(0,i.jsx)(n.code,{children:"admin"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Password:"})," ",(0,i.jsx)(n.code,{children:"admin"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"(It is recommended to change these credentials after the first login for security purposes.)"}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"pre-configured-dashboards",children:"Pre-configured Dashboards"}),"\n",(0,i.jsx)(n.p,{children:"Grafana comes with several pre-configured dashboards specifically designed for monitoring different Jitsi Meet components. These dashboards will be automatically available once you log in to Grafana."}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Important\u2757\ufe0f:"})," For data to appear in these dashboards, logs need to be generated by the Jitsi Meet components. Here are the available dashboards:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Jicofo Dashboard:"})," Visualizes logs related to Jitsi Conference Focus (Jicofo), which handles media and signaling in Jitsi Meet."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"JVB Dashboard:"})," Focuses on Jitsi Videobridge (JVB) logs, showing details on video streaming and performance metrics."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Prosody Dashboard:"})," Monitors Prosody, the XMPP server used by Jitsi Meet for signaling."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Web Dashboard:"})," Displays logs and metrics related to the web frontend of Jitsi Meet."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Jitsi All Dashboard:"})," A comprehensive dashboard that aggregates logs from all Jitsi Meet components."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{src:"https://github.com/user-attachments/assets/2e54833e-4906-4429-81ce-7e56b7bf38d1",alt:"Jitsi Meet Log Analyser Dashboard"})}),"\n",(0,i.jsx)(n.h3,{id:"filtering-logs-with-logql",children:"Filtering Logs with LogQL"}),"\n",(0,i.jsx)(n.p,{children:'Beyond the pre-configured dashboards, you can explore and filter logs in Grafana\'s "Explore" section using LogQL, a powerful query language designed for Loki. Here\u2019s how you can filter and analyze logs:'}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Access the Explore section:"})}),"\n",(0,i.jsxs)(n.p,{children:["In Grafana, navigate to the ",(0,i.jsx)(n.strong,{children:"Explore"})," tab from the left sidebar. This section allows you to run queries on your logs in real-time."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Select the Loki Data Source:"})}),"\n",(0,i.jsxs)(n.p,{children:["In the Explore section, ensure that the ",(0,i.jsx)(n.strong,{children:"Data Source"})," is set to ",(0,i.jsx)(n.strong,{children:"Loki"}),". This is essential because Loki is the backend that stores and manages the log data collected from Jitsi Meet components."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Using LogQL for Filtering:"})}),"\n",(0,i.jsxs)(n.p,{children:["LogQL enables you to create complex queries to filter specific logs. For example, the following LogQL query filters logs for the ",(0,i.jsx)(n.code,{children:"jitsi-jicofo"})," component and parses them:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-logql",children:'{exporter="OTLP"} | json | attributes_attrs_service="jitsi-jicofo"\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Explanation:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:'{exporter="OTLP"}'}),": Selects logs that are exported via OpenTelemetry."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"| json"}),": Parses the log data as JSON, making attributes accessible for filtering."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:'attributes_attrs_service="jitsi-jicofo"'}),": Filters logs where the ",(0,i.jsx)(n.code,{children:"attributes_attrs_service"})," field equals ",(0,i.jsx)(n.code,{children:'"jitsi-jicofo"'}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You can modify the query to filter logs from other components or adjust the criteria according to your needs."}),"\n",(0,i.jsxs)(n.p,{children:["For more details and advanced usage of LogQL, you can refer to the official ",(0,i.jsx)(n.a,{href:"https://grafana.com/docs/loki/latest/logql/",children:"LogQL documentation"})," from Grafana."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{src:"https://github.com/user-attachments/assets/f75c77a6-6f7b-41ae-9efe-855a5b426bdf",alt:"LogQL Query Example"})}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(n.p,{children:"Once the setup is complete, you can start exploring your log data in Grafana. The pre-configured dashboards provide an insightful visualization of the logs collected from Jitsi Meet components. Use these dashboards to:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Parse Logs:"})," View detailed logs collected from various components."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Visualize Logs:"})," Analyze log data through various charts, graphs, and panels to gain insights into system performance and issues."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"customizing-dashboards",children:"Customizing Dashboards"}),"\n",(0,i.jsx)(n.p,{children:"While the pre-configured dashboards provide a solid starting point, you may want to customize them or create new dashboards to suit your specific needs. Here's how you can do that:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Create a New Dashboard:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Go to the Grafana home page, click on the "+" icon on the left sidebar, and select "Dashboard."'}),"\n",(0,i.jsx)(n.li,{children:"Add panels to visualize different metrics or logs by selecting the appropriate data source (Loki) and using LogQL queries."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Customize Existing Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Navigate to an existing dashboard and click on the "Edit" button (pencil icon) on any panel.'}),"\n",(0,i.jsx)(n.li,{children:"Adjust the LogQL query, visualization type, and panel settings to match your requirements."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Save and Share Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"After customizing, save the dashboard. You can also export it as a JSON file to share with others or for backup."}),"\n",(0,i.jsxs)(n.li,{children:["To export the dashboard:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Click on the dashboard title to open the options menu."}),"\n",(0,i.jsxs)(n.li,{children:["Select ",(0,i.jsx)(n.strong,{children:'"Dashboard settings"'})," > ",(0,i.jsx)(n.strong,{children:'"JSON Model"'}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["Click ",(0,i.jsx)(n.strong,{children:'"Download JSON"'})," to save the file locally."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Contribute to Jitsi Meet Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"If you've created or customized a dashboard that could benefit the wider Jitsi community, you can contribute by updating the relevant dashboard JSON file."}),"\n",(0,i.jsxs)(n.li,{children:["Here\u2019s how to do it:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Export the JSON file of your customized dashboard as described above."}),"\n",(0,i.jsxs)(n.li,{children:["Locate the corresponding Jitsi component dashboard JSON file in the repository (e.g., ",(0,i.jsx)(n.code,{children:"jicofo-dashboard.json"}),", ",(0,i.jsx)(n.code,{children:"jvb-dashboard.json"}),")."]}),"\n",(0,i.jsx)(n.li,{children:"Update the existing JSON file with your changes."}),"\n",(0,i.jsx)(n.li,{children:"Submit a pull request to the repository with the updated JSON file and a brief description of the changes you made."}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.li,{children:"This helps improve the pre-configured dashboards and makes your contributions available to all users."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Grafana Provisioning:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"The Jitsi Meet Log Analyser uses Grafana provisioning to manage dashboards. When you update a dashboard JSON file in the repository, it will be automatically provisioned in Grafana when the stack is deployed."}),"\n",(0,i.jsx)(n.li,{children:"This ensures that everyone using the repository gets the latest version of the dashboards without needing to manually import them."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"By following these steps, you can not only customize your own monitoring setup but also contribute improvements back to the Jitsi community."}),"\n",(0,i.jsx)(n.h3,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,i.jsx)(n.p,{children:"If you encounter issues while setting up or using the Jitsi Meet Log Analyser, here are some common problems and their solutions:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Grafana Not Starting:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Check if the Grafana container is running with ",(0,i.jsx)(n.code,{children:"docker ps"})," and inspect logs using ",(0,i.jsx)(n.code,{children:"docker logs grafana"})," for any errors."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"No Logs in Grafana Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Ensure that Jitsi Meet components are generating logs. Clear browser cache, reload Grafana. Ensure OpenTelemetry, Loki, and Grafana containers are all running with ",(0,i.jsx)(n.code,{children:"docker ps"}),", and inspect each container's logs for issues using ",(0,i.jsx)(n.code,{children:"docker logs "}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"OpenTelemetry Collector Not Forwarding Logs:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Check OpenTelemetry's logs with ",(0,i.jsx)(n.code,{children:"docker logs otel"}),", ensure it's connected to the correct endpoints, and verify the log format is correct."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Authentication Failures in Grafana:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Restart Grafana with ",(0,i.jsx)(n.code,{children:"docker restart grafana otel"}),". If still unsuccessful, delete the data volume with ",(0,i.jsx)(n.code,{children:"docker-compose down -v"})," and restart to reset to default credentials (admin/admin)."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Slow Queries:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"If LogQL queries are slow, try optimizing the query in Grafana."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Permission Issues:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"If you encounter permission issues, make sure that Docker has the necessary access rights to the directories where logs are stored."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Docker Network Issues:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Verify Docker network connections, IP range, and restart the network if necessary."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"OpenTelemetry Collector Not Forwarding Logs:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Check OpenTelemetry logs, verify configuration, and ensure log format compatibility."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Docker Containers Failing to Start:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Use ",(0,i.jsx)(n.code,{children:"docker-compose logs"})," to view detailed startup errors, and check for common issues like incorrect configurations."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,i.jsx)(n.p,{children:"We appreciate your interest in the Jitsi Meet Log Analyser project! If you encounter any issues or have questions, feel free to reach out to the project maintainers or contribute to the repository."})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>l});var i=s(6540);const o={},r=i.createContext(o);function t(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2681],{9184:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=s(4848),o=s(8453);const r={id:"devops-guide-log-analyser",title:"Self-Hosting Guide - Log Analyser",sidebar_label:"Log Analyser"},t=void 0,l={id:"devops-guide/devops-guide-log-analyser",title:"Self-Hosting Guide - Log Analyser",description:"Welcome to the Jitsi Meet Log Analyser project! This integration leverages Grafana Loki and OpenTelemetry to enable effective log management and analysis for Jitsi Meet components.",source:"@site/docs/devops-guide/log-analyser.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-log-analyser",permalink:"/handbook/docs/devops-guide/devops-guide-log-analyser",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/log-analyser.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"devops-guide-log-analyser",title:"Self-Hosting Guide - Log Analyser",sidebar_label:"Log Analyser"},sidebar:"docs",previous:{title:"Docker",permalink:"/handbook/docs/devops-guide/devops-guide-docker"},next:{title:"Configuration",permalink:"/handbook/docs/category/configuration"}},a={},d=[{value:"Overview",id:"overview",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Setup",id:"setup",level:3},{value:"Access Grafana",id:"access-grafana",level:3},{value:"Pre-configured Dashboards",id:"pre-configured-dashboards",level:3},{value:"Filtering Logs with LogQL",id:"filtering-logs-with-logql",level:3},{value:"Usage",id:"usage",level:2},{value:"Customizing Dashboards",id:"customizing-dashboards",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Acknowledgements",id:"acknowledgements",level:2}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"Welcome to the Jitsi Meet Log Analyser project! This integration leverages Grafana Loki and OpenTelemetry to enable effective log management and analysis for Jitsi Meet components."}),"\n",(0,i.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(n.p,{children:"This project offers a streamlined setup for collecting, parsing, and visualizing log data generated by Jitsi Meet components. The integration includes:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["A Docker Compose setup file (",(0,i.jsx)(n.code,{children:"log-analyser.yml"}),") for configuring Loki and OpenTelemetry Collector."]}),"\n",(0,i.jsxs)(n.li,{children:["A Docker Compose setup file (",(0,i.jsx)(n.code,{children:"grafana.yml"}),") for configuring Grafana."]}),"\n",(0,i.jsx)(n.li,{children:"A unified Docker Compose command that initiates all services concurrently."}),"\n",(0,i.jsx)(n.li,{children:"Instructions on configuring Grafana with Loki as a log data source for enhanced visualization and analysis."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsx)(n.p,{children:"Before you begin, ensure you have the following installed on your system:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/compose/install/",children:"Docker Compose"})}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"setup",children:"Setup"}),"\n",(0,i.jsx)(n.p,{children:"To set up the project, follow these steps:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Clone the repository:"})}),"\n",(0,i.jsx)(n.p,{children:"Clone the Jitsi Meet repository that contains the necessary Docker Compose files."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/jitsi/docker-jitsi-meet.git\ncd docker-jitsi-meet\n"})}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Update Jitsi Meet Docker Compose Configuration:"})}),"\n",(0,i.jsxs)(n.p,{children:["To enable log collection and analysis, you need to modify the ",(0,i.jsx)(n.code,{children:"docker-compose.yml"})," file for Jitsi Meet components. Add the following configuration to each Jitsi service within the ",(0,i.jsx)(n.code,{children:"docker-compose.yml"})," file:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:'logging:\n driver: "json-file"\n options:\n labels: "service"\n'})}),"\n",(0,i.jsx)(n.p,{children:"This configuration ensures that logs are collected in JSON format and tagged with service labels, which is essential for Loki to properly ingest and index the logs."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Start the Docker containers:"})}),"\n",(0,i.jsx)(n.p,{children:"Use the following command to start all required services, including the Jitsi Meet components, Grafana, Loki, and OpenTelemetry:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"docker-compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d\n"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Explanation:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["The command combines multiple Docker Compose files to launch the entire stack:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"docker-compose.yml"})," launches the Jitsi Meet components."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"log-analyser.yml"})," sets up the log analysis tools, including Loki and OpenTelemetry."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"grafana.yml"})," initializes Grafana for log visualization."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.li,{children:"Logs generated by the Jitsi Meet components are automatically forwarded to Loki via the OpenTelemetry Collector, making them available for analysis in Grafana."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," If you only want to use Grafana for log visualization without the log analysis tools, you can run ",(0,i.jsx)(n.code,{children:"grafana.yml"})," independently. However, for the complete log analysis setup, both ",(0,i.jsx)(n.code,{children:"log-analyser.yml"})," and ",(0,i.jsx)(n.code,{children:"grafana.yml"})," are required."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"access-grafana",children:"Access Grafana"}),"\n",(0,i.jsx)(n.p,{children:"After starting the services, follow these steps to access Grafana:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Open Grafana in your web browser:"})}),"\n",(0,i.jsxs)(n.p,{children:["Navigate to ",(0,i.jsx)(n.a,{href:"http://localhost:3000",children:"http://localhost:3000"})," to access the Grafana interface."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Log in to Grafana:"})}),"\n",(0,i.jsx)(n.p,{children:"Use the default login credentials provided below:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Username:"})," ",(0,i.jsx)(n.code,{children:"admin"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Password:"})," ",(0,i.jsx)(n.code,{children:"admin"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"(It is recommended to change these credentials after the first login for security purposes.)"}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"pre-configured-dashboards",children:"Pre-configured Dashboards"}),"\n",(0,i.jsx)(n.p,{children:"Grafana comes with several pre-configured dashboards specifically designed for monitoring different Jitsi Meet components. These dashboards will be automatically available once you log in to Grafana."}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Important\u2757\ufe0f:"})," For data to appear in these dashboards, logs need to be generated by the Jitsi Meet components. Here are the available dashboards:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Jicofo Dashboard:"})," Visualizes logs related to Jitsi Conference Focus (Jicofo), which handles media and signaling in Jitsi Meet."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"JVB Dashboard:"})," Focuses on Jitsi Videobridge (JVB) logs, showing details on video streaming and performance metrics."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Prosody Dashboard:"})," Monitors Prosody, the XMPP server used by Jitsi Meet for signaling."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Web Dashboard:"})," Displays logs and metrics related to the web frontend of Jitsi Meet."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Jitsi All Dashboard:"})," A comprehensive dashboard that aggregates logs from all Jitsi Meet components."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{src:"https://github.com/user-attachments/assets/2e54833e-4906-4429-81ce-7e56b7bf38d1",alt:"Jitsi Meet Log Analyser Dashboard"})}),"\n",(0,i.jsx)(n.h3,{id:"filtering-logs-with-logql",children:"Filtering Logs with LogQL"}),"\n",(0,i.jsx)(n.p,{children:'Beyond the pre-configured dashboards, you can explore and filter logs in Grafana\'s "Explore" section using LogQL, a powerful query language designed for Loki. Here\u2019s how you can filter and analyze logs:'}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Access the Explore section:"})}),"\n",(0,i.jsxs)(n.p,{children:["In Grafana, navigate to the ",(0,i.jsx)(n.strong,{children:"Explore"})," tab from the left sidebar. This section allows you to run queries on your logs in real-time."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Select the Loki Data Source:"})}),"\n",(0,i.jsxs)(n.p,{children:["In the Explore section, ensure that the ",(0,i.jsx)(n.strong,{children:"Data Source"})," is set to ",(0,i.jsx)(n.strong,{children:"Loki"}),". This is essential because Loki is the backend that stores and manages the log data collected from Jitsi Meet components."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Using LogQL for Filtering:"})}),"\n",(0,i.jsxs)(n.p,{children:["LogQL enables you to create complex queries to filter specific logs. For example, the following LogQL query filters logs for the ",(0,i.jsx)(n.code,{children:"jitsi-jicofo"})," component and parses them:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-logql",children:'{exporter="OTLP"} | json | attributes_attrs_service="jitsi-jicofo"\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Explanation:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:'{exporter="OTLP"}'}),": Selects logs that are exported via OpenTelemetry."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"| json"}),": Parses the log data as JSON, making attributes accessible for filtering."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:'attributes_attrs_service="jitsi-jicofo"'}),": Filters logs where the ",(0,i.jsx)(n.code,{children:"attributes_attrs_service"})," field equals ",(0,i.jsx)(n.code,{children:'"jitsi-jicofo"'}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You can modify the query to filter logs from other components or adjust the criteria according to your needs."}),"\n",(0,i.jsxs)(n.p,{children:["For more details and advanced usage of LogQL, you can refer to the official ",(0,i.jsx)(n.a,{href:"https://grafana.com/docs/loki/latest/logql/",children:"LogQL documentation"})," from Grafana."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{src:"https://github.com/user-attachments/assets/f75c77a6-6f7b-41ae-9efe-855a5b426bdf",alt:"LogQL Query Example"})}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(n.p,{children:"Once the setup is complete, you can start exploring your log data in Grafana. The pre-configured dashboards provide an insightful visualization of the logs collected from Jitsi Meet components. Use these dashboards to:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Parse Logs:"})," View detailed logs collected from various components."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Visualize Logs:"})," Analyze log data through various charts, graphs, and panels to gain insights into system performance and issues."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"customizing-dashboards",children:"Customizing Dashboards"}),"\n",(0,i.jsx)(n.p,{children:"While the pre-configured dashboards provide a solid starting point, you may want to customize them or create new dashboards to suit your specific needs. Here's how you can do that:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Create a New Dashboard:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Go to the Grafana home page, click on the "+" icon on the left sidebar, and select "Dashboard."'}),"\n",(0,i.jsx)(n.li,{children:"Add panels to visualize different metrics or logs by selecting the appropriate data source (Loki) and using LogQL queries."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Customize Existing Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Navigate to an existing dashboard and click on the "Edit" button (pencil icon) on any panel.'}),"\n",(0,i.jsx)(n.li,{children:"Adjust the LogQL query, visualization type, and panel settings to match your requirements."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Save and Share Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"After customizing, save the dashboard. You can also export it as a JSON file to share with others or for backup."}),"\n",(0,i.jsxs)(n.li,{children:["To export the dashboard:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Click on the dashboard title to open the options menu."}),"\n",(0,i.jsxs)(n.li,{children:["Select ",(0,i.jsx)(n.strong,{children:'"Dashboard settings"'})," > ",(0,i.jsx)(n.strong,{children:'"JSON Model"'}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["Click ",(0,i.jsx)(n.strong,{children:'"Download JSON"'})," to save the file locally."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Contribute to Jitsi Meet Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"If you've created or customized a dashboard that could benefit the wider Jitsi community, you can contribute by updating the relevant dashboard JSON file."}),"\n",(0,i.jsxs)(n.li,{children:["Here\u2019s how to do it:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Export the JSON file of your customized dashboard as described above."}),"\n",(0,i.jsxs)(n.li,{children:["Locate the corresponding Jitsi component dashboard JSON file in the repository (e.g., ",(0,i.jsx)(n.code,{children:"jicofo-dashboard.json"}),", ",(0,i.jsx)(n.code,{children:"jvb-dashboard.json"}),")."]}),"\n",(0,i.jsx)(n.li,{children:"Update the existing JSON file with your changes."}),"\n",(0,i.jsx)(n.li,{children:"Submit a pull request to the repository with the updated JSON file and a brief description of the changes you made."}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.li,{children:"This helps improve the pre-configured dashboards and makes your contributions available to all users."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Grafana Provisioning:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"The Jitsi Meet Log Analyser uses Grafana provisioning to manage dashboards. When you update a dashboard JSON file in the repository, it will be automatically provisioned in Grafana when the stack is deployed."}),"\n",(0,i.jsx)(n.li,{children:"This ensures that everyone using the repository gets the latest version of the dashboards without needing to manually import them."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"By following these steps, you can not only customize your own monitoring setup but also contribute improvements back to the Jitsi community."}),"\n",(0,i.jsx)(n.h3,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,i.jsx)(n.p,{children:"If you encounter issues while setting up or using the Jitsi Meet Log Analyser, here are some common problems and their solutions:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Grafana Not Starting:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Check if the Grafana container is running with ",(0,i.jsx)(n.code,{children:"docker ps"})," and inspect logs using ",(0,i.jsx)(n.code,{children:"docker logs grafana"})," for any errors."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"No Logs in Grafana Dashboards:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Ensure that Jitsi Meet components are generating logs. Clear browser cache, reload Grafana. Ensure OpenTelemetry, Loki, and Grafana containers are all running with ",(0,i.jsx)(n.code,{children:"docker ps"}),", and inspect each container's logs for issues using ",(0,i.jsx)(n.code,{children:"docker logs "}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"OpenTelemetry Collector Not Forwarding Logs:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Check OpenTelemetry's logs with ",(0,i.jsx)(n.code,{children:"docker logs otel"}),", ensure it's connected to the correct endpoints, and verify the log format is correct."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Authentication Failures in Grafana:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Restart Grafana with ",(0,i.jsx)(n.code,{children:"docker restart grafana otel"}),". If still unsuccessful, delete the data volume with ",(0,i.jsx)(n.code,{children:"docker-compose down -v"})," and restart to reset to default credentials (admin/admin)."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Slow Queries:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"If LogQL queries are slow, try optimizing the query in Grafana."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Permission Issues:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"If you encounter permission issues, make sure that Docker has the necessary access rights to the directories where logs are stored."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Docker Network Issues:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Verify Docker network connections, IP range, and restart the network if necessary."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"OpenTelemetry Collector Not Forwarding Logs:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Check OpenTelemetry logs, verify configuration, and ensure log format compatibility."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Docker Containers Failing to Start:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Use ",(0,i.jsx)(n.code,{children:"docker-compose logs"})," to view detailed startup errors, and check for common issues like incorrect configurations."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,i.jsx)(n.p,{children:"We appreciate your interest in the Jitsi Meet Log Analyser project! If you encounter any issues or have questions, feel free to reach out to the project maintainers or contribute to the repository."})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>l});var i=s(6540);const o={},r=i.createContext(o);function t(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/24f4a563.c0d64fc8.js b/assets/js/24f4a563.b8e1af46.js similarity index 98% rename from assets/js/24f4a563.c0d64fc8.js rename to assets/js/24f4a563.b8e1af46.js index 4ac6ed421..ffe2a0518 100644 --- a/assets/js/24f4a563.c0d64fc8.js +++ b/assets/js/24f4a563.b8e1af46.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3960],{782:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>c,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var o=i(4848),n=i(8453);const s={id:"devops-guide-videotutorials",title:"Video Tutorials"},r=void 0,l={id:"devops-guide/devops-guide-videotutorials",title:"Video Tutorials",description:"Installing Jitsi Meet on your own Linux Server",source:"@site/docs/devops-guide/videotutorials.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-videotutorials",permalink:"/handbook/docs/devops-guide/devops-guide-videotutorials",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/videotutorials.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"devops-guide-videotutorials",title:"Video Tutorials"},sidebar:"docs",previous:{title:"Cloud API",permalink:"/handbook/docs/devops-guide/cloud-api"},next:{title:"FAQ",permalink:"/handbook/docs/devops-guide/faq"}},d={},a=[{value:"Installing Jitsi Meet on your own Linux Server",id:"installing-jitsi-meet-on-your-own-linux-server",level:2},{value:"How to Load Balance Jitsi Meet",id:"how-to-load-balance-jitsi-meet",level:2},{value:"Scaling Jitsi Meet in the Cloud",id:"scaling-jitsi-meet-in-the-cloud",level:2}];function u(e){const t={a:"a",h2:"h2",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"installing-jitsi-meet-on-your-own-linux-server",children:(0,o.jsx)(t.a,{href:"https://jitsi.org/news/new-tutorial-installing-jitsi-meet-on-your-own-linux-server/",children:"Installing Jitsi Meet on your own Linux Server"})}),"\n",(0,o.jsx)("figure",{class:"video-container",children:(0,o.jsx)("iframe",{src:"https://www.youtube.com/embed/8KR0AhDZF2A",frameborder:"0",allow:"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:!0})}),"\n",(0,o.jsx)(t.h2,{id:"how-to-load-balance-jitsi-meet",children:(0,o.jsx)(t.a,{href:"https://jitsi.org/blog/tutorial-video-how-to-load-balance-jitsi-meet/",children:"How to Load Balance Jitsi Meet"})}),"\n",(0,o.jsx)("figure",{class:"video-container",children:(0,o.jsx)("iframe",{src:"https://www.youtube.com/embed/LyGV4uW8km8",frameborder:"0",allow:"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:!0})}),"\n",(0,o.jsx)(t.h2,{id:"scaling-jitsi-meet-in-the-cloud",children:(0,o.jsx)(t.a,{href:"https://jitsi.org/blog/new-tutorial-video-scaling-jitsi-meet-in-the-cloud/",children:"Scaling Jitsi Meet in the Cloud"})}),"\n",(0,o.jsx)("figure",{class:"video-container",children:(0,o.jsx)("iframe",{src:"https://www.youtube.com/embed/Jj8a6ZRgehI",frameborder:"0",allow:"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:!0})})]})}function c(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,t,i)=>{i.d(t,{R:()=>r,x:()=>l});var o=i(6540);const n={},s=o.createContext(n);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3960],{782:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>c,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var o=i(4848),n=i(8453);const s={id:"devops-guide-videotutorials",title:"Video Tutorials"},r=void 0,l={id:"devops-guide/devops-guide-videotutorials",title:"Video Tutorials",description:"Installing Jitsi Meet on your own Linux Server",source:"@site/docs/devops-guide/videotutorials.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-videotutorials",permalink:"/handbook/docs/devops-guide/devops-guide-videotutorials",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/videotutorials.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"devops-guide-videotutorials",title:"Video Tutorials"},sidebar:"docs",previous:{title:"Cloud API",permalink:"/handbook/docs/devops-guide/cloud-api"},next:{title:"FAQ",permalink:"/handbook/docs/devops-guide/faq"}},d={},a=[{value:"Installing Jitsi Meet on your own Linux Server",id:"installing-jitsi-meet-on-your-own-linux-server",level:2},{value:"How to Load Balance Jitsi Meet",id:"how-to-load-balance-jitsi-meet",level:2},{value:"Scaling Jitsi Meet in the Cloud",id:"scaling-jitsi-meet-in-the-cloud",level:2}];function u(e){const t={a:"a",h2:"h2",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"installing-jitsi-meet-on-your-own-linux-server",children:(0,o.jsx)(t.a,{href:"https://jitsi.org/news/new-tutorial-installing-jitsi-meet-on-your-own-linux-server/",children:"Installing Jitsi Meet on your own Linux Server"})}),"\n",(0,o.jsx)("figure",{class:"video-container",children:(0,o.jsx)("iframe",{src:"https://www.youtube.com/embed/8KR0AhDZF2A",frameborder:"0",allow:"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:!0})}),"\n",(0,o.jsx)(t.h2,{id:"how-to-load-balance-jitsi-meet",children:(0,o.jsx)(t.a,{href:"https://jitsi.org/blog/tutorial-video-how-to-load-balance-jitsi-meet/",children:"How to Load Balance Jitsi Meet"})}),"\n",(0,o.jsx)("figure",{class:"video-container",children:(0,o.jsx)("iframe",{src:"https://www.youtube.com/embed/LyGV4uW8km8",frameborder:"0",allow:"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:!0})}),"\n",(0,o.jsx)(t.h2,{id:"scaling-jitsi-meet-in-the-cloud",children:(0,o.jsx)(t.a,{href:"https://jitsi.org/blog/new-tutorial-video-scaling-jitsi-meet-in-the-cloud/",children:"Scaling Jitsi Meet in the Cloud"})}),"\n",(0,o.jsx)("figure",{class:"video-container",children:(0,o.jsx)("iframe",{src:"https://www.youtube.com/embed/Jj8a6ZRgehI",frameborder:"0",allow:"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:!0})})]})}function c(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,t,i)=>{i.d(t,{R:()=>r,x:()=>l});var o=i(6540);const n={},s=o.createContext(n);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/25b664f5.bd70cc61.js b/assets/js/25b664f5.487ea113.js similarity index 66% rename from assets/js/25b664f5.bd70cc61.js rename to assets/js/25b664f5.487ea113.js index 6a3a5e174..7b99b7a02 100644 --- a/assets/js/25b664f5.bd70cc61.js +++ b/assets/js/25b664f5.487ea113.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[4753],{7704:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>a,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(4848),r=i(8453);const d={id:"devops-guide-docker",title:"Self-Hosting Guide - Docker",sidebar_label:"Docker"},t=void 0,c={id:"devops-guide/devops-guide-docker",title:"Self-Hosting Guide - Docker",description:"Quick start",source:"@site/docs/devops-guide/docker.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-docker",permalink:"/handbook/docs/devops-guide/devops-guide-docker",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/docker.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"devops-guide-docker",title:"Self-Hosting Guide - Docker",sidebar_label:"Docker"},sidebar:"docs",previous:{title:"openSUSE",permalink:"/handbook/docs/devops-guide/devops-guide-opensuse"},next:{title:"Log Analyser",permalink:"/handbook/docs/devops-guide/devops-guide-log-analyser"}},o={},l=[{value:"Quick start",id:"quick-start",level:2},{value:"Updating",id:"updating",level:3},{value:"Testing development / unstable builds",id:"testing-development--unstable-builds",level:3},{value:"Building your own images",id:"building-your-own-images",level:3},{value:"Security note",id:"security-note",level:3},{value:"Architecture",id:"architecture",level:2},{value:"External Ports",id:"external-ports",level:3},{value:"Images",id:"images",level:3},{value:"Design considerations",id:"design-considerations",level:3},{value:"Configuration",id:"configuration",level:2},{value:"TLS Configuration",id:"tls-configuration",level:3},{value:"Let's Encrypt configuration",id:"lets-encrypt-configuration",level:4},{value:"Using existing TLS certificate and key",id:"using-existing-tls-certificate-and-key",level:4},{value:"Features configuration (config.js)",id:"features-configuration-configjs",level:3},{value:"Jigasi SIP gateway (audio only) configuration",id:"jigasi-sip-gateway-audio-only-configuration",level:3},{value:"Display Dial-In information",id:"display-dial-in-information",level:4},{value:"Recording / live streaming configuration with Jibri",id:"recording--live-streaming-configuration-with-jibri",level:3},{value:"Jitsi Meet configuration",id:"jitsi-meet-configuration",level:3},{value:"Authentication",id:"authentication",level:3},{value:"Internal authentication",id:"internal-authentication",level:4},{value:"Authentication using LDAP",id:"authentication-using-ldap",level:4},{value:"Authentication using JWT tokens",id:"authentication-using-jwt-tokens",level:4},{value:"Authentication using Matrix",id:"authentication-using-matrix",level:4},{value:"Authentication using Hybrid Matrix Token",id:"authentication-using-hybrid-matrix-token",level:4},{value:"External authentication",id:"external-authentication",level:4},{value:"Shared document editing using Etherpad",id:"shared-document-editing-using-etherpad",level:3},{value:"Transcription configuration",id:"transcription-configuration",level:3},{value:"Sentry logging configuration",id:"sentry-logging-configuration",level:3},{value:"TURN server configuration",id:"turn-server-configuration",level:3},{value:"Advanced configuration",id:"advanced-configuration",level:3},{value:"Advanced Prosody options",id:"advanced-prosody-options",level:4},{value:"Advanced Jicofo options",id:"advanced-jicofo-options",level:4},{value:"Advanced JVB options",id:"advanced-jvb-options",level:4},{value:"Advanced Jigasi options",id:"advanced-jigasi-options",level:4},{value:"Running behind NAT or on a LAN environment",id:"running-behind-nat-or-on-a-lan-environment",level:3},{value:"Split horizon",id:"split-horizon",level:4},{value:"Offline / airgapped installation",id:"offline--airgapped-installation",level:4},{value:"Adjust UDP buffers",id:"adjust-udp-buffers",level:3},{value:"Accessing server logs",id:"accessing-server-logs",level:2},{value:"Build Instructions",id:"build-instructions",level:2},{value:"Running behind a reverse proxy",id:"running-behind-a-reverse-proxy",level:2},{value:"Disable HTTPS",id:"disable-https",level:3},{value:"Do not expose the Jitsi Meet's ports publicly",id:"do-not-expose-the-jitsi-meets-ports-publicly",level:3},{value:"Reverse proxy configuration",id:"reverse-proxy-configuration",level:3},{value:"nginx",id:"nginx",level:4},{value:"Apache",id:"apache",level:4},{value:"Disabling WebSocket connections",id:"disabling-websocket-connections",level:3}];function h(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components},{Details:d}=n;return d||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"quick-start",children:"Quick start"}),"\n",(0,s.jsx)(n.p,{children:"In order to quickly run Jitsi Meet on a machine running Docker and Docker Compose,\nfollow these steps:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Download and extract the ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/docker-jitsi-meet/releases/latest",children:"latest release"}),". ",(0,s.jsx)(n.strong,{children:"DO NOT"})," clone the git repository. See below if you are interested in running test images:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"wget $(curl -s https://api.github.com/repos/jitsi/docker-jitsi-meet/releases/latest | grep 'zip' | cut -d\\\" -f4)\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Unzip the package:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"unzip \n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create a ",(0,s.jsx)(n.code,{children:".env"})," file by copying and adjusting ",(0,s.jsx)(n.code,{children:"env.example"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cp env.example .env\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Set strong passwords in the security section options of ",(0,s.jsx)(n.code,{children:".env"})," file by running the following bash script"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"./gen-passwords.sh\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create required ",(0,s.jsx)(n.code,{children:"CONFIG"})," directories"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"For linux:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"mkdir -p ~/.jitsi-meet-cfg/{web,transcripts,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri}\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"For Windows:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'echo web,transcripts,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri | % { mkdir "~/.jitsi-meet-cfg/$_" }\n'})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Run ",(0,s.jsx)(n.code,{children:"docker compose up -d"})]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Access the web UI at ",(0,s.jsx)(n.a,{href:"https://localhost:8443",children:(0,s.jsx)(n.code,{children:"https://localhost:8443"})})," (or a different port, in case you edited the ",(0,s.jsx)(n.code,{children:".env"})," file)."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["HTTP (not HTTPS) is also available (on port 8000, by default), but that's e.g. for a reverse proxy setup;\ndirect access via HTTP instead HTTPS leads to WebRTC errors such as\n",(0,s.jsx)(n.em,{children:"Failed to access your microphone/camera: Cannot use microphone/camera for an unknown reason. Cannot read property 'getUserMedia' of undefined"}),"\nor ",(0,s.jsx)(n.em,{children:"navigator.mediaDevices is undefined"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IMPORTANT"}),": When deploying Jitsi Meet for real use you must set the ",(0,s.jsx)(n.code,{children:"PUBLIC_URL"})," env variable to the real domain where your setup is running."]}),"\n",(0,s.jsx)(n.p,{children:"If you want to use jigasi too, first configure your env file with SIP credentials\nand then run Docker Compose as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f jigasi.yml up\n"})}),"\n",(0,s.jsxs)(n.p,{children:["If you want to enable document sharing via ",(0,s.jsx)(n.a,{href:"https://github.com/ether/etherpad-lite",children:"Etherpad"}),",\nconfigure it and run Docker Compose as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f etherpad.yml up\n"})}),"\n",(0,s.jsx)(n.p,{children:"If you want to use jibri too, first configure a host as described in Jitsi Broadcasting Infrastructure configuration section\nand then run Docker Compose as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f jibri.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"or to use jigasi too:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f jigasi.yml -f jibri.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"To include a transcriber component, run Docker Compose as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f transcriber.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"Or for them all together:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f transcriber.yml -f jigasi.yml -f jibri.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"For the log analysis project, you will need both log-analyser.yml and grafana.yml files. This project allows you to analyze docker logs in grafana. If you want to run the log analyzer, run the Docker files as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker-compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Follow ",(0,s.jsx)(n.a,{href:"https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-log-analyser",children:"this"})," document for detailed information on log analysis."]}),"\n",(0,s.jsx)(n.h3,{id:"updating",children:"Updating"}),"\n",(0,s.jsx)(n.p,{children:"If you want to update, simply run"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"wget $(curl -s https://api.github.com/repos/jitsi/docker-jitsi-meet/releases/latest | grep 'zip' | cut -d\\\" -f4)\n"})}),"\n",(0,s.jsx)(n.p,{children:"again (just like how you initially downloaded Jitsi). Then unzip and overwrite all when being asked:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"unzip \n"})}),"\n",(0,s.jsx)(n.h3,{id:"testing-development--unstable-builds",children:"Testing development / unstable builds"}),"\n",(0,s.jsx)(n.p,{children:"Download the latest code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/jitsi/docker-jitsi-meet && cd docker-jitsi-meet\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["The code in ",(0,s.jsx)(n.code,{children:"master"})," is designed to work with the unstable images. Do not run it with release images."]})}),"\n",(0,s.jsxs)(n.p,{children:["Run ",(0,s.jsx)(n.code,{children:"docker compose up"})," as usual."]}),"\n",(0,s.jsx)(n.p,{children:'Every day a new "unstable" image build is uploaded.'}),"\n",(0,s.jsx)(n.h3,{id:"building-your-own-images",children:"Building your own images"}),"\n",(0,s.jsx)(n.p,{children:"Download the latest code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/jitsi/docker-jitsi-meet && cd docker-jitsi-meet\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The provided ",(0,s.jsx)(n.code,{children:"Makefile"})," provides a comprehensive way of building the whole stack or individual images."]}),"\n",(0,s.jsx)(n.p,{children:"To build all images:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"make\n"})}),"\n",(0,s.jsx)(n.p,{children:"To build a specific image (the web image for example):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"make build_web\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Once your local build is ready make sure to add ",(0,s.jsx)(n.code,{children:"JITSI_IMAGE_VERSION=latest"})," to your ",(0,s.jsx)(n.code,{children:".env"})," file."]}),"\n",(0,s.jsx)(n.h3,{id:"security-note",children:"Security note"}),"\n",(0,s.jsx)(n.p,{children:"This setup used to have default passwords for internal accounts used across components.\nIn order to make the default setup secure by default these have been removed and the respective containers won't start without having a password set."}),"\n",(0,s.jsxs)(n.p,{children:["Strong passwords may be generated as follows: ",(0,s.jsx)(n.code,{children:"./gen-passwords.sh"}),"\nThis will modify your ",(0,s.jsx)(n.code,{children:".env"})," file (a backup is saved in ",(0,s.jsx)(n.code,{children:".env.bak"}),") and set strong passwords for each of the\nrequired options. Passwords are generated using ",(0,s.jsx)(n.code,{children:"openssl rand -hex 16"})," ."]}),"\n",(0,s.jsx)(n.p,{children:"DO NOT reuse any of the passwords."}),"\n",(0,s.jsx)(n.h2,{id:"architecture",children:"Architecture"}),"\n",(0,s.jsx)(n.p,{children:"A Jitsi Meet installation can be broken down into the following components:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"A web interface"}),"\n",(0,s.jsx)(n.li,{children:"An XMPP server"}),"\n",(0,s.jsx)(n.li,{children:"A conference focus component"}),"\n",(0,s.jsx)(n.li,{children:"A video router (could be more than one)"}),"\n",(0,s.jsx)(n.li,{children:"A SIP gateway for audio calls"}),"\n",(0,s.jsx)(n.li,{children:"A Broadcasting Infrastructure for recording or streaming a conference."}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{src:i(386).A+"",width:"882",height:"505"})}),"\n",(0,s.jsx)(n.p,{children:"The diagram shows a typical deployment in a host running Docker. This project\nseparates each of the components above into interlinked containers. To this end,\nseveral container images are provided."}),"\n",(0,s.jsx)(n.h3,{id:"external-ports",children:"External Ports"}),"\n",(0,s.jsx)(n.p,{children:"The following external ports must be opened on a firewall:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"80/tcp"})," for Web UI HTTP (really just to redirect, after uncommenting ",(0,s.jsx)(n.code,{children:"ENABLE_HTTP_REDIRECT=1"})," in ",(0,s.jsx)(n.code,{children:".env"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"443/tcp"})," for Web UI HTTPS"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"10000/udp"})," for RTP media over UDP"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Also ",(0,s.jsx)(n.code,{children:"20000-20050/udp"})," for jigasi, in case you choose to deploy that to facilitate SIP access."]}),"\n",(0,s.jsx)(n.p,{children:"E.g. on a CentOS/Fedora server this would be done like this (without SIP access):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo firewall-cmd --permanent --add-port=80/tcp\nsudo firewall-cmd --permanent --add-port=443/tcp\nsudo firewall-cmd --permanent --add-port=10000/udp\nsudo firewall-cmd --reload\n"})}),"\n",(0,s.jsxs)(n.p,{children:["See ",(0,s.jsx)(n.a,{href:"https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart#setup-and-configure-your-firewall",children:"the corresponding section in the debian/ubuntu setup guide"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"Images"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"base"}),": Debian stable base image with the ",(0,s.jsx)(n.a,{href:"https://github.com/just-containers/s6-overlay",children:"S6 Overlay"})," for process control and the\n",(0,s.jsx)(n.a,{href:"https://jitsi.org/downloads/",children:"Jitsi repositories"})," enabled. All other images are based on this one."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"base-java"}),": Same as the above, plus Java (OpenJDK)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"web"}),": Jitsi Meet web UI, served with nginx."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"prosody"}),": ",(0,s.jsx)(n.a,{href:"https://prosody.im/",children:"Prosody"}),", the XMPP server."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jicofo"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jicofo",children:"Jicofo"}),", the XMPP focus component."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jvb"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-videobridge",children:"Jitsi Videobridge"}),", the video router."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jigasi"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jigasi",children:"Jigasi"}),", the SIP (audio only) gateway."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jibri"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jibri",children:"Jibri"}),", the broadcasting infrastructure."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"design-considerations",children:"Design considerations"}),"\n",(0,s.jsx)(n.p,{children:"Jitsi Meet uses XMPP for signaling, thus the need for the XMPP server.\nThe setup provided by these containers does not expose the XMPP server to the outside world.\nInstead, it's kept completely sealed, and routing of XMPP traffic only happens on a user-defined network."}),"\n",(0,s.jsx)(n.p,{children:"The XMPP server can be exposed to the outside world,\nbut that's out of the scope of this project."}),"\n",(0,s.jsx)(n.h2,{id:"configuration",children:"Configuration"}),"\n",(0,s.jsxs)(n.p,{children:["The configuration is performed via environment variables contained in a ",(0,s.jsx)(n.code,{children:".env"})," file.\nYou can copy the provided ",(0,s.jsx)(n.code,{children:"env.example"})," file as a reference."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"CONFIG"})}),(0,s.jsx)(n.td,{children:"Directory where all configuration will be stored"}),(0,s.jsx)(n.td,{children:"/opt/jitsi-meet-cfg"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TZ"})}),(0,s.jsx)(n.td,{children:"System Time Zone"}),(0,s.jsx)(n.td,{children:"Europe/Amsterdam"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"HTTP_PORT"})}),(0,s.jsx)(n.td,{children:"Exposed port for HTTP traffic"}),(0,s.jsx)(n.td,{children:"8000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"HTTPS_PORT"})}),(0,s.jsx)(n.td,{children:"Exposed port for HTTPS traffic"}),(0,s.jsx)(n.td,{children:"8443"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_ADVERTISE_IPS"})}),(0,s.jsx)(n.td,{children:"IP addresses of the Docker host (comma separated), needed for LAN environments"}),(0,s.jsx)(n.td,{children:"192.168.1.1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PUBLIC_URL"})}),(0,s.jsx)(n.td,{children:"Public URL for the web service"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://meet.example.com",children:"https://meet.example.com"})})]})]})]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"The mobile apps won't work with self-signed certificates (the default).\nSee below for instructions on how to obtain a proper certificate with Let's Encrypt."})}),"\n",(0,s.jsx)(n.h3,{id:"tls-configuration",children:"TLS Configuration"}),"\n",(0,s.jsx)(n.h4,{id:"lets-encrypt-configuration",children:"Let's Encrypt configuration"}),"\n",(0,s.jsx)(n.p,{children:"If you want to expose your Jitsi Meet instance to the outside traffic directly, but don't own a proper TLS certificate, you are in luck\nbecause Let's Encrypt support is built right in. Here are the required options:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_LETSENCRYPT"})}),(0,s.jsx)(n.td,{children:"Enable Let's Encrypt certificate generation"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LETSENCRYPT_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Domain for which to generate the certificate"}),(0,s.jsx)(n.td,{children:"meet.example.com"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LETSENCRYPT_EMAIL"})}),(0,s.jsx)(n.td,{children:"E-Mail for receiving important account notifications (mandatory)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"mailto:alice@atlanta.net",children:"alice@atlanta.net"})})]})]})]}),"\n",(0,s.jsxs)(n.p,{children:["In addition, you will need to set ",(0,s.jsx)(n.code,{children:"HTTP_PORT"})," to 80 and ",(0,s.jsx)(n.code,{children:"HTTPS_PORT"})," to 443 and PUBLIC_URL to your domain.\nYou might also consider to redirect HTTP traffic to HTTPS by setting ",(0,s.jsx)(n.code,{children:"ENABLE_HTTP_REDIRECT=1"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Let's Encrypt rate limit warning"}),": Let's Encrypt has a limit to how many times you can submit a request\nfor a new certificate for your domain name. At the time of writing, the current limit is five new (duplicate)\ncertificates for the same domain name every seven days. Because of this, it is recommended that you disable the\nLet's Encrypt environment variables from ",(0,s.jsx)(n.code,{children:".env"})," if you plan on deleting the ",(0,s.jsx)(n.code,{children:".jitsi-meet-cfg"})," folder.\nOtherwise, you might want to consider moving the ",(0,s.jsx)(n.code,{children:".jitsi-meet-cfg"})," folder to a different location so you have a safe place to find\nthe certificate that already Let's Encrypt issued. Or do initial testing with Let's Encrypt disabled, then re-enable\nLet's Encrypt once you are done testing."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["When you move away from ",(0,s.jsx)(n.code,{children:"LETSENCRYPT_USE_STAGING"}),",\nyou will have to manually clear the certificates from ",(0,s.jsx)(n.code,{children:".jitsi-meet-cfg/web"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["For more information on Let's Encrypt's rate limits, visit:\n",(0,s.jsx)(n.a,{href:"https://letsencrypt.org/docs/rate-limits/",children:"https://letsencrypt.org/docs/rate-limits/"})]}),"\n",(0,s.jsx)(n.h4,{id:"using-existing-tls-certificate-and-key",children:"Using existing TLS certificate and key"}),"\n",(0,s.jsx)(n.p,{children:"If you own a proper TLS certificate and don't need a Let's Encrypt certificate, you can configure Jitsi Meet container\nto use it."}),"\n",(0,s.jsxs)(n.p,{children:["Unlike Let's Encrypt certificates, this is not configured through the ",(0,s.jsx)(n.code,{children:".env"}),"file, but by telling Jitsi Meet's ",(0,s.jsx)(n.code,{children:"web"})," service\nto mount the following two volumes:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["mount ",(0,s.jsx)(n.code,{children:"/path/to/your/cert.key"})," file to ",(0,s.jsx)(n.code,{children:"/config/keys/cert.key"})," mount point"]}),"\n",(0,s.jsxs)(n.li,{children:["mount ",(0,s.jsx)(n.code,{children:"/path/to/your/cert.fullchain"})," file to the ",(0,s.jsx)(n.code,{children:"/config/keys/cert.crt"})," mount point."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Doing it in ",(0,s.jsx)(n.code,{children:"docker-compose.yml"})," file should look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:"services:\n web:\n ...\n volumes:\n ...\n - /path/to/your/cert.fullchain:/config/keys/cert.crt\n - /path/to/your/cert.key:/config/keys/cert.key\n"})}),"\n",(0,s.jsx)(n.h3,{id:"features-configuration-configjs",children:"Features configuration (config.js)"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TOOLBAR_BUTTONS"})}),(0,s.jsx)(n.td,{children:"Configure toolbar buttons. Add the buttons name separated with comma(no spaces between comma)"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"HIDE_PREMEETING_BUTTONS"})}),(0,s.jsx)(n.td,{children:"Hide the buttons at pre-join screen. Add the buttons name separated with comma"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_LOBBY"})}),(0,s.jsx)(n.td,{children:"Control whether the lobby feature should be enabled or not"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AV_MODERATION"})}),(0,s.jsx)(n.td,{children:"Control whether the A/V moderation should be enabled or not"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_PREJOIN_PAGE"})}),(0,s.jsx)(n.td,{children:"Show a prejoin page before entering a conference"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_WELCOME_PAGE"})}),(0,s.jsx)(n.td,{children:"Enable the welcome page"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_CLOSE_PAGE"})}),(0,s.jsx)(n.td,{children:"Enable the close page"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DISABLE_AUDIO_LEVELS"})}),(0,s.jsx)(n.td,{children:"Disable measuring of audio levels"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_NOISY_MIC_DETECTION"})}),(0,s.jsx)(n.td,{children:"Enable noisy mic detection"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_BREAKOUT_ROOMS"})}),(0,s.jsx)(n.td,{children:"Enable breakout rooms"}),(0,s.jsx)(n.td,{children:"1"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"jigasi-sip-gateway-audio-only-configuration",children:"Jigasi SIP gateway (audio only) configuration"}),"\n",(0,s.jsx)(n.p,{children:"If you want to enable the SIP gateway, these options are required:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_URI"})}),(0,s.jsx)(n.td,{children:"SIP URI for incoming / outgoing calls"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"mailto:test@sip2sip.info",children:"test@sip2sip.info"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_PASSWORD"})}),(0,s.jsx)(n.td,{children:"Password for the specified SIP account"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_SERVER"})}),(0,s.jsx)(n.td,{children:"SIP server (use the SIP account domain if in doubt)"}),(0,s.jsx)(n.td,{children:"sip2sip.info"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_PORT"})}),(0,s.jsx)(n.td,{children:"SIP server port"}),(0,s.jsx)(n.td,{children:"5060"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_TRANSPORT"})}),(0,s.jsx)(n.td,{children:"SIP transport"}),(0,s.jsx)(n.td,{children:"UDP"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"display-dial-in-information",children:"Display Dial-In information"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DIALIN_NUMBERS_URL"})}),(0,s.jsx)(n.td,{children:"URL to the JSON with all Dial-In numbers"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://meet.example.com/dialin.json",children:"https://meet.example.com/dialin.json"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"CONFCODE_URL"})}),(0,s.jsx)(n.td,{children:"URL to the API for checking/generating Dial-In codes"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://jitsi-api.jitsi.net/conferenceMapper",children:"https://jitsi-api.jitsi.net/conferenceMapper"})})]})]})]}),"\n",(0,s.jsx)(n.p,{children:"The JSON with the Dial-In numbers should look like this:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-json",children:'{"message":"Dial-In numbers:","numbers":{"DE": ["+49-721-0000-0000"]},"numbersEnabled":true}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"recording--live-streaming-configuration-with-jibri",children:"Recording / live streaming configuration with Jibri"}),"\n",(0,s.jsxs)(d,{children:[(0,s.jsxs)(n.p,{children:[(0,s.jsx)("summary",{children:"If you are using a release older than 7439 some extra setup is necessary."}),"\nBefore running Jibri ",(0,s.jsx)(n.strong,{children:"on releases older than 7439"}),", you need to set up an ALSA loopback device on the host.\nThis ",(0,s.jsx)(n.strong,{children:"will not"})," work on a non-Linux host."]}),(0,s.jsx)(n.p,{children:"For CentOS 7, the module is already compiled with the kernel, so just run:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'# configure 5 capture/playback interfaces\necho "options snd-aloop enable=1,1,1,1,1 index=0,1,2,3,4" > /etc/modprobe.d/alsa-loopback.conf\n# setup autoload the module\necho "snd_aloop" > /etc/modules-load.d/snd_aloop.conf\n# load the module\nmodprobe snd-aloop\n# check that the module is loaded\nlsmod | grep snd_aloop\n'})}),(0,s.jsx)(n.p,{children:"For Ubuntu:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'# install the module\napt update && apt install linux-image-extra-virtual\n# configure 5 capture/playback interfaces\necho "options snd-aloop enable=1,1,1,1,1 index=0,1,2,3,4" > /etc/modprobe.d/alsa-loopback.conf\n# setup autoload the module\necho "snd-aloop" >> /etc/modules\n# check that the module is loaded\nlsmod | grep snd_aloop\n'})}),(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:'If you are running on AWS you may need to reboot your machine to use the generic kernel instead\nof the "aws" kernel. If after reboot, your machine is still using the "aws" kernel, you\'ll need to manually update the grub file. So just run:'})}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'# open the grub file in editor\nnano /etc/default/grub\n# Modify the value of GRUB_DEFAULT from "0" to "1>2"\n# Save and exit from file\n\n# Update grub\nupdate-grub\n# Reboot the machine\nreboot now\n'})}),(0,s.jsx)(n.p,{children:"For using multiple Jibri instances, you have to select different loopback interfaces for each instance manually."}),(0,s.jsx)(n.p,{children:"Default the first instance has:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'...\nslave.pcm "hw:Loopback,0,0"\n...\nslave.pcm "hw:Loopback,0,1"\n...\nslave.pcm "hw:Loopback,1,1"\n...\nslave.pcm "hw:Loopback,1,0"\n...\n'})}),(0,s.jsxs)(n.p,{children:["To setup the second instance, run container with changed ",(0,s.jsx)(n.code,{children:"/home/jibri/.asoundrc"}),":"]}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'...\nslave.pcm "hw:Loopback_1,0,0"\n...\nslave.pcm "hw:Loopback_1,0,1"\n...\nslave.pcm "hw:Loopback_1,1,1"\n...\nslave.pcm "hw:Loopback_1,1,0"\n...\n'})}),(0,s.jsxs)(n.p,{children:["Also you can use numbering id for set loopback interface. The third instance will have ",(0,s.jsx)(n.code,{children:".asoundrc"})," that looks like:"]}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'...\nslave.pcm "hw:2,0,0"\n...\nslave.pcm "hw:2,0,1"\n...\nslave.pcm "hw:2,1,1"\n...\nslave.pcm "hw:2,1,0"\n...\n\n'})})]}),"\n",(0,s.jsx)(n.p,{children:"If you want to enable Jibri these options are required:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_RECORDING"})}),(0,s.jsx)(n.td,{children:"Enable recording / live streaming"}),(0,s.jsx)(n.td,{children:"1"})]})})]}),"\n",(0,s.jsx)(n.p,{children:"Extended Jibri configuration:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_RECORDER_USER"})}),(0,s.jsx)(n.td,{children:"Internal recorder user for Jibri client connections"}),(0,s.jsx)(n.td,{children:"recorder"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_RECORDER_PASSWORD"})}),(0,s.jsx)(n.td,{children:"Internal recorder password for Jibri client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_RECORDING_DIR"})}),(0,s.jsx)(n.td,{children:"Directory for recordings inside Jibri container"}),(0,s.jsx)(n.td,{children:"/config/recordings"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_FINALIZE_RECORDING_SCRIPT_PATH"})}),(0,s.jsx)(n.td,{children:"The finalizing script. Will run after recording is complete"}),(0,s.jsx)(n.td,{children:"/config/finalize.sh"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_XMPP_USER"})}),(0,s.jsx)(n.td,{children:"Internal user for Jibri client connections."}),(0,s.jsx)(n.td,{children:"jibri"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_STRIP_DOMAIN_JID"})}),(0,s.jsx)(n.td,{children:"Prefix domain for strip inside Jibri (please see env.example for details)"}),(0,s.jsx)(n.td,{children:"muc"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_BREWERY_MUC"})}),(0,s.jsx)(n.td,{children:"MUC name for the Jibri pool"}),(0,s.jsx)(n.td,{children:"jibribrewery"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_PENDING_TIMEOUT"})}),(0,s.jsx)(n.td,{children:"MUC connection timeout"}),(0,s.jsx)(n.td,{children:"90"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-meet-configuration",children:"Jitsi Meet configuration"}),"\n",(0,s.jsxs)(n.p,{children:["Jitsi-Meet uses two configuration files for changing default settings within\nthe web interface: ",(0,s.jsx)(n.code,{children:"config.js"})," and ",(0,s.jsx)(n.code,{children:"interface_config.js"}),". The files are\nlocated within the ",(0,s.jsx)(n.code,{children:"CONFIG/web/"})," directory configured within your environment file."]}),"\n",(0,s.jsxs)(n.p,{children:["These files are re-created on every container restart.\nIf you'd like to provide your own settings, create your own config files:\n",(0,s.jsx)(n.code,{children:"custom-config.js"})," and ",(0,s.jsx)(n.code,{children:"custom-interface_config.js"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"It's enough to provide your relevant settings only, the docker scripts will\nappend your custom files to the default ones!"}),"\n",(0,s.jsx)(n.h3,{id:"authentication",children:"Authentication"}),"\n",(0,s.jsx)(n.p,{children:"Authentication can be controlled with the environment variables below. If guest\naccess is enabled, unauthenticated users will need to wait until a user authenticates\nbefore they can join a room. If guest access is not enabled, every user will need\nto authenticate before they can join."}),"\n",(0,s.jsxs)(n.p,{children:["If authentication is enabled, once an authenticated user logged in, it is always\nlogged in before the session timeout. You can set ",(0,s.jsx)(n.code,{children:"ENABLE_AUTO_LOGIN=0"})," to disable\nthis default auto login feature or you can set ",(0,s.jsx)(n.code,{children:"JICOFO_AUTH_LIFETIME"})," to limit\nthe session lifetime."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})}),(0,s.jsx)(n.td,{children:"Enable authentication"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_GUESTS"})}),(0,s.jsx)(n.td,{children:"Enable guest access"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"Select authentication type (internal, jwt or ldap)"}),(0,s.jsx)(n.td,{children:"internal"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AUTO_LOGIN"})}),(0,s.jsx)(n.td,{children:"Enable auto login"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_LIFETIME"})}),(0,s.jsx)(n.td,{children:"Select session timeout value for an authenticated user"}),(0,s.jsx)(n.td,{children:"3 hours"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"internal-authentication",children:"Internal authentication"}),"\n",(0,s.jsxs)(n.p,{children:["The default authentication mode (",(0,s.jsx)(n.code,{children:"internal"}),") uses XMPP credentials to authenticate users.\nTo enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and set ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to ",(0,s.jsx)(n.code,{children:"internal"}),",\nthen configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.p,{children:["Internal users must be created with the ",(0,s.jsx)(n.code,{children:"prosodyctl"})," utility in the ",(0,s.jsx)(n.code,{children:"prosody"})," container.\nIn order to do that, first, execute a shell in the corresponding container:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose exec prosody /bin/bash\n"})}),"\n",(0,s.jsx)(n.p,{children:"Once in the container, run the following command to create a user:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"prosodyctl --config /config/prosody.cfg.lua register TheDesiredUsername meet.jitsi TheDesiredPassword\n"})}),"\n",(0,s.jsx)(n.p,{children:"Note that the command produces no output."}),"\n",(0,s.jsx)(n.p,{children:"To delete a user, run the following command in the container:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"prosodyctl --config /config/prosody.cfg.lua unregister TheDesiredUsername meet.jitsi\n"})}),"\n",(0,s.jsx)(n.p,{children:"To list all users, run the following command in the container:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"find /config/data/meet%2ejitsi/accounts -type f -exec basename {} .dat \\;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-ldap",children:"Authentication using LDAP"}),"\n",(0,s.jsxs)(n.p,{children:["You can use LDAP to authenticate users. To enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and\nset ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to ",(0,s.jsx)(n.code,{children:"ldap"}),", then configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_URL"})}),(0,s.jsx)(n.td,{children:"URL for ldap connection"}),(0,s.jsx)(n.td,{children:"ldaps://ldap.domain.com/"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_BASE"})}),(0,s.jsx)(n.td,{children:"LDAP base DN. Can be empty."}),(0,s.jsx)(n.td,{children:"DC=example,DC=domain,DC=com"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_BINDDN"})}),(0,s.jsx)(n.td,{children:"LDAP user DN. Do not specify this parameter for the anonymous bind."}),(0,s.jsx)(n.td,{children:"CN=binduser,OU=users,DC=example,DC=domain,DC=com"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_BINDPW"})}),(0,s.jsx)(n.td,{children:"LDAP user password. Do not specify this parameter for the anonymous bind."}),(0,s.jsx)(n.td,{children:"LdapUserPassw0rd"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_FILTER"})}),(0,s.jsx)(n.td,{children:"LDAP filter."}),(0,s.jsx)(n.td,{children:"(sAMAccountName=%u)"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_AUTH_METHOD"})}),(0,s.jsx)(n.td,{children:"LDAP authentication method."}),(0,s.jsx)(n.td,{children:"bind"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_VERSION"})}),(0,s.jsx)(n.td,{children:"LDAP protocol version"}),(0,s.jsx)(n.td,{children:"3"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_USE_TLS"})}),(0,s.jsx)(n.td,{children:"Enable LDAP TLS"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CIPHERS"})}),(0,s.jsx)(n.td,{children:"Set TLS ciphers list to allow"}),(0,s.jsxs)(n.td,{children:["SECURE256",":SECURE128"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CHECK_PEER"})}),(0,s.jsx)(n.td,{children:"Require and verify LDAP server certificate"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CACERT_FILE"})}),(0,s.jsx)(n.td,{children:"Path to CA cert file. Used when server certificate verification is enabled"}),(0,s.jsx)(n.td,{children:"/etc/ssl/certs/ca-certificates.crt"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CACERT_DIR"})}),(0,s.jsx)(n.td,{children:"Path to CA certs directory. Used when server certificate verification is enabled."}),(0,s.jsx)(n.td,{children:"/etc/ssl/certs"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_START_TLS"})}),(0,s.jsx)(n.td,{children:"Enable START_TLS, requires LDAPv3, URL must be ldap:// not ldaps://"}),(0,s.jsx)(n.td,{children:"0"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-jwt-tokens",children:"Authentication using JWT tokens"}),"\n",(0,s.jsxs)(n.p,{children:["You can use JWT tokens to authenticate users. To enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and\nset ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to ",(0,s.jsx)(n.code,{children:"jwt"}),", then configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_ID"})}),(0,s.jsx)(n.td,{children:"Application identifier"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_id"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_SECRET"})}),(0,s.jsx)(n.td,{children:"Application secret known only to your token"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_secret"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ACCEPTED_ISSUERS"})}),(0,s.jsx)(n.td,{children:"(Optional) Set asap_accepted_issuers as a comma separated list"}),(0,s.jsx)(n.td,{children:"my_web_client,my_app_client"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ACCEPTED_AUDIENCES"})}),(0,s.jsx)(n.td,{children:"(Optional) Set asap_accepted_audiences as a comma separated list"}),(0,s.jsx)(n.td,{children:"my_server1,my_server2"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ASAP_KEYSERVER"})}),(0,s.jsx)(n.td,{children:"(Optional) Set asap_keyserver to a url where public keys can be found"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://example.com/asap%3E",children:"https://example.com/asap>"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ALLOW_EMPTY"})}),(0,s.jsx)(n.td,{children:"(Optional) Allow anonymous users with no JWT while validating JWTs when provided"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"(Optional) Controls which module is used for processing incoming JWTs"}),(0,s.jsx)(n.td,{children:"token"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_TOKEN_AUTH_MODULE"})}),(0,s.jsx)(n.td,{children:"(Optional) Controls which module is used for validating JWTs"}),(0,s.jsx)(n.td,{children:"token_verification"})]})]})]}),"\n",(0,s.jsxs)(n.p,{children:["This can be tested using the ",(0,s.jsx)(n.a,{href:"https://jwt.io/#debugger-io",children:"jwt.io"})," debugger. Use the following sample payload:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-json",children:'{\n "context": {\n "user": {\n "avatar": "https://robohash.org/john-doe",\n "name": "John Doe",\n "email": "jdoe@example.com"\n }\n },\n "aud": "my_jitsi_app_id",\n "iss": "my_jitsi_app_id",\n "sub": "meet.jitsi",\n "room": "*"\n}\n'})}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-matrix",children:"Authentication using Matrix"}),"\n",(0,s.jsxs)(n.p,{children:['For more information see the documentation of the "Prosody Auth Matrix User Verification" ',(0,s.jsx)(n.a,{href:"https://github.com/matrix-org/prosody-mod-auth-matrix-user-verification",children:"here"}),"."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_URL"})}),(0,s.jsx)(n.td,{children:"Base URL to the matrix user verification service (without ending slash)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://uvs.example.com:3000"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_ISSUER"})}),(0,s.jsxs)(n.td,{children:["(optional) The issuer of the auth token to be passed through. Must match what is being set as ",(0,s.jsx)(n.code,{children:"iss"})," in the JWT."]}),(0,s.jsx)(n.td,{children:"issuer (default)"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_AUTH_TOKEN"})}),(0,s.jsx)(n.td,{children:"(optional) user verification service auth token, if authentication enabled"}),(0,s.jsx)(n.td,{children:"changeme"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_SYNC_POWER_LEVELS"})}),(0,s.jsx)(n.td,{children:"(optional) Make Matrix room moderators owners of the Prosody room."}),(0,s.jsx)(n.td,{children:"1"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-hybrid-matrix-token",children:"Authentication using Hybrid Matrix Token"}),"\n",(0,s.jsxs)(n.p,{children:["You can use ",(0,s.jsx)(n.code,{children:"Hybrid Matrix Token"})," to authenticate users. It supports ",(0,s.jsx)(n.code,{children:"Matrix"})," and ",(0,s.jsx)(n.code,{children:"JWT Token"})," authentications\non the same setup. To enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and set ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to\n",(0,s.jsx)(n.code,{children:"hybrid_matrix_token"}),", then configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.p,{children:['For more information see the documentation of the "Hybrid Matrix Token"\n',(0,s.jsx)(n.a,{href:"https://github.com/jitsi-contrib/prosody-plugins/tree/main/auth_hybrid_matrix_token",children:"here"}),"."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_URL"})}),(0,s.jsx)(n.td,{children:"Base URL to the matrix user verification service (without ending slash)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://uvs.example.com:3000"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_ISSUER"})}),(0,s.jsxs)(n.td,{children:["(optional) The issuer of the auth token to be passed through. Must match what is being set as ",(0,s.jsx)(n.code,{children:"iss"})," in the JWT. It allows all issuers (",(0,s.jsx)(n.code,{children:"*"}),") by default."]}),(0,s.jsx)(n.td,{children:"my_issuer"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_AUTH_TOKEN"})}),(0,s.jsx)(n.td,{children:"(optional) user verification service auth token, if authentication enabled"}),(0,s.jsx)(n.td,{children:"my_matrix_secret"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_SYNC_POWER_LEVELS"})}),(0,s.jsx)(n.td,{children:"(optional) Make Matrix room moderators owners of the Prosody room."}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_LOBBY_BYPASS"})}),(0,s.jsx)(n.td,{children:"(optional) Allow Matrix room members to bypass Jitsi lobby check."}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_ID"})}),(0,s.jsx)(n.td,{children:"Application identifier"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_id"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_SECRET"})}),(0,s.jsx)(n.td,{children:"Application secret known only to your token"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_secret"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ALLOW_EMPTY"})}),(0,s.jsx)(n.td,{children:"(Optional) Allow anonymous users with no JWT while validating JWTs when provided"}),(0,s.jsx)(n.td,{children:"0"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"external-authentication",children:"External authentication"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TOKEN_AUTH_URL"})}),(0,s.jsx)(n.td,{children:"Authenticate using external service or just focus external auth window if there is one already."}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://auth.meet.example.com/%7Broom%7D%3E",children:"https://auth.meet.example.com/{room}>"})})]})})]}),"\n",(0,s.jsx)(n.h3,{id:"shared-document-editing-using-etherpad",children:"Shared document editing using Etherpad"}),"\n",(0,s.jsxs)(n.p,{children:["You can collaboratively edit a document via ",(0,s.jsx)(n.a,{href:"https://github.com/ether/etherpad-lite",children:"Etherpad"}),". In order to enable it, set the config options below and run\nDocker Compose with the additional config file ",(0,s.jsx)(n.code,{children:"etherpad.yml"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"Here are the required options:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ETHERPAD_URL_BASE"})}),(0,s.jsx)(n.td,{children:"Set etherpad-lite URL"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"http://etherpad.meet.jitsi:9001"})})]})})]}),"\n",(0,s.jsx)(n.h3,{id:"transcription-configuration",children:"Transcription configuration"}),"\n",(0,s.jsx)(n.p,{children:"If you want to enable the Transcribing function, set the config options below and run Docker Compose with the additional config file transcriber.yml."}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_TRANSCRIPTIONS"})}),(0,s.jsx)(n.td,{children:"Enable Jigasi transcription in a conference"}),(0,s.jsx)(n.td,{children:"1"})]})})]}),"\n",(0,s.jsx)(n.p,{children:"In addition, the following are options are used to configure the various transcription backends and features:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_PROJECT_ID"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"project_id"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_PRIVATE_KEY_ID"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"private_key_id"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_PRIVATE_KEY"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"private_key"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_CLIENT_EMAIL"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"client_email"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_CLIENT_ID"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"client_id"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_CLIENT_CERT_URL"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"client_x509_cert_url"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_ADVERTISE_URL"})}),(0,s.jsx)(n.td,{children:"Jigasi will post an url to the chat with transcription file"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_CUSTOM_SERVICE"})}),(0,s.jsx)(n.td,{children:"Jigasi will use this class for custom transcriptions instead of google cloud"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_CUSTOM_TRANSLATION_SERVICE"})}),(0,s.jsx)(n.td,{children:"Jigasi will use this class for custom transctions instead of google cloud"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_ENABLE_SAVING"})}),(0,s.jsx)(n.td,{children:"Jigasi will save results to a transcription file"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_FILTER_SILENCE"})}),(0,s.jsx)(n.td,{children:"Jigasi will filter silent audio and not forward to backends"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_LIBRETRANSLATE_URL"})}),(0,s.jsx)(n.td,{children:"URL for libretranslate services"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_OCI_COMPARTMENT"})}),(0,s.jsx)(n.td,{children:"OCI compartment for use with Oracle Cloud Speech AI services"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_OCI_REGION"})}),(0,s.jsx)(n.td,{children:"OCI region name for use with Oracle Cloud Speech AI services"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_RECORD_AUDIO"})}),(0,s.jsx)(n.td,{children:"Jigasi will record audio when transcriber is on"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_REMOTE_CONFIG_URL"})}),(0,s.jsx)(n.td,{children:"URL to control transcriber custom service based on conference details"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_SEND_TXT"})}),(0,s.jsx)(n.td,{children:"Jigasi will send transcribed text to the chat when transcriber is on"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_USER"})}),(0,s.jsx)(n.td,{children:"Jigasi XMPP user"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_VOSK_URL"})}),(0,s.jsx)(n.td,{children:"URL for use with vosk backend"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_WHISPER_URL"})}),(0,s.jsx)(n.td,{children:"URL for use with whisper backend"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEY_NAME"})}),(0,s.jsx)(n.td,{children:"Private Key ID of the private key to use with whisper"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEY"})}),(0,s.jsx)(n.td,{children:"Private Key material to use with whisper, without newlines or START/END delimiters"}),(0,s.jsx)(n.td,{})]})]})]}),"\n",(0,s.jsxs)(n.p,{children:["For setting the Google Cloud Credentials please read ",(0,s.jsx)(n.a,{href:"https://cloud.google.com/text-to-speech/docs/quickstart-protocol%3E",children:"https://cloud.google.com/text-to-speech/docs/quickstart-protocol>"}),' section "Before you begin" paragraph 1 to 5.']}),"\n",(0,s.jsx)(n.h3,{id:"sentry-logging-configuration",children:"Sentry logging configuration"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_SENTRY_DSN"})}),(0,s.jsx)(n.td,{children:"Sentry Data Source Name (Endpoint for Sentry project)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://public:private@host:port/1"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_SENTRY_DSN"})}),(0,s.jsx)(n.td,{children:"Sentry Data Source Name (Endpoint for Sentry project)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://public:private@host:port/1"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SENTRY_DSN"})}),(0,s.jsx)(n.td,{children:"Sentry Data Source Name (Endpoint for Sentry project)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://public:private@host:port/1"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"SENTRY_ENVIRONMENT"})}),(0,s.jsx)(n.td,{children:"Optional environment info to filter events"}),(0,s.jsx)(n.td,{children:"production"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"SENTRY_RELEASE"})}),(0,s.jsx)(n.td,{children:"Optional release info to filter events"}),(0,s.jsx)(n.td,{children:"1.0.0"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"turn-server-configuration",children:"TURN server configuration"}),"\n",(0,s.jsx)(n.p,{children:"Configure external TURN servers."}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_CREDENTIALS"})}),(0,s.jsx)(n.td,{children:"Credentials for TURN servers"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_HOST"})}),(0,s.jsx)(n.td,{children:"TURN server hostnames as a comma separated list (UDP or TCP transport)"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_PORT"})}),(0,s.jsx)(n.td,{children:"TURN server port (UDP or TCP transport)"}),(0,s.jsx)(n.td,{children:"443"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_TRANSPORT"})}),(0,s.jsx)(n.td,{children:"TURN server protocols as a comma separated list (UDP or TCP or both)"}),(0,s.jsx)(n.td,{children:"tcp"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURNS_HOST"})}),(0,s.jsx)(n.td,{children:"TURN server hostnames as a comma separated list (TLS transport)"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURNS_PORT"})}),(0,s.jsx)(n.td,{children:"TURN server port (TLS transport)"}),(0,s.jsx)(n.td,{children:"443"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_TLL"})}),(0,s.jsx)(n.td,{children:"TURN max allocation duration (sec)"}),(0,s.jsx)(n.td,{children:"86400"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"advanced-configuration",children:"Advanced configuration"}),"\n",(0,s.jsx)(n.p,{children:"These configuration options are already set and generally don't need to be changed."}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Internal XMPP domain"}),(0,s.jsx)(n.td,{children:"meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_AUTH_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Internal XMPP domain for authenticated services"}),(0,s.jsx)(n.td,{children:"auth.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_SERVER"})}),(0,s.jsx)(n.td,{children:"Internal XMPP server name xmpp.meet.jitsi"}),(0,s.jsx)(n.td,{children:"xmpp.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_BOSH_URL_BASE"})}),(0,s.jsx)(n.td,{children:"Internal XMPP server URL for BOSH module"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"http://xmpp.meet.jitsi:5280"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_MUC_DOMAIN"})}),(0,s.jsx)(n.td,{children:"XMPP domain for the MUC"}),(0,s.jsx)(n.td,{children:"muc.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_INTERNAL_MUC_DOMAIN"})}),(0,s.jsx)(n.td,{children:"XMPP domain for the internal MUC"}),(0,s.jsx)(n.td,{children:"internal-muc.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_GUEST_DOMAIN"})}),(0,s.jsx)(n.td,{children:"XMPP domain for unauthenticated users"}),(0,s.jsx)(n.td,{children:"guest.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_RECORDER_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Domain for the jibri recorder"}),(0,s.jsx)(n.td,{children:"recorder.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom Prosody modules for XMPP_DOMAIN (comma separated)"}),(0,s.jsx)(n.td,{children:"info,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_MUC_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom Prosody modules for MUC component (comma separated)"}),(0,s.jsx)(n.td,{children:"info,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_INTERNAL_MUC_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom Prosody modules for internal MUC component (comma separated)"}),(0,s.jsx)(n.td,{children:"info,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GLOBAL_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom prosody modules to load in global configuration (comma separated)"}),(0,s.jsx)(n.td,{children:"statistics,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GLOBAL_CONFIG"})}),(0,s.jsx)(n.td,{children:"Custom configuration string with escaped newlines"}),(0,s.jsx)(n.td,{children:"foo = bar;\\nkey = val;"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"RESTART_POLICY"})}),(0,s.jsx)(n.td,{children:"Container restart policy"}),(0,s.jsxs)(n.td,{children:["defaults to ",(0,s.jsx)(n.code,{children:"unless-stopped"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DISABLE_HTTPS"})}),(0,s.jsx)(n.td,{children:"Handle TLS connections outside of this setup"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_HTTP_REDIRECT"})}),(0,s.jsx)(n.td,{children:"Redirect HTTP traffic to HTTPS"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LOG_LEVEL"})}),(0,s.jsx)(n.td,{children:"Controls which logs are output from prosody and associated modules"}),(0,s.jsx)(n.td,{children:"info"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_HSTS"})}),(0,s.jsxs)(n.td,{children:["Send a ",(0,s.jsx)(n.code,{children:"strict-transport-security"})," header to force browsers to use a secure and trusted connection. Recommended for production use."]}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_IPV6"})}),(0,s.jsx)(n.td,{children:"Provides means to disable IPv6 in environments that don't support it"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_COLIBRI_WEBSOCKET_UNSAFE_REGEX"})}),(0,s.jsxs)(n.td,{children:["Enabled older unsafe regex for JVB colibri-ws URLs. WARNING: Enable with caution, this regex allows connections to arbitrary internal IP addresses and is not recommended for production use. Unsafe regex is defined as ",(0,s.jsx)(n.code,{children:"[a-zA-Z0-9-\\._]+"})]}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME"})}),(0,s.jsxs)(n.td,{children:["DNS name to look up JVB IP address, used for default value of ",(0,s.jsx)(n.code,{children:"COLIBRI_WEBSOCKET_REGEX"})]}),(0,s.jsx)(n.td,{children:"jvb"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"COLIBRI_WEBSOCKET_REGEX"})}),(0,s.jsx)(n.td,{children:"Overrides the colibri regex used for proxying to JVB. Recommended to override in production with values matching possible JVB IP ranges"}),(0,s.jsxs)(n.td,{children:["defaults to ",(0,s.jsx)(n.code,{children:"dig $COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME"})," unless ",(0,s.jsx)(n.code,{children:"DISABLE_COLIBRI_WEBSOCKET_JVB_LOOKUP"})," is set to true"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DISABLE_COLIBRI_WEBSOCKET_JVB_LOOKUP"})}),(0,s.jsxs)(n.td,{children:["Controls whether to run ",(0,s.jsx)(n.code,{children:"dig $COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME"})," when defining COLIBRI_WEBSOCKET_REGEX"]}),(0,s.jsx)(n.td,{children:"0"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-prosody-options",children:"Advanced Prosody options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_RESERVATION_ENABLED"})}),(0,s.jsx)(n.td,{children:"Enable Prosody's reservation REST API"}),(0,s.jsx)(n.td,{children:"false"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_RESERVATION_REST_BASE_URL"})}),(0,s.jsx)(n.td,{children:"Base URL of Prosody's reservation REST API"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"Select authentication type for Prosody (internal, jwt or ldap)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"AUTH_TYPE"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_ENABLE_METRICS"})}),(0,s.jsxs)(n.td,{children:["Enables the http_openmetrics module which exposes Prometheus metrics at ",(0,s.jsx)(n.code,{children:"/metrics"})]}),(0,s.jsx)(n.td,{children:"false"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_METRICS_ALLOWED_CIDR"})}),(0,s.jsx)(n.td,{children:"CIDR block permitted to access metrics"}),(0,s.jsx)(n.td,{children:"172.16.0.0/12"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-jicofo-options",children:"Advanced Jicofo options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_COMPONENT_SECRET"})}),(0,s.jsx)(n.td,{children:"XMPP component password for Jicofo"}),(0,s.jsx)(n.td,{children:"s3cr37"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_USER"})}),(0,s.jsx)(n.td,{children:"XMPP user for Jicofo client connections"}),(0,s.jsx)(n.td,{children:"focus"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_PASSWORD"})}),(0,s.jsx)(n.td,{children:"XMPP password for Jicofo client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_ENABLE_AUTH"})}),(0,s.jsx)(n.td,{children:"Enable authentication in Jicofo"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"Select authentication type for Jicofo (internal, jwt or ldap)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"AUTH_TYPE"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_LIFETIME"})}),(0,s.jsx)(n.td,{children:"Select session timeout value for an authenticated user"}),(0,s.jsx)(n.td,{children:"24 hours"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_ENABLE_HEALTH_CHECKS"})}),(0,s.jsx)(n.td,{children:"Enable health checks inside Jicofo, allowing the use of the REST api to check Jicofo's status"}),(0,s.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-jvb-options",children:"Advanced JVB options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_AUTH_USER"})}),(0,s.jsx)(n.td,{children:"XMPP user for JVB MUC client connections"}),(0,s.jsx)(n.td,{children:"jvb"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_AUTH_PASSWORD"})}),(0,s.jsx)(n.td,{children:"XMPP password for JVB MUC client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_STUN_SERVERS"})}),(0,s.jsx)(n.td,{children:"STUN servers used to discover the server's public IP"}),(0,s.jsx)(n.td,{children:"stun.l.google.com:19302, stun1.l.google.com:19302, stun2.l.google.com:19302"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_PORT"})}),(0,s.jsx)(n.td,{children:"UDP port for media used by Jitsi Videobridge"}),(0,s.jsx)(n.td,{children:"10000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_COLIBRI_PORT"})}),(0,s.jsx)(n.td,{children:"COLIBRI REST API port of JVB exposed to localhost"}),(0,s.jsx)(n.td,{children:"8080"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_BREWERY_MUC"})}),(0,s.jsx)(n.td,{children:"MUC name for the JVB pool"}),(0,s.jsx)(n.td,{children:"jvbbrewery"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"COLIBRI_REST_ENABLED"})}),(0,s.jsx)(n.td,{children:"Enable the COLIBRI REST API"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"SHUTDOWN_REST_ENABLED"})}),(0,s.jsx)(n.td,{children:"Enable the shutdown REST API"}),(0,s.jsx)(n.td,{children:"true"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-jigasi-options",children:"Advanced Jigasi options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_ENABLE_SDES_SRTP"})}),(0,s.jsx)(n.td,{children:"Enable SDES srtp"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_KEEP_ALIVE_METHOD"})}),(0,s.jsx)(n.td,{children:"Keepalive method"}),(0,s.jsx)(n.td,{children:"OPTIONS"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_HEALTH_CHECK_SIP_URI"})}),(0,s.jsx)(n.td,{children:"Health-check extension"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_HEALTH_CHECK_INTERVAL"})}),(0,s.jsx)(n.td,{children:"Health-check interval"}),(0,s.jsx)(n.td,{children:"300000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_XMPP_USER"})}),(0,s.jsx)(n.td,{children:"XMPP user for Jigasi MUC client connections"}),(0,s.jsx)(n.td,{children:"jigasi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_XMPP_PASSWORD"})}),(0,s.jsx)(n.td,{children:"XMPP password for Jigasi MUC client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_BREWERY_MUC"})}),(0,s.jsx)(n.td,{children:"MUC name for the Jigasi pool"}),(0,s.jsx)(n.td,{children:"jigasibrewery"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_PORT_MIN"})}),(0,s.jsx)(n.td,{children:"Minimum port for media used by Jigasi"}),(0,s.jsx)(n.td,{children:"20000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_PORT_MAX"})}),(0,s.jsx)(n.td,{children:"Maximum port for media used by Jigasi"}),(0,s.jsx)(n.td,{children:"20050"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"running-behind-nat-or-on-a-lan-environment",children:"Running behind NAT or on a LAN environment"}),"\n",(0,s.jsxs)(n.p,{children:["When running running in a LAN environment, or on the public Internet via NAT, the ",(0,s.jsx)(n.code,{children:"JVB_ADVERTISE_IPS"})," env variable should be set.\nThis variable allows to control which IP addresses the JVB will advertise for WebRTC media traffic. It is necessary to set it regardless of the use of a reverse proxy, since it's the IP address that will receive the media (audio / video) and not HTTP traffic, hence it's oblivious to the reverse proxy."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["This variable used to be called ",(0,s.jsx)(n.code,{children:"DOCKER_HOST_ADDRESS"})," but it got renamed for clarity and to support a list of IPs."]})}),"\n",(0,s.jsx)(n.p,{children:"If your users are coming in over the Internet (and not over LAN), this will likely be your public IP address. If this is not set up correctly, calls will crash when more than two users join a meeting."}),"\n",(0,s.jsxs)(n.p,{children:["The public IP address is attempted to be discovered via ",(0,s.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/STUN",children:"STUN"}),".\nSTUN servers can be specified with the ",(0,s.jsx)(n.code,{children:"JVB_STUN_SERVERS"})," option."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["Due to a bug in the docker version currently in the Debian repos (20.10.5), ",(0,s.jsx)(n.a,{href:"https://forums.docker.com/t/docker-doesnt-open-ipv6-ports/106201/2",children:"Docker does not listen on IPv6 ports"}),", so for that combination you will have to ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/engine/install/debian/",children:"manually obtain the latest version"}),"."]})}),"\n",(0,s.jsx)(n.h4,{id:"split-horizon",children:"Split horizon"}),"\n",(0,s.jsx)(n.p,{children:"If you are running in a split horizon environemt (LAN internal clients connect to a local IP and other clients connect to a public IP) you can specify\nmultiple advertised IPs by separating them with commas:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"JVB_ADVERTISE_IPS=192.168.1.1,1.2.3.4\n"})}),"\n",(0,s.jsx)(n.h4,{id:"offline--airgapped-installation",children:"Offline / airgapped installation"}),"\n",(0,s.jsx)(n.p,{children:"If your setup does not have access to the Internet you'll need to disable STUN on the JVB since discovering its own IP address will fail, but that is not necessary on that type of environment."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"JVB_DISABLE_STUN=true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"adjust-udp-buffers",children:"Adjust UDP buffers"}),"\n",(0,s.jsxs)(n.p,{children:["If you are experiencing issues with UDP traffic, like synchronization issues, skipping frames and similar, or if you expect a high traffic and big conferences, you might want to adjust the UDP buffer sizes.\nYou need to do that on the host system, that hosts the jvb container.\nTo do so you can get this ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-videobridge/blob/master/config/20-jvb-udp-buffers.conf",children:"sysctl config file"})," and save it in ",(0,s.jsx)(n.code,{children:"/etc/sysctl.d"})," and load it via: ",(0,s.jsx)(n.code,{children:"sysctl --system"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"accessing-server-logs",children:"Accessing server logs"}),"\n",(0,s.jsxs)(n.p,{children:["The default bahavior of ",(0,s.jsx)(n.code,{children:"docker-jitsi-meet"})," is to log to ",(0,s.jsx)(n.code,{children:"stdout"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["While the logs are sent to ",(0,s.jsx)(n.code,{children:"stdout"}),", they are not lost: unless configured to drop all logs, Docker keeps them available for future retrieval and processing."]}),"\n",(0,s.jsx)(n.p,{children:"If you need to access the container's logs you have multiple options. Here are the main ones:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["run ",(0,s.jsx)(n.code,{children:"docker compose logs -t -f "})," from command line, where ",(0,s.jsx)(n.code,{children:""})," is one of ",(0,s.jsx)(n.code,{children:"web"}),", ",(0,s.jsx)(n.code,{children:"prosody"}),",",(0,s.jsx)(n.code,{children:"jvb"}),", ",(0,s.jsx)(n.code,{children:"jicofo"}),". This command will output the logs for the selected service to stdout with timestamps."]}),"\n",(0,s.jsxs)(n.li,{children:["use a standard ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/config/containers/logging/configure/",children:"docker logging driver"})," to redirect the logs to the desired target (for instance ",(0,s.jsx)(n.code,{children:"syslog"})," or ",(0,s.jsx)(n.code,{children:"splunk"}),")."]}),"\n",(0,s.jsxs)(n.li,{children:["search ",(0,s.jsx)(n.a,{href:"https://hub.docker.com/search?q=",children:"docker hub"})," for a third party ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/config/containers/logging/plugins/",children:"docker logging driver plugin"})]}),"\n",(0,s.jsxs)(n.li,{children:["or ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/engine/extend/plugins_logging/",children:"write your own driver plugin"})," if you have a very specific need."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["For instance, if you want to have all logs related to a ",(0,s.jsx)(n.code,{children:""})," written to ",(0,s.jsx)(n.code,{children:"/var/log/jitsi/"})," as ",(0,s.jsx)(n.code,{children:"json"})," output, you could use ",(0,s.jsx)(n.a,{href:"https://github.com/deep-compute/docker-file-log-driver",children:"docker-file-log-driver"})," and configure it by adding the following block in your ",(0,s.jsx)(n.code,{children:"docker-compose.yml"})," file, at the same level as the ",(0,s.jsx)(n.code,{children:"image"})," block of the selected ",(0,s.jsx)(n.code,{children:""}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:'services:\n :\n image: ...\n ...\n logging:\n driver: file-log-driver\n options:\n fpath: "/jitsi/.log"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["If you want to only display the ",(0,s.jsx)(n.code,{children:"message"})," part of the log in ",(0,s.jsx)(n.code,{children:"json"})," format, simply execute the following command (for instance if ",(0,s.jsx)(n.code,{children:"fpath"})," was set to ",(0,s.jsx)(n.code,{children:"/jitsi/jvb.log"}),") which uses ",(0,s.jsx)(n.code,{children:"jq"})," to extract the relevant part of the logs:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"sudo cat /var/log/jitsi/jvb.log | jq -r '.msg' | jq -r '.message'\n"})}),"\n",(0,s.jsx)(n.h2,{id:"build-instructions",children:"Build Instructions"}),"\n",(0,s.jsx)(n.p,{children:"Building your images allows you to edit the configuration files of each image individually, providing more customization for your deployment."}),"\n",(0,s.jsxs)(n.p,{children:["The docker images can be built by running the ",(0,s.jsx)(n.code,{children:"make"})," command in the main repository folder. If you need to overwrite existing images from the remote source, use ",(0,s.jsx)(n.code,{children:"FORCE_REBUILD=1 make"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["If you are on the unstable branch, build the images with ",(0,s.jsx)(n.code,{children:"FORCE_REBUILD=1 JITSI_RELEASE=unstable make"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["You are now able to run ",(0,s.jsx)(n.code,{children:"docker compose up"})," as usual."]}),"\n",(0,s.jsx)(n.h2,{id:"running-behind-a-reverse-proxy",children:"Running behind a reverse proxy"}),"\n",(0,s.jsxs)(n.p,{children:["When running behing a reverse proxy from the same host, the communication between the proxy and Jitsi Meet is often in HTTP and not HTTPS since we generally don't have valid certificates for ",(0,s.jsx)(n.code,{children:"localhost"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"disable-https",children:"Disable HTTPS"}),"\n",(0,s.jsx)(n.p,{children:"HTTPS can be disabled in the Docker Compose configuration (since HTTPS will probably not work on localhost):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"DISABLE_HTTPS=1\nENABLE_HTTP_REDIRECT=0\nENABLE_LETS_ENCRYPT=0\n"})}),"\n",(0,s.jsx)(n.h3,{id:"do-not-expose-the-jitsi-meets-ports-publicly",children:"Do not expose the Jitsi Meet's ports publicly"}),"\n",(0,s.jsxs)(n.p,{children:["By default, the ",(0,s.jsx)(n.code,{children:"HTTP_PORT"})," and ",(0,s.jsx)(n.code,{children:"HTTPS_PORT"})," are binding to any ip address, so are publicly open unless a firewall blocks them. When using a reverse proxy, this is not necessary. This can be changed by updating the web container's ports configuration:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:" - '127.0.0.1:${HTTP_PORT}:80'\n - '127.0.0.1:${HTTPS_PORT}:443'\n"})}),"\n",(0,s.jsx)(n.p,{children:"insteaf of"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:" - '${HTTP_PORT}:80'\n - '${HTTPS_PORT}:443'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"reverse-proxy-configuration",children:"Reverse proxy configuration"}),"\n",(0,s.jsx)(n.p,{children:"By default this setup is using WebSocket connections for 2 core components:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Signalling (XMPP)"}),"\n",(0,s.jsx)(n.li,{children:"Bridge channel (colibri)"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Due to the hop-by-hop nature of WebSockets the reverse proxy must properly terminate and forward WebSocket connections. There 2 routes require such treatment:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"/xmpp-websocket"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"/colibri-ws"})}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The other HTTP requests must be handled by the web container."}),"\n",(0,s.jsxs)(n.p,{children:["In the following configuration examples, ",(0,s.jsx)(n.code,{children:"http://localhost:8000/"})," is the url of the web service's ingress (",(0,s.jsx)(n.code,{children:"8000"})," corresponds to ",(0,s.jsx)(n.code,{children:"HTTP_PORT"}),")."]}),"\n",(0,s.jsx)(n.h4,{id:"nginx",children:"nginx"}),"\n",(0,s.jsx)(n.p,{children:"With nginx, these routes can be forwarded using the following config snippet:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-nginx",children:'location /xmpp-websocket {\n proxy_pass http://localhost:8000/xmpp-websocket;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection "upgrade";\n}\n\nlocation /colibri-ws {\n proxy_pass http://localhost:8080/colibri-ws;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection "upgrade";\n}\n\nlocation / {\n proxy_pass http://localhost:8000/;\n proxy_http_version 1.1;\n}\n'})}),"\n",(0,s.jsx)(n.h4,{id:"apache",children:"Apache"}),"\n",(0,s.jsxs)(n.p,{children:["With Apache, ",(0,s.jsx)(n.code,{children:"mod_proxy"}),", ",(0,s.jsx)(n.code,{children:"mod_proxy_http"})," and ",(0,s.jsx)(n.code,{children:"mod_proxy_wstunnel"})," need to be enabled."]}),"\n",(0,s.jsx)(n.p,{children:"The reverse proxy can be configured using the following config snippet:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-apache",children:"\n \n ProxyTimeout 900\n ProxyPass /xmpp-websocket ws://localhost:8000/xmpp-websocket\n ProxyPass /colibri-ws/ ws://localhost:8000/colibri-ws/\n ProxyPass / http://localhost:8000/\n ProxyPassReverse / http://localhost:8000/\n \n\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disabling-websocket-connections",children:"Disabling WebSocket connections"}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"This is not the recommended setup."})}),"\n",(0,s.jsx)(n.p,{children:"If using WebSockets is not an option, these environment variables can be set to fallback to HTTP polling and WebRTC datachannels:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"ENABLE_SCTP=1\nENABLE_COLIBRI_WEBSOCKET=0\nENABLE_XMPP_WEBSOCKET=0\n"})})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},386:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/docker-jitsi-meet-afafdf87fea30a2fa6412baa4a3f8248.png"},8453:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(6540);const r={},d=s.createContext(r);function t(e){const n=s.useContext(d);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[4753],{7704:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>a,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(4848),r=i(8453);const d={id:"devops-guide-docker",title:"Self-Hosting Guide - Docker",sidebar_label:"Docker"},t=void 0,c={id:"devops-guide/devops-guide-docker",title:"Self-Hosting Guide - Docker",description:"Quick start",source:"@site/docs/devops-guide/docker.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-docker",permalink:"/handbook/docs/devops-guide/devops-guide-docker",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/docker.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"devops-guide-docker",title:"Self-Hosting Guide - Docker",sidebar_label:"Docker"},sidebar:"docs",previous:{title:"openSUSE",permalink:"/handbook/docs/devops-guide/devops-guide-opensuse"},next:{title:"Log Analyser",permalink:"/handbook/docs/devops-guide/devops-guide-log-analyser"}},o={},l=[{value:"Quick start",id:"quick-start",level:2},{value:"Updating",id:"updating",level:3},{value:"Testing development / unstable builds",id:"testing-development--unstable-builds",level:3},{value:"Building your own images",id:"building-your-own-images",level:3},{value:"Security note",id:"security-note",level:3},{value:"Architecture",id:"architecture",level:2},{value:"External Ports",id:"external-ports",level:3},{value:"Images",id:"images",level:3},{value:"Design considerations",id:"design-considerations",level:3},{value:"Configuration",id:"configuration",level:2},{value:"TLS Configuration",id:"tls-configuration",level:3},{value:"Let's Encrypt configuration",id:"lets-encrypt-configuration",level:4},{value:"Using existing TLS certificate and key",id:"using-existing-tls-certificate-and-key",level:4},{value:"Features configuration (config.js)",id:"features-configuration-configjs",level:3},{value:"Jigasi SIP gateway (audio only) configuration",id:"jigasi-sip-gateway-audio-only-configuration",level:3},{value:"Display Dial-In information",id:"display-dial-in-information",level:4},{value:"Recording / live streaming configuration with Jibri",id:"recording--live-streaming-configuration-with-jibri",level:3},{value:"Jitsi Meet configuration",id:"jitsi-meet-configuration",level:3},{value:"Authentication",id:"authentication",level:3},{value:"Internal authentication",id:"internal-authentication",level:4},{value:"Authentication using LDAP",id:"authentication-using-ldap",level:4},{value:"Authentication using JWT tokens",id:"authentication-using-jwt-tokens",level:4},{value:"Authentication using Matrix",id:"authentication-using-matrix",level:4},{value:"Authentication using Hybrid Matrix Token",id:"authentication-using-hybrid-matrix-token",level:4},{value:"External authentication",id:"external-authentication",level:4},{value:"Shared document editing using Etherpad",id:"shared-document-editing-using-etherpad",level:3},{value:"Transcription configuration",id:"transcription-configuration",level:3},{value:"Sentry logging configuration",id:"sentry-logging-configuration",level:3},{value:"TURN server configuration",id:"turn-server-configuration",level:3},{value:"Advanced configuration",id:"advanced-configuration",level:3},{value:"Advanced Prosody options",id:"advanced-prosody-options",level:4},{value:"Advanced Jicofo options",id:"advanced-jicofo-options",level:4},{value:"Advanced JVB options",id:"advanced-jvb-options",level:4},{value:"Advanced Jigasi options",id:"advanced-jigasi-options",level:4},{value:"Running behind NAT or on a LAN environment",id:"running-behind-nat-or-on-a-lan-environment",level:3},{value:"Split horizon",id:"split-horizon",level:4},{value:"Offline / airgapped installation",id:"offline--airgapped-installation",level:4},{value:"Adjust UDP buffers",id:"adjust-udp-buffers",level:3},{value:"Accessing server logs",id:"accessing-server-logs",level:2},{value:"Build Instructions",id:"build-instructions",level:2},{value:"Running behind a reverse proxy",id:"running-behind-a-reverse-proxy",level:2},{value:"Disable HTTPS",id:"disable-https",level:3},{value:"Do not expose the Jitsi Meet's ports publicly",id:"do-not-expose-the-jitsi-meets-ports-publicly",level:3},{value:"Reverse proxy configuration",id:"reverse-proxy-configuration",level:3},{value:"nginx",id:"nginx",level:4},{value:"Apache",id:"apache",level:4},{value:"Disabling WebSocket connections",id:"disabling-websocket-connections",level:3}];function h(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components},{Details:d}=n;return d||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"quick-start",children:"Quick start"}),"\n",(0,s.jsx)(n.p,{children:"In order to quickly run Jitsi Meet on a machine running Docker and Docker Compose,\nfollow these steps:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Download and extract the ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/docker-jitsi-meet/releases/latest",children:"latest release"}),". ",(0,s.jsx)(n.strong,{children:"DO NOT"})," clone the git repository. See below if you are interested in running test images:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"wget $(curl -s https://api.github.com/repos/jitsi/docker-jitsi-meet/releases/latest | grep 'zip' | cut -d\\\" -f4)\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Unzip the package:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"unzip \n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create a ",(0,s.jsx)(n.code,{children:".env"})," file by copying and adjusting ",(0,s.jsx)(n.code,{children:"env.example"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cp env.example .env\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Set strong passwords in the security section options of ",(0,s.jsx)(n.code,{children:".env"})," file by running the following bash script"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"./gen-passwords.sh\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create required ",(0,s.jsx)(n.code,{children:"CONFIG"})," directories"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"For linux:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"mkdir -p ~/.jitsi-meet-cfg/{web,transcripts,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri}\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"For Windows:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'echo web,transcripts,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri | % { mkdir "~/.jitsi-meet-cfg/$_" }\n'})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Run ",(0,s.jsx)(n.code,{children:"docker compose up -d"})]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Access the web UI at ",(0,s.jsx)(n.a,{href:"https://localhost:8443",children:(0,s.jsx)(n.code,{children:"https://localhost:8443"})})," (or a different port, in case you edited the ",(0,s.jsx)(n.code,{children:".env"})," file)."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["HTTP (not HTTPS) is also available (on port 8000, by default), but that's e.g. for a reverse proxy setup;\ndirect access via HTTP instead HTTPS leads to WebRTC errors such as\n",(0,s.jsx)(n.em,{children:"Failed to access your microphone/camera: Cannot use microphone/camera for an unknown reason. Cannot read property 'getUserMedia' of undefined"}),"\nor ",(0,s.jsx)(n.em,{children:"navigator.mediaDevices is undefined"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IMPORTANT"}),": When deploying Jitsi Meet for real use you must set the ",(0,s.jsx)(n.code,{children:"PUBLIC_URL"})," env variable to the real domain where your setup is running."]}),"\n",(0,s.jsx)(n.p,{children:"If you want to use jigasi too, first configure your env file with SIP credentials\nand then run Docker Compose as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f jigasi.yml up\n"})}),"\n",(0,s.jsxs)(n.p,{children:["If you want to enable document sharing via ",(0,s.jsx)(n.a,{href:"https://github.com/ether/etherpad-lite",children:"Etherpad"}),",\nconfigure it and run Docker Compose as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f etherpad.yml up\n"})}),"\n",(0,s.jsx)(n.p,{children:"If you want to use jibri too, first configure a host as described in Jitsi Broadcasting Infrastructure configuration section\nand then run Docker Compose as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f jibri.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"or to use jigasi too:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f jigasi.yml -f jibri.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"To include a transcriber component, run Docker Compose as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f transcriber.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"Or for them all together:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose -f docker-compose.yml -f transcriber.yml -f jigasi.yml -f jibri.yml up -d\n"})}),"\n",(0,s.jsx)(n.p,{children:"For the log analysis project, you will need both log-analyser.yml and grafana.yml files. This project allows you to analyze docker logs in grafana. If you want to run the log analyzer, run the Docker files as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker-compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Follow ",(0,s.jsx)(n.a,{href:"https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-log-analyser",children:"this"})," document for detailed information on log analysis."]}),"\n",(0,s.jsx)(n.h3,{id:"updating",children:"Updating"}),"\n",(0,s.jsx)(n.p,{children:"If you want to update, simply run"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"wget $(curl -s https://api.github.com/repos/jitsi/docker-jitsi-meet/releases/latest | grep 'zip' | cut -d\\\" -f4)\n"})}),"\n",(0,s.jsx)(n.p,{children:"again (just like how you initially downloaded Jitsi). Then unzip and overwrite all when being asked:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"unzip \n"})}),"\n",(0,s.jsx)(n.h3,{id:"testing-development--unstable-builds",children:"Testing development / unstable builds"}),"\n",(0,s.jsx)(n.p,{children:"Download the latest code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/jitsi/docker-jitsi-meet && cd docker-jitsi-meet\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["The code in ",(0,s.jsx)(n.code,{children:"master"})," is designed to work with the unstable images. Do not run it with release images."]})}),"\n",(0,s.jsxs)(n.p,{children:["Run ",(0,s.jsx)(n.code,{children:"docker compose up"})," as usual."]}),"\n",(0,s.jsx)(n.p,{children:'Every day a new "unstable" image build is uploaded.'}),"\n",(0,s.jsx)(n.h3,{id:"building-your-own-images",children:"Building your own images"}),"\n",(0,s.jsx)(n.p,{children:"Download the latest code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/jitsi/docker-jitsi-meet && cd docker-jitsi-meet\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The provided ",(0,s.jsx)(n.code,{children:"Makefile"})," provides a comprehensive way of building the whole stack or individual images."]}),"\n",(0,s.jsx)(n.p,{children:"To build all images:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"make\n"})}),"\n",(0,s.jsx)(n.p,{children:"To build a specific image (the web image for example):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"make build_web\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Once your local build is ready make sure to add ",(0,s.jsx)(n.code,{children:"JITSI_IMAGE_VERSION=latest"})," to your ",(0,s.jsx)(n.code,{children:".env"})," file."]}),"\n",(0,s.jsx)(n.h3,{id:"security-note",children:"Security note"}),"\n",(0,s.jsx)(n.p,{children:"This setup used to have default passwords for internal accounts used across components.\nIn order to make the default setup secure by default these have been removed and the respective containers won't start without having a password set."}),"\n",(0,s.jsxs)(n.p,{children:["Strong passwords may be generated as follows: ",(0,s.jsx)(n.code,{children:"./gen-passwords.sh"}),"\nThis will modify your ",(0,s.jsx)(n.code,{children:".env"})," file (a backup is saved in ",(0,s.jsx)(n.code,{children:".env.bak"}),") and set strong passwords for each of the\nrequired options. Passwords are generated using ",(0,s.jsx)(n.code,{children:"openssl rand -hex 16"})," ."]}),"\n",(0,s.jsx)(n.p,{children:"DO NOT reuse any of the passwords."}),"\n",(0,s.jsx)(n.h2,{id:"architecture",children:"Architecture"}),"\n",(0,s.jsx)(n.p,{children:"A Jitsi Meet installation can be broken down into the following components:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"A web interface"}),"\n",(0,s.jsx)(n.li,{children:"An XMPP server"}),"\n",(0,s.jsx)(n.li,{children:"A conference focus component"}),"\n",(0,s.jsx)(n.li,{children:"A video router (could be more than one)"}),"\n",(0,s.jsx)(n.li,{children:"A SIP gateway for audio calls"}),"\n",(0,s.jsx)(n.li,{children:"A Broadcasting Infrastructure for recording or streaming a conference."}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{src:i(386).A+"",width:"882",height:"505"})}),"\n",(0,s.jsx)(n.p,{children:"The diagram shows a typical deployment in a host running Docker. This project\nseparates each of the components above into interlinked containers. To this end,\nseveral container images are provided."}),"\n",(0,s.jsx)(n.h3,{id:"external-ports",children:"External Ports"}),"\n",(0,s.jsx)(n.p,{children:"The following external ports must be opened on a firewall:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"80/tcp"})," for Web UI HTTP (really just to redirect, after uncommenting ",(0,s.jsx)(n.code,{children:"ENABLE_HTTP_REDIRECT=1"})," in ",(0,s.jsx)(n.code,{children:".env"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"443/tcp"})," for Web UI HTTPS"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"10000/udp"})," for RTP media over UDP"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Also ",(0,s.jsx)(n.code,{children:"20000-20050/udp"})," for jigasi, in case you choose to deploy that to facilitate SIP access."]}),"\n",(0,s.jsx)(n.p,{children:"E.g. on a CentOS/Fedora server this would be done like this (without SIP access):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo firewall-cmd --permanent --add-port=80/tcp\nsudo firewall-cmd --permanent --add-port=443/tcp\nsudo firewall-cmd --permanent --add-port=10000/udp\nsudo firewall-cmd --reload\n"})}),"\n",(0,s.jsxs)(n.p,{children:["See ",(0,s.jsx)(n.a,{href:"https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart#setup-and-configure-your-firewall",children:"the corresponding section in the debian/ubuntu setup guide"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"Images"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"base"}),": Debian stable base image with the ",(0,s.jsx)(n.a,{href:"https://github.com/just-containers/s6-overlay",children:"S6 Overlay"})," for process control and the\n",(0,s.jsx)(n.a,{href:"https://jitsi.org/downloads/",children:"Jitsi repositories"})," enabled. All other images are based on this one."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"base-java"}),": Same as the above, plus Java (OpenJDK)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"web"}),": Jitsi Meet web UI, served with nginx."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"prosody"}),": ",(0,s.jsx)(n.a,{href:"https://prosody.im/",children:"Prosody"}),", the XMPP server."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jicofo"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jicofo",children:"Jicofo"}),", the XMPP focus component."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jvb"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-videobridge",children:"Jitsi Videobridge"}),", the video router."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jigasi"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jigasi",children:"Jigasi"}),", the SIP (audio only) gateway."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"jibri"}),": ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jibri",children:"Jibri"}),", the broadcasting infrastructure."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"design-considerations",children:"Design considerations"}),"\n",(0,s.jsx)(n.p,{children:"Jitsi Meet uses XMPP for signaling, thus the need for the XMPP server.\nThe setup provided by these containers does not expose the XMPP server to the outside world.\nInstead, it's kept completely sealed, and routing of XMPP traffic only happens on a user-defined network."}),"\n",(0,s.jsx)(n.p,{children:"The XMPP server can be exposed to the outside world,\nbut that's out of the scope of this project."}),"\n",(0,s.jsx)(n.h2,{id:"configuration",children:"Configuration"}),"\n",(0,s.jsxs)(n.p,{children:["The configuration is performed via environment variables contained in a ",(0,s.jsx)(n.code,{children:".env"})," file.\nYou can copy the provided ",(0,s.jsx)(n.code,{children:"env.example"})," file as a reference."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"CONFIG"})}),(0,s.jsx)(n.td,{children:"Directory where all configuration will be stored"}),(0,s.jsx)(n.td,{children:"/opt/jitsi-meet-cfg"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TZ"})}),(0,s.jsx)(n.td,{children:"System Time Zone"}),(0,s.jsx)(n.td,{children:"Europe/Amsterdam"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"HTTP_PORT"})}),(0,s.jsx)(n.td,{children:"Exposed port for HTTP traffic"}),(0,s.jsx)(n.td,{children:"8000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"HTTPS_PORT"})}),(0,s.jsx)(n.td,{children:"Exposed port for HTTPS traffic"}),(0,s.jsx)(n.td,{children:"8443"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_ADVERTISE_IPS"})}),(0,s.jsx)(n.td,{children:"IP addresses of the Docker host (comma separated), needed for LAN environments"}),(0,s.jsx)(n.td,{children:"192.168.1.1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PUBLIC_URL"})}),(0,s.jsx)(n.td,{children:"Public URL for the web service"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://meet.example.com",children:"https://meet.example.com"})})]})]})]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"The mobile apps won't work with self-signed certificates (the default).\nSee below for instructions on how to obtain a proper certificate with Let's Encrypt."})}),"\n",(0,s.jsx)(n.h3,{id:"tls-configuration",children:"TLS Configuration"}),"\n",(0,s.jsx)(n.h4,{id:"lets-encrypt-configuration",children:"Let's Encrypt configuration"}),"\n",(0,s.jsx)(n.p,{children:"If you want to expose your Jitsi Meet instance to the outside traffic directly, but don't own a proper TLS certificate, you are in luck\nbecause Let's Encrypt support is built right in. Here are the required options:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_LETSENCRYPT"})}),(0,s.jsx)(n.td,{children:"Enable Let's Encrypt certificate generation"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LETSENCRYPT_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Domain for which to generate the certificate"}),(0,s.jsx)(n.td,{children:"meet.example.com"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LETSENCRYPT_EMAIL"})}),(0,s.jsx)(n.td,{children:"E-Mail for receiving important account notifications (mandatory)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"mailto:alice@atlanta.net",children:"alice@atlanta.net"})})]})]})]}),"\n",(0,s.jsxs)(n.p,{children:["In addition, you will need to set ",(0,s.jsx)(n.code,{children:"HTTP_PORT"})," to 80 and ",(0,s.jsx)(n.code,{children:"HTTPS_PORT"})," to 443 and PUBLIC_URL to your domain.\nYou might also consider to redirect HTTP traffic to HTTPS by setting ",(0,s.jsx)(n.code,{children:"ENABLE_HTTP_REDIRECT=1"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Let's Encrypt rate limit warning"}),": Let's Encrypt has a limit to how many times you can submit a request\nfor a new certificate for your domain name. At the time of writing, the current limit is five new (duplicate)\ncertificates for the same domain name every seven days. Because of this, it is recommended that you disable the\nLet's Encrypt environment variables from ",(0,s.jsx)(n.code,{children:".env"})," if you plan on deleting the ",(0,s.jsx)(n.code,{children:".jitsi-meet-cfg"})," folder.\nOtherwise, you might want to consider moving the ",(0,s.jsx)(n.code,{children:".jitsi-meet-cfg"})," folder to a different location so you have a safe place to find\nthe certificate that already Let's Encrypt issued. Or do initial testing with Let's Encrypt disabled, then re-enable\nLet's Encrypt once you are done testing."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["When you move away from ",(0,s.jsx)(n.code,{children:"LETSENCRYPT_USE_STAGING"}),",\nyou will have to manually clear the certificates from ",(0,s.jsx)(n.code,{children:".jitsi-meet-cfg/web"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["For more information on Let's Encrypt's rate limits, visit:\n",(0,s.jsx)(n.a,{href:"https://letsencrypt.org/docs/rate-limits/",children:"https://letsencrypt.org/docs/rate-limits/"})]}),"\n",(0,s.jsx)(n.h4,{id:"using-existing-tls-certificate-and-key",children:"Using existing TLS certificate and key"}),"\n",(0,s.jsx)(n.p,{children:"If you own a proper TLS certificate and don't need a Let's Encrypt certificate, you can configure Jitsi Meet container\nto use it."}),"\n",(0,s.jsxs)(n.p,{children:["Unlike Let's Encrypt certificates, this is not configured through the ",(0,s.jsx)(n.code,{children:".env"}),"file, but by telling Jitsi Meet's ",(0,s.jsx)(n.code,{children:"web"})," service\nto mount the following two volumes:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["mount ",(0,s.jsx)(n.code,{children:"/path/to/your/cert.key"})," file to ",(0,s.jsx)(n.code,{children:"/config/keys/cert.key"})," mount point"]}),"\n",(0,s.jsxs)(n.li,{children:["mount ",(0,s.jsx)(n.code,{children:"/path/to/your/cert.fullchain"})," file to the ",(0,s.jsx)(n.code,{children:"/config/keys/cert.crt"})," mount point."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Doing it in ",(0,s.jsx)(n.code,{children:"docker-compose.yml"})," file should look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:"services:\n web:\n ...\n volumes:\n ...\n - /path/to/your/cert.fullchain:/config/keys/cert.crt\n - /path/to/your/cert.key:/config/keys/cert.key\n"})}),"\n",(0,s.jsx)(n.h3,{id:"features-configuration-configjs",children:"Features configuration (config.js)"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TOOLBAR_BUTTONS"})}),(0,s.jsx)(n.td,{children:"Configure toolbar buttons. Add the buttons name separated with comma(no spaces between comma)"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"HIDE_PREMEETING_BUTTONS"})}),(0,s.jsx)(n.td,{children:"Hide the buttons at pre-join screen. Add the buttons name separated with comma"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_LOBBY"})}),(0,s.jsx)(n.td,{children:"Control whether the lobby feature should be enabled or not"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AV_MODERATION"})}),(0,s.jsx)(n.td,{children:"Control whether the A/V moderation should be enabled or not"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_PREJOIN_PAGE"})}),(0,s.jsx)(n.td,{children:"Show a prejoin page before entering a conference"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_WELCOME_PAGE"})}),(0,s.jsx)(n.td,{children:"Enable the welcome page"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_CLOSE_PAGE"})}),(0,s.jsx)(n.td,{children:"Enable the close page"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DISABLE_AUDIO_LEVELS"})}),(0,s.jsx)(n.td,{children:"Disable measuring of audio levels"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_NOISY_MIC_DETECTION"})}),(0,s.jsx)(n.td,{children:"Enable noisy mic detection"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_BREAKOUT_ROOMS"})}),(0,s.jsx)(n.td,{children:"Enable breakout rooms"}),(0,s.jsx)(n.td,{children:"1"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"jigasi-sip-gateway-audio-only-configuration",children:"Jigasi SIP gateway (audio only) configuration"}),"\n",(0,s.jsx)(n.p,{children:"If you want to enable the SIP gateway, these options are required:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_URI"})}),(0,s.jsx)(n.td,{children:"SIP URI for incoming / outgoing calls"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"mailto:test@sip2sip.info",children:"test@sip2sip.info"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_PASSWORD"})}),(0,s.jsx)(n.td,{children:"Password for the specified SIP account"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_SERVER"})}),(0,s.jsx)(n.td,{children:"SIP server (use the SIP account domain if in doubt)"}),(0,s.jsx)(n.td,{children:"sip2sip.info"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_PORT"})}),(0,s.jsx)(n.td,{children:"SIP server port"}),(0,s.jsx)(n.td,{children:"5060"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_TRANSPORT"})}),(0,s.jsx)(n.td,{children:"SIP transport"}),(0,s.jsx)(n.td,{children:"UDP"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"display-dial-in-information",children:"Display Dial-In information"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DIALIN_NUMBERS_URL"})}),(0,s.jsx)(n.td,{children:"URL to the JSON with all Dial-In numbers"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://meet.example.com/dialin.json",children:"https://meet.example.com/dialin.json"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"CONFCODE_URL"})}),(0,s.jsx)(n.td,{children:"URL to the API for checking/generating Dial-In codes"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://jitsi-api.jitsi.net/conferenceMapper",children:"https://jitsi-api.jitsi.net/conferenceMapper"})})]})]})]}),"\n",(0,s.jsx)(n.p,{children:"The JSON with the Dial-In numbers should look like this:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-json",children:'{"message":"Dial-In numbers:","numbers":{"DE": ["+49-721-0000-0000"]},"numbersEnabled":true}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"recording--live-streaming-configuration-with-jibri",children:"Recording / live streaming configuration with Jibri"}),"\n",(0,s.jsxs)(d,{children:[(0,s.jsxs)(n.p,{children:[(0,s.jsx)("summary",{children:"If you are using a release older than 7439 some extra setup is necessary."}),"\nBefore running Jibri ",(0,s.jsx)(n.strong,{children:"on releases older than 7439"}),", you need to set up an ALSA loopback device on the host.\nThis ",(0,s.jsx)(n.strong,{children:"will not"})," work on a non-Linux host."]}),(0,s.jsx)(n.p,{children:"For CentOS 7, the module is already compiled with the kernel, so just run:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'# configure 5 capture/playback interfaces\necho "options snd-aloop enable=1,1,1,1,1 index=0,1,2,3,4" > /etc/modprobe.d/alsa-loopback.conf\n# setup autoload the module\necho "snd_aloop" > /etc/modules-load.d/snd_aloop.conf\n# load the module\nmodprobe snd-aloop\n# check that the module is loaded\nlsmod | grep snd_aloop\n'})}),(0,s.jsx)(n.p,{children:"For Ubuntu:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'# install the module\napt update && apt install linux-image-extra-virtual\n# configure 5 capture/playback interfaces\necho "options snd-aloop enable=1,1,1,1,1 index=0,1,2,3,4" > /etc/modprobe.d/alsa-loopback.conf\n# setup autoload the module\necho "snd-aloop" >> /etc/modules\n# check that the module is loaded\nlsmod | grep snd_aloop\n'})}),(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:'If you are running on AWS you may need to reboot your machine to use the generic kernel instead\nof the "aws" kernel. If after reboot, your machine is still using the "aws" kernel, you\'ll need to manually update the grub file. So just run:'})}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'# open the grub file in editor\nnano /etc/default/grub\n# Modify the value of GRUB_DEFAULT from "0" to "1>2"\n# Save and exit from file\n\n# Update grub\nupdate-grub\n# Reboot the machine\nreboot now\n'})}),(0,s.jsx)(n.p,{children:"For using multiple Jibri instances, you have to select different loopback interfaces for each instance manually."}),(0,s.jsx)(n.p,{children:"Default the first instance has:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'...\nslave.pcm "hw:Loopback,0,0"\n...\nslave.pcm "hw:Loopback,0,1"\n...\nslave.pcm "hw:Loopback,1,1"\n...\nslave.pcm "hw:Loopback,1,0"\n...\n'})}),(0,s.jsxs)(n.p,{children:["To setup the second instance, run container with changed ",(0,s.jsx)(n.code,{children:"/home/jibri/.asoundrc"}),":"]}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'...\nslave.pcm "hw:Loopback_1,0,0"\n...\nslave.pcm "hw:Loopback_1,0,1"\n...\nslave.pcm "hw:Loopback_1,1,1"\n...\nslave.pcm "hw:Loopback_1,1,0"\n...\n'})}),(0,s.jsxs)(n.p,{children:["Also you can use numbering id for set loopback interface. The third instance will have ",(0,s.jsx)(n.code,{children:".asoundrc"})," that looks like:"]}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'...\nslave.pcm "hw:2,0,0"\n...\nslave.pcm "hw:2,0,1"\n...\nslave.pcm "hw:2,1,1"\n...\nslave.pcm "hw:2,1,0"\n...\n\n'})})]}),"\n",(0,s.jsx)(n.p,{children:"If you want to enable Jibri these options are required:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_RECORDING"})}),(0,s.jsx)(n.td,{children:"Enable recording / live streaming"}),(0,s.jsx)(n.td,{children:"1"})]})})]}),"\n",(0,s.jsx)(n.p,{children:"Extended Jibri configuration:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_RECORDER_USER"})}),(0,s.jsx)(n.td,{children:"Internal recorder user for Jibri client connections"}),(0,s.jsx)(n.td,{children:"recorder"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_RECORDER_PASSWORD"})}),(0,s.jsx)(n.td,{children:"Internal recorder password for Jibri client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_RECORDING_DIR"})}),(0,s.jsx)(n.td,{children:"Directory for recordings inside Jibri container"}),(0,s.jsx)(n.td,{children:"/config/recordings"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_FINALIZE_RECORDING_SCRIPT_PATH"})}),(0,s.jsx)(n.td,{children:"The finalizing script. Will run after recording is complete"}),(0,s.jsx)(n.td,{children:"/config/finalize.sh"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_XMPP_USER"})}),(0,s.jsx)(n.td,{children:"Internal user for Jibri client connections."}),(0,s.jsx)(n.td,{children:"jibri"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_STRIP_DOMAIN_JID"})}),(0,s.jsx)(n.td,{children:"Prefix domain for strip inside Jibri (please see env.example for details)"}),(0,s.jsx)(n.td,{children:"muc"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_BREWERY_MUC"})}),(0,s.jsx)(n.td,{children:"MUC name for the Jibri pool"}),(0,s.jsx)(n.td,{children:"jibribrewery"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIBRI_PENDING_TIMEOUT"})}),(0,s.jsx)(n.td,{children:"MUC connection timeout"}),(0,s.jsx)(n.td,{children:"90"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-meet-configuration",children:"Jitsi Meet configuration"}),"\n",(0,s.jsxs)(n.p,{children:["Jitsi-Meet uses two configuration files for changing default settings within\nthe web interface: ",(0,s.jsx)(n.code,{children:"config.js"})," and ",(0,s.jsx)(n.code,{children:"interface_config.js"}),". The files are\nlocated within the ",(0,s.jsx)(n.code,{children:"CONFIG/web/"})," directory configured within your environment file."]}),"\n",(0,s.jsxs)(n.p,{children:["These files are re-created on every container restart.\nIf you'd like to provide your own settings, create your own config files:\n",(0,s.jsx)(n.code,{children:"custom-config.js"})," and ",(0,s.jsx)(n.code,{children:"custom-interface_config.js"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"It's enough to provide your relevant settings only, the docker scripts will\nappend your custom files to the default ones!"}),"\n",(0,s.jsx)(n.h3,{id:"authentication",children:"Authentication"}),"\n",(0,s.jsx)(n.p,{children:"Authentication can be controlled with the environment variables below. If guest\naccess is enabled, unauthenticated users will need to wait until a user authenticates\nbefore they can join a room. If guest access is not enabled, every user will need\nto authenticate before they can join."}),"\n",(0,s.jsxs)(n.p,{children:["If authentication is enabled, once an authenticated user logged in, it is always\nlogged in before the session timeout. You can set ",(0,s.jsx)(n.code,{children:"ENABLE_AUTO_LOGIN=0"})," to disable\nthis default auto login feature or you can set ",(0,s.jsx)(n.code,{children:"JICOFO_AUTH_LIFETIME"})," to limit\nthe session lifetime."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})}),(0,s.jsx)(n.td,{children:"Enable authentication"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_GUESTS"})}),(0,s.jsx)(n.td,{children:"Enable guest access"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"Select authentication type (internal, jwt or ldap)"}),(0,s.jsx)(n.td,{children:"internal"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AUTO_LOGIN"})}),(0,s.jsx)(n.td,{children:"Enable auto login"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_LIFETIME"})}),(0,s.jsx)(n.td,{children:"Select session timeout value for an authenticated user"}),(0,s.jsx)(n.td,{children:"3 hours"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"internal-authentication",children:"Internal authentication"}),"\n",(0,s.jsxs)(n.p,{children:["The default authentication mode (",(0,s.jsx)(n.code,{children:"internal"}),") uses XMPP credentials to authenticate users.\nTo enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and set ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to ",(0,s.jsx)(n.code,{children:"internal"}),",\nthen configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.p,{children:["Internal users must be created with the ",(0,s.jsx)(n.code,{children:"prosodyctl"})," utility in the ",(0,s.jsx)(n.code,{children:"prosody"})," container.\nIn order to do that, first, execute a shell in the corresponding container:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker compose exec prosody /bin/bash\n"})}),"\n",(0,s.jsx)(n.p,{children:"Once in the container, run the following command to create a user:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"prosodyctl --config /config/prosody.cfg.lua register TheDesiredUsername meet.jitsi TheDesiredPassword\n"})}),"\n",(0,s.jsx)(n.p,{children:"Note that the command produces no output."}),"\n",(0,s.jsx)(n.p,{children:"To delete a user, run the following command in the container:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"prosodyctl --config /config/prosody.cfg.lua unregister TheDesiredUsername meet.jitsi\n"})}),"\n",(0,s.jsx)(n.p,{children:"To list all users, run the following command in the container:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"find /config/data/meet%2ejitsi/accounts -type f -exec basename {} .dat \\;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-ldap",children:"Authentication using LDAP"}),"\n",(0,s.jsxs)(n.p,{children:["You can use LDAP to authenticate users. To enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and\nset ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to ",(0,s.jsx)(n.code,{children:"ldap"}),", then configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_URL"})}),(0,s.jsx)(n.td,{children:"URL for ldap connection"}),(0,s.jsx)(n.td,{children:"ldaps://ldap.domain.com/"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_BASE"})}),(0,s.jsx)(n.td,{children:"LDAP base DN. Can be empty."}),(0,s.jsx)(n.td,{children:"DC=example,DC=domain,DC=com"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_BINDDN"})}),(0,s.jsx)(n.td,{children:"LDAP user DN. Do not specify this parameter for the anonymous bind."}),(0,s.jsx)(n.td,{children:"CN=binduser,OU=users,DC=example,DC=domain,DC=com"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_BINDPW"})}),(0,s.jsx)(n.td,{children:"LDAP user password. Do not specify this parameter for the anonymous bind."}),(0,s.jsx)(n.td,{children:"LdapUserPassw0rd"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_FILTER"})}),(0,s.jsx)(n.td,{children:"LDAP filter."}),(0,s.jsx)(n.td,{children:"(sAMAccountName=%u)"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_AUTH_METHOD"})}),(0,s.jsx)(n.td,{children:"LDAP authentication method."}),(0,s.jsx)(n.td,{children:"bind"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_VERSION"})}),(0,s.jsx)(n.td,{children:"LDAP protocol version"}),(0,s.jsx)(n.td,{children:"3"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_USE_TLS"})}),(0,s.jsx)(n.td,{children:"Enable LDAP TLS"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CIPHERS"})}),(0,s.jsx)(n.td,{children:"Set TLS ciphers list to allow"}),(0,s.jsxs)(n.td,{children:["SECURE256",":SECURE128"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CHECK_PEER"})}),(0,s.jsx)(n.td,{children:"Require and verify LDAP server certificate"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CACERT_FILE"})}),(0,s.jsx)(n.td,{children:"Path to CA cert file. Used when server certificate verification is enabled"}),(0,s.jsx)(n.td,{children:"/etc/ssl/certs/ca-certificates.crt"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_TLS_CACERT_DIR"})}),(0,s.jsx)(n.td,{children:"Path to CA certs directory. Used when server certificate verification is enabled."}),(0,s.jsx)(n.td,{children:"/etc/ssl/certs"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LDAP_START_TLS"})}),(0,s.jsx)(n.td,{children:"Enable START_TLS, requires LDAPv3, URL must be ldap:// not ldaps://"}),(0,s.jsx)(n.td,{children:"0"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-jwt-tokens",children:"Authentication using JWT tokens"}),"\n",(0,s.jsxs)(n.p,{children:["You can use JWT tokens to authenticate users. To enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and\nset ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to ",(0,s.jsx)(n.code,{children:"jwt"}),", then configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_ID"})}),(0,s.jsx)(n.td,{children:"Application identifier"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_id"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_SECRET"})}),(0,s.jsx)(n.td,{children:"Application secret known only to your token"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_secret"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ACCEPTED_ISSUERS"})}),(0,s.jsx)(n.td,{children:"(Optional) Set asap_accepted_issuers as a comma separated list"}),(0,s.jsx)(n.td,{children:"my_web_client,my_app_client"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ACCEPTED_AUDIENCES"})}),(0,s.jsx)(n.td,{children:"(Optional) Set asap_accepted_audiences as a comma separated list"}),(0,s.jsx)(n.td,{children:"my_server1,my_server2"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ASAP_KEYSERVER"})}),(0,s.jsx)(n.td,{children:"(Optional) Set asap_keyserver to a url where public keys can be found"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://example.com/asap%3E",children:"https://example.com/asap>"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ALLOW_EMPTY"})}),(0,s.jsx)(n.td,{children:"(Optional) Allow anonymous users with no JWT while validating JWTs when provided"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"(Optional) Controls which module is used for processing incoming JWTs"}),(0,s.jsx)(n.td,{children:"token"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_TOKEN_AUTH_MODULE"})}),(0,s.jsx)(n.td,{children:"(Optional) Controls which module is used for validating JWTs"}),(0,s.jsx)(n.td,{children:"token_verification"})]})]})]}),"\n",(0,s.jsxs)(n.p,{children:["This can be tested using the ",(0,s.jsx)(n.a,{href:"https://jwt.io/#debugger-io",children:"jwt.io"})," debugger. Use the following sample payload:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-json",children:'{\n "context": {\n "user": {\n "avatar": "https://robohash.org/john-doe",\n "name": "John Doe",\n "email": "jdoe@example.com"\n }\n },\n "aud": "my_jitsi_app_id",\n "iss": "my_jitsi_app_id",\n "sub": "meet.jitsi",\n "room": "*"\n}\n'})}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-matrix",children:"Authentication using Matrix"}),"\n",(0,s.jsxs)(n.p,{children:['For more information see the documentation of the "Prosody Auth Matrix User Verification" ',(0,s.jsx)(n.a,{href:"https://github.com/matrix-org/prosody-mod-auth-matrix-user-verification",children:"here"}),"."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_URL"})}),(0,s.jsx)(n.td,{children:"Base URL to the matrix user verification service (without ending slash)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://uvs.example.com:3000"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_ISSUER"})}),(0,s.jsxs)(n.td,{children:["(optional) The issuer of the auth token to be passed through. Must match what is being set as ",(0,s.jsx)(n.code,{children:"iss"})," in the JWT."]}),(0,s.jsx)(n.td,{children:"issuer (default)"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_AUTH_TOKEN"})}),(0,s.jsx)(n.td,{children:"(optional) user verification service auth token, if authentication enabled"}),(0,s.jsx)(n.td,{children:"changeme"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_SYNC_POWER_LEVELS"})}),(0,s.jsx)(n.td,{children:"(optional) Make Matrix room moderators owners of the Prosody room."}),(0,s.jsx)(n.td,{children:"1"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"authentication-using-hybrid-matrix-token",children:"Authentication using Hybrid Matrix Token"}),"\n",(0,s.jsxs)(n.p,{children:["You can use ",(0,s.jsx)(n.code,{children:"Hybrid Matrix Token"})," to authenticate users. It supports ",(0,s.jsx)(n.code,{children:"Matrix"})," and ",(0,s.jsx)(n.code,{children:"JWT Token"})," authentications\non the same setup. To enable it you have to enable authentication with ",(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})," and set ",(0,s.jsx)(n.code,{children:"AUTH_TYPE"})," to\n",(0,s.jsx)(n.code,{children:"hybrid_matrix_token"}),", then configure the settings you can see below."]}),"\n",(0,s.jsxs)(n.p,{children:['For more information see the documentation of the "Hybrid Matrix Token"\n',(0,s.jsx)(n.a,{href:"https://github.com/jitsi-contrib/prosody-plugins/tree/main/auth_hybrid_matrix_token",children:"here"}),"."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_URL"})}),(0,s.jsx)(n.td,{children:"Base URL to the matrix user verification service (without ending slash)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://uvs.example.com:3000"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_ISSUER"})}),(0,s.jsxs)(n.td,{children:["(optional) The issuer of the auth token to be passed through. Must match what is being set as ",(0,s.jsx)(n.code,{children:"iss"})," in the JWT. It allows all issuers (",(0,s.jsx)(n.code,{children:"*"}),") by default."]}),(0,s.jsx)(n.td,{children:"my_issuer"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_AUTH_TOKEN"})}),(0,s.jsx)(n.td,{children:"(optional) user verification service auth token, if authentication enabled"}),(0,s.jsx)(n.td,{children:"my_matrix_secret"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_UVS_SYNC_POWER_LEVELS"})}),(0,s.jsx)(n.td,{children:"(optional) Make Matrix room moderators owners of the Prosody room."}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"MATRIX_LOBBY_BYPASS"})}),(0,s.jsx)(n.td,{children:"(optional) Allow Matrix room members to bypass Jitsi lobby check."}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_ID"})}),(0,s.jsx)(n.td,{children:"Application identifier"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_id"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_APP_SECRET"})}),(0,s.jsx)(n.td,{children:"Application secret known only to your token"}),(0,s.jsx)(n.td,{children:"my_jitsi_app_secret"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JWT_ALLOW_EMPTY"})}),(0,s.jsx)(n.td,{children:"(Optional) Allow anonymous users with no JWT while validating JWTs when provided"}),(0,s.jsx)(n.td,{children:"0"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"external-authentication",children:"External authentication"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TOKEN_AUTH_URL"})}),(0,s.jsx)(n.td,{children:"Authenticate using external service or just focus external auth window if there is one already."}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://auth.meet.example.com/%7Broom%7D%3E",children:"https://auth.meet.example.com/{room}>"})})]})})]}),"\n",(0,s.jsx)(n.h3,{id:"shared-document-editing-using-etherpad",children:"Shared document editing using Etherpad"}),"\n",(0,s.jsxs)(n.p,{children:["You can collaboratively edit a document via ",(0,s.jsx)(n.a,{href:"https://github.com/ether/etherpad-lite",children:"Etherpad"}),". In order to enable it, set the config options below and run\nDocker Compose with the additional config file ",(0,s.jsx)(n.code,{children:"etherpad.yml"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"Here are the required options:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ETHERPAD_URL_BASE"})}),(0,s.jsx)(n.td,{children:"Set etherpad-lite URL"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"http://etherpad.meet.jitsi:9001"})})]})})]}),"\n",(0,s.jsx)(n.h3,{id:"transcription-configuration",children:"Transcription configuration"}),"\n",(0,s.jsx)(n.p,{children:"If you want to enable the Transcribing function, set the config options below and run Docker Compose with the additional config file transcriber.yml."}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Example"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_TRANSCRIPTIONS"})}),(0,s.jsx)(n.td,{children:"Enable Jigasi transcription in a conference"}),(0,s.jsx)(n.td,{children:"1"})]})})]}),"\n",(0,s.jsx)(n.p,{children:"In addition, the following are options are used to configure the various transcription backends and features:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_PROJECT_ID"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"project_id"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_PRIVATE_KEY_ID"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"private_key_id"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_PRIVATE_KEY"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"private_key"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_CLIENT_EMAIL"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"client_email"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_CLIENT_ID"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"client_id"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GC_CLIENT_CERT_URL"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"client_x509_cert_url"})," from Google Cloud Credentials"]}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_ADVERTISE_URL"})}),(0,s.jsx)(n.td,{children:"Jigasi will post an url to the chat with transcription file"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_CUSTOM_SERVICE"})}),(0,s.jsx)(n.td,{children:"Jigasi will use this class for custom transcriptions instead of google cloud"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_CUSTOM_TRANSLATION_SERVICE"})}),(0,s.jsx)(n.td,{children:"Jigasi will use this class for custom transctions instead of google cloud"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_ENABLE_SAVING"})}),(0,s.jsx)(n.td,{children:"Jigasi will save results to a transcription file"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_FILTER_SILENCE"})}),(0,s.jsx)(n.td,{children:"Jigasi will filter silent audio and not forward to backends"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_LIBRETRANSLATE_URL"})}),(0,s.jsx)(n.td,{children:"URL for libretranslate services"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_OCI_COMPARTMENT"})}),(0,s.jsx)(n.td,{children:"OCI compartment for use with Oracle Cloud Speech AI services"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_OCI_REGION"})}),(0,s.jsx)(n.td,{children:"OCI region name for use with Oracle Cloud Speech AI services"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_RECORD_AUDIO"})}),(0,s.jsx)(n.td,{children:"Jigasi will record audio when transcriber is on"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_REMOTE_CONFIG_URL"})}),(0,s.jsx)(n.td,{children:"URL to control transcriber custom service based on conference details"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_SEND_TXT"})}),(0,s.jsx)(n.td,{children:"Jigasi will send transcribed text to the chat when transcriber is on"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_USER"})}),(0,s.jsx)(n.td,{children:"Jigasi XMPP user"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_VOSK_URL"})}),(0,s.jsx)(n.td,{children:"URL for use with vosk backend"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_WHISPER_URL"})}),(0,s.jsx)(n.td,{children:"URL for use with whisper backend"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEY_NAME"})}),(0,s.jsx)(n.td,{children:"Private Key ID of the private key to use with whisper"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEY"})}),(0,s.jsx)(n.td,{children:"Private Key material to use with whisper, without newlines or START/END delimiters"}),(0,s.jsx)(n.td,{})]})]})]}),"\n",(0,s.jsxs)(n.p,{children:["For setting the Google Cloud Credentials please read ",(0,s.jsx)(n.a,{href:"https://cloud.google.com/text-to-speech/docs/quickstart-protocol",children:"https://cloud.google.com/text-to-speech/docs/quickstart-protocol"}),' > section "Before you begin" paragraph 1 to 5.']}),"\n",(0,s.jsx)(n.h3,{id:"sentry-logging-configuration",children:"Sentry logging configuration"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_SENTRY_DSN"})}),(0,s.jsx)(n.td,{children:"Sentry Data Source Name (Endpoint for Sentry project)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://public:private@host:port/1"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_SENTRY_DSN"})}),(0,s.jsx)(n.td,{children:"Sentry Data Source Name (Endpoint for Sentry project)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://public:private@host:port/1"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SENTRY_DSN"})}),(0,s.jsx)(n.td,{children:"Sentry Data Source Name (Endpoint for Sentry project)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://public:private@host:port/1"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"SENTRY_ENVIRONMENT"})}),(0,s.jsx)(n.td,{children:"Optional environment info to filter events"}),(0,s.jsx)(n.td,{children:"production"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"SENTRY_RELEASE"})}),(0,s.jsx)(n.td,{children:"Optional release info to filter events"}),(0,s.jsx)(n.td,{children:"1.0.0"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"turn-server-configuration",children:"TURN server configuration"}),"\n",(0,s.jsx)(n.p,{children:"Configure external TURN servers."}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_CREDENTIALS"})}),(0,s.jsx)(n.td,{children:"Credentials for TURN servers"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_HOST"})}),(0,s.jsx)(n.td,{children:"TURN server hostnames as a comma separated list (UDP or TCP transport)"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_PORT"})}),(0,s.jsx)(n.td,{children:"TURN server port (UDP or TCP transport)"}),(0,s.jsx)(n.td,{children:"443"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_TRANSPORT"})}),(0,s.jsx)(n.td,{children:"TURN server protocols as a comma separated list (UDP or TCP or both)"}),(0,s.jsx)(n.td,{children:"tcp"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURNS_HOST"})}),(0,s.jsx)(n.td,{children:"TURN server hostnames as a comma separated list (TLS transport)"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURNS_PORT"})}),(0,s.jsx)(n.td,{children:"TURN server port (TLS transport)"}),(0,s.jsx)(n.td,{children:"443"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"TURN_TLL"})}),(0,s.jsx)(n.td,{children:"TURN max allocation duration (sec)"}),(0,s.jsx)(n.td,{children:"86400"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"advanced-configuration",children:"Advanced configuration"}),"\n",(0,s.jsx)(n.p,{children:"These configuration options are already set and generally don't need to be changed."}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Internal XMPP domain"}),(0,s.jsx)(n.td,{children:"meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_AUTH_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Internal XMPP domain for authenticated services"}),(0,s.jsx)(n.td,{children:"auth.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_SERVER"})}),(0,s.jsx)(n.td,{children:"Internal XMPP server name xmpp.meet.jitsi"}),(0,s.jsx)(n.td,{children:"xmpp.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_BOSH_URL_BASE"})}),(0,s.jsx)(n.td,{children:"Internal XMPP server URL for BOSH module"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"http://xmpp.meet.jitsi:5280"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_MUC_DOMAIN"})}),(0,s.jsx)(n.td,{children:"XMPP domain for the MUC"}),(0,s.jsx)(n.td,{children:"muc.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_INTERNAL_MUC_DOMAIN"})}),(0,s.jsx)(n.td,{children:"XMPP domain for the internal MUC"}),(0,s.jsx)(n.td,{children:"internal-muc.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_GUEST_DOMAIN"})}),(0,s.jsx)(n.td,{children:"XMPP domain for unauthenticated users"}),(0,s.jsx)(n.td,{children:"guest.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_RECORDER_DOMAIN"})}),(0,s.jsx)(n.td,{children:"Domain for the jibri recorder"}),(0,s.jsx)(n.td,{children:"recorder.meet.jitsi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom Prosody modules for XMPP_DOMAIN (comma separated)"}),(0,s.jsx)(n.td,{children:"info,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_MUC_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom Prosody modules for MUC component (comma separated)"}),(0,s.jsx)(n.td,{children:"info,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"XMPP_INTERNAL_MUC_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom Prosody modules for internal MUC component (comma separated)"}),(0,s.jsx)(n.td,{children:"info,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GLOBAL_MODULES"})}),(0,s.jsx)(n.td,{children:"Custom prosody modules to load in global configuration (comma separated)"}),(0,s.jsx)(n.td,{children:"statistics,alert"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"GLOBAL_CONFIG"})}),(0,s.jsx)(n.td,{children:"Custom configuration string with escaped newlines"}),(0,s.jsx)(n.td,{children:"foo = bar;\\nkey = val;"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"RESTART_POLICY"})}),(0,s.jsx)(n.td,{children:"Container restart policy"}),(0,s.jsxs)(n.td,{children:["defaults to ",(0,s.jsx)(n.code,{children:"unless-stopped"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DISABLE_HTTPS"})}),(0,s.jsx)(n.td,{children:"Handle TLS connections outside of this setup"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_HTTP_REDIRECT"})}),(0,s.jsx)(n.td,{children:"Redirect HTTP traffic to HTTPS"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"LOG_LEVEL"})}),(0,s.jsx)(n.td,{children:"Controls which logs are output from prosody and associated modules"}),(0,s.jsx)(n.td,{children:"info"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_HSTS"})}),(0,s.jsxs)(n.td,{children:["Send a ",(0,s.jsx)(n.code,{children:"strict-transport-security"})," header to force browsers to use a secure and trusted connection. Recommended for production use."]}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_IPV6"})}),(0,s.jsx)(n.td,{children:"Provides means to disable IPv6 in environments that don't support it"}),(0,s.jsx)(n.td,{children:"1"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_COLIBRI_WEBSOCKET_UNSAFE_REGEX"})}),(0,s.jsxs)(n.td,{children:["Enabled older unsafe regex for JVB colibri-ws URLs. WARNING: Enable with caution, this regex allows connections to arbitrary internal IP addresses and is not recommended for production use. Unsafe regex is defined as ",(0,s.jsx)(n.code,{children:"[a-zA-Z0-9-\\._]+"})]}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME"})}),(0,s.jsxs)(n.td,{children:["DNS name to look up JVB IP address, used for default value of ",(0,s.jsx)(n.code,{children:"COLIBRI_WEBSOCKET_REGEX"})]}),(0,s.jsx)(n.td,{children:"jvb"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"COLIBRI_WEBSOCKET_REGEX"})}),(0,s.jsx)(n.td,{children:"Overrides the colibri regex used for proxying to JVB. Recommended to override in production with values matching possible JVB IP ranges"}),(0,s.jsxs)(n.td,{children:["defaults to ",(0,s.jsx)(n.code,{children:"dig $COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME"})," unless ",(0,s.jsx)(n.code,{children:"DISABLE_COLIBRI_WEBSOCKET_JVB_LOOKUP"})," is set to true"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"DISABLE_COLIBRI_WEBSOCKET_JVB_LOOKUP"})}),(0,s.jsxs)(n.td,{children:["Controls whether to run ",(0,s.jsx)(n.code,{children:"dig $COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME"})," when defining COLIBRI_WEBSOCKET_REGEX"]}),(0,s.jsx)(n.td,{children:"0"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-prosody-options",children:"Advanced Prosody options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_RESERVATION_ENABLED"})}),(0,s.jsx)(n.td,{children:"Enable Prosody's reservation REST API"}),(0,s.jsx)(n.td,{children:"false"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_RESERVATION_REST_BASE_URL"})}),(0,s.jsx)(n.td,{children:"Base URL of Prosody's reservation REST API"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"Select authentication type for Prosody (internal, jwt or ldap)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"AUTH_TYPE"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_ENABLE_METRICS"})}),(0,s.jsxs)(n.td,{children:["Enables the http_openmetrics module which exposes Prometheus metrics at ",(0,s.jsx)(n.code,{children:"/metrics"})]}),(0,s.jsx)(n.td,{children:"false"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"PROSODY_METRICS_ALLOWED_CIDR"})}),(0,s.jsx)(n.td,{children:"CIDR block permitted to access metrics"}),(0,s.jsx)(n.td,{children:"172.16.0.0/12"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-jicofo-options",children:"Advanced Jicofo options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_COMPONENT_SECRET"})}),(0,s.jsx)(n.td,{children:"XMPP component password for Jicofo"}),(0,s.jsx)(n.td,{children:"s3cr37"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_USER"})}),(0,s.jsx)(n.td,{children:"XMPP user for Jicofo client connections"}),(0,s.jsx)(n.td,{children:"focus"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_PASSWORD"})}),(0,s.jsx)(n.td,{children:"XMPP password for Jicofo client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_ENABLE_AUTH"})}),(0,s.jsx)(n.td,{children:"Enable authentication in Jicofo"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"ENABLE_AUTH"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_TYPE"})}),(0,s.jsx)(n.td,{children:"Select authentication type for Jicofo (internal, jwt or ldap)"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"AUTH_TYPE"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_AUTH_LIFETIME"})}),(0,s.jsx)(n.td,{children:"Select session timeout value for an authenticated user"}),(0,s.jsx)(n.td,{children:"24 hours"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JICOFO_ENABLE_HEALTH_CHECKS"})}),(0,s.jsx)(n.td,{children:"Enable health checks inside Jicofo, allowing the use of the REST api to check Jicofo's status"}),(0,s.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-jvb-options",children:"Advanced JVB options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_AUTH_USER"})}),(0,s.jsx)(n.td,{children:"XMPP user for JVB MUC client connections"}),(0,s.jsx)(n.td,{children:"jvb"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_AUTH_PASSWORD"})}),(0,s.jsx)(n.td,{children:"XMPP password for JVB MUC client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_STUN_SERVERS"})}),(0,s.jsx)(n.td,{children:"STUN servers used to discover the server's public IP"}),(0,s.jsx)(n.td,{children:"stun.l.google.com:19302, stun1.l.google.com:19302, stun2.l.google.com:19302"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_PORT"})}),(0,s.jsx)(n.td,{children:"UDP port for media used by Jitsi Videobridge"}),(0,s.jsx)(n.td,{children:"10000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_COLIBRI_PORT"})}),(0,s.jsx)(n.td,{children:"COLIBRI REST API port of JVB exposed to localhost"}),(0,s.jsx)(n.td,{children:"8080"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JVB_BREWERY_MUC"})}),(0,s.jsx)(n.td,{children:"MUC name for the JVB pool"}),(0,s.jsx)(n.td,{children:"jvbbrewery"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"COLIBRI_REST_ENABLED"})}),(0,s.jsx)(n.td,{children:"Enable the COLIBRI REST API"}),(0,s.jsx)(n.td,{children:"true"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"SHUTDOWN_REST_ENABLED"})}),(0,s.jsx)(n.td,{children:"Enable the shutdown REST API"}),(0,s.jsx)(n.td,{children:"true"})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"advanced-jigasi-options",children:"Advanced Jigasi options"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Variable"}),(0,s.jsx)(n.th,{children:"Description"}),(0,s.jsx)(n.th,{children:"Default value"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_ENABLE_SDES_SRTP"})}),(0,s.jsx)(n.td,{children:"Enable SDES srtp"}),(0,s.jsx)(n.td,{children:"0"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_SIP_KEEP_ALIVE_METHOD"})}),(0,s.jsx)(n.td,{children:"Keepalive method"}),(0,s.jsx)(n.td,{children:"OPTIONS"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_HEALTH_CHECK_SIP_URI"})}),(0,s.jsx)(n.td,{children:"Health-check extension"}),(0,s.jsx)(n.td,{})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_HEALTH_CHECK_INTERVAL"})}),(0,s.jsx)(n.td,{children:"Health-check interval"}),(0,s.jsx)(n.td,{children:"300000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_XMPP_USER"})}),(0,s.jsx)(n.td,{children:"XMPP user for Jigasi MUC client connections"}),(0,s.jsx)(n.td,{children:"jigasi"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_XMPP_PASSWORD"})}),(0,s.jsx)(n.td,{children:"XMPP password for Jigasi MUC client connections"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:""})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_BREWERY_MUC"})}),(0,s.jsx)(n.td,{children:"MUC name for the Jigasi pool"}),(0,s.jsx)(n.td,{children:"jigasibrewery"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_PORT_MIN"})}),(0,s.jsx)(n.td,{children:"Minimum port for media used by Jigasi"}),(0,s.jsx)(n.td,{children:"20000"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"JIGASI_PORT_MAX"})}),(0,s.jsx)(n.td,{children:"Maximum port for media used by Jigasi"}),(0,s.jsx)(n.td,{children:"20050"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"running-behind-nat-or-on-a-lan-environment",children:"Running behind NAT or on a LAN environment"}),"\n",(0,s.jsxs)(n.p,{children:["When running running in a LAN environment, or on the public Internet via NAT, the ",(0,s.jsx)(n.code,{children:"JVB_ADVERTISE_IPS"})," env variable should be set.\nThis variable allows to control which IP addresses the JVB will advertise for WebRTC media traffic. It is necessary to set it regardless of the use of a reverse proxy, since it's the IP address that will receive the media (audio / video) and not HTTP traffic, hence it's oblivious to the reverse proxy."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["This variable used to be called ",(0,s.jsx)(n.code,{children:"DOCKER_HOST_ADDRESS"})," but it got renamed for clarity and to support a list of IPs."]})}),"\n",(0,s.jsx)(n.p,{children:"If your users are coming in over the Internet (and not over LAN), this will likely be your public IP address. If this is not set up correctly, calls will crash when more than two users join a meeting."}),"\n",(0,s.jsxs)(n.p,{children:["The public IP address is attempted to be discovered via ",(0,s.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/STUN",children:"STUN"}),".\nSTUN servers can be specified with the ",(0,s.jsx)(n.code,{children:"JVB_STUN_SERVERS"})," option."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["Due to a bug in the docker version currently in the Debian repos (20.10.5), ",(0,s.jsx)(n.a,{href:"https://forums.docker.com/t/docker-doesnt-open-ipv6-ports/106201/2",children:"Docker does not listen on IPv6 ports"}),", so for that combination you will have to ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/engine/install/debian/",children:"manually obtain the latest version"}),"."]})}),"\n",(0,s.jsx)(n.h4,{id:"split-horizon",children:"Split horizon"}),"\n",(0,s.jsx)(n.p,{children:"If you are running in a split horizon environemt (LAN internal clients connect to a local IP and other clients connect to a public IP) you can specify\nmultiple advertised IPs by separating them with commas:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"JVB_ADVERTISE_IPS=192.168.1.1,1.2.3.4\n"})}),"\n",(0,s.jsx)(n.h4,{id:"offline--airgapped-installation",children:"Offline / airgapped installation"}),"\n",(0,s.jsx)(n.p,{children:"If your setup does not have access to the Internet you'll need to disable STUN on the JVB since discovering its own IP address will fail, but that is not necessary on that type of environment."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"JVB_DISABLE_STUN=true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"adjust-udp-buffers",children:"Adjust UDP buffers"}),"\n",(0,s.jsxs)(n.p,{children:["If you are experiencing issues with UDP traffic, like synchronization issues, skipping frames and similar, or if you expect a high traffic and big conferences, you might want to adjust the UDP buffer sizes.\nYou need to do that on the host system, that hosts the jvb container.\nTo do so you can get this ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-videobridge/blob/master/config/20-jvb-udp-buffers.conf",children:"sysctl config file"})," and save it in ",(0,s.jsx)(n.code,{children:"/etc/sysctl.d"})," and load it via: ",(0,s.jsx)(n.code,{children:"sysctl --system"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"accessing-server-logs",children:"Accessing server logs"}),"\n",(0,s.jsxs)(n.p,{children:["The default bahavior of ",(0,s.jsx)(n.code,{children:"docker-jitsi-meet"})," is to log to ",(0,s.jsx)(n.code,{children:"stdout"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["While the logs are sent to ",(0,s.jsx)(n.code,{children:"stdout"}),", they are not lost: unless configured to drop all logs, Docker keeps them available for future retrieval and processing."]}),"\n",(0,s.jsx)(n.p,{children:"If you need to access the container's logs you have multiple options. Here are the main ones:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["run ",(0,s.jsx)(n.code,{children:"docker compose logs -t -f "})," from command line, where ",(0,s.jsx)(n.code,{children:""})," is one of ",(0,s.jsx)(n.code,{children:"web"}),", ",(0,s.jsx)(n.code,{children:"prosody"}),",",(0,s.jsx)(n.code,{children:"jvb"}),", ",(0,s.jsx)(n.code,{children:"jicofo"}),". This command will output the logs for the selected service to stdout with timestamps."]}),"\n",(0,s.jsxs)(n.li,{children:["use a standard ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/config/containers/logging/configure/",children:"docker logging driver"})," to redirect the logs to the desired target (for instance ",(0,s.jsx)(n.code,{children:"syslog"})," or ",(0,s.jsx)(n.code,{children:"splunk"}),")."]}),"\n",(0,s.jsxs)(n.li,{children:["search ",(0,s.jsx)(n.a,{href:"https://hub.docker.com/search?q=",children:"docker hub"})," for a third party ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/config/containers/logging/plugins/",children:"docker logging driver plugin"})]}),"\n",(0,s.jsxs)(n.li,{children:["or ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/engine/extend/plugins_logging/",children:"write your own driver plugin"})," if you have a very specific need."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["For instance, if you want to have all logs related to a ",(0,s.jsx)(n.code,{children:""})," written to ",(0,s.jsx)(n.code,{children:"/var/log/jitsi/"})," as ",(0,s.jsx)(n.code,{children:"json"})," output, you could use ",(0,s.jsx)(n.a,{href:"https://github.com/deep-compute/docker-file-log-driver",children:"docker-file-log-driver"})," and configure it by adding the following block in your ",(0,s.jsx)(n.code,{children:"docker-compose.yml"})," file, at the same level as the ",(0,s.jsx)(n.code,{children:"image"})," block of the selected ",(0,s.jsx)(n.code,{children:""}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:'services:\n :\n image: ...\n ...\n logging:\n driver: file-log-driver\n options:\n fpath: "/jitsi/.log"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["If you want to only display the ",(0,s.jsx)(n.code,{children:"message"})," part of the log in ",(0,s.jsx)(n.code,{children:"json"})," format, simply execute the following command (for instance if ",(0,s.jsx)(n.code,{children:"fpath"})," was set to ",(0,s.jsx)(n.code,{children:"/jitsi/jvb.log"}),") which uses ",(0,s.jsx)(n.code,{children:"jq"})," to extract the relevant part of the logs:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"sudo cat /var/log/jitsi/jvb.log | jq -r '.msg' | jq -r '.message'\n"})}),"\n",(0,s.jsx)(n.h2,{id:"build-instructions",children:"Build Instructions"}),"\n",(0,s.jsx)(n.p,{children:"Building your images allows you to edit the configuration files of each image individually, providing more customization for your deployment."}),"\n",(0,s.jsxs)(n.p,{children:["The docker images can be built by running the ",(0,s.jsx)(n.code,{children:"make"})," command in the main repository folder. If you need to overwrite existing images from the remote source, use ",(0,s.jsx)(n.code,{children:"FORCE_REBUILD=1 make"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["If you are on the unstable branch, build the images with ",(0,s.jsx)(n.code,{children:"FORCE_REBUILD=1 JITSI_RELEASE=unstable make"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["You are now able to run ",(0,s.jsx)(n.code,{children:"docker compose up"})," as usual."]}),"\n",(0,s.jsx)(n.h2,{id:"running-behind-a-reverse-proxy",children:"Running behind a reverse proxy"}),"\n",(0,s.jsxs)(n.p,{children:["When running behing a reverse proxy from the same host, the communication between the proxy and Jitsi Meet is often in HTTP and not HTTPS since we generally don't have valid certificates for ",(0,s.jsx)(n.code,{children:"localhost"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"disable-https",children:"Disable HTTPS"}),"\n",(0,s.jsx)(n.p,{children:"HTTPS can be disabled in the Docker Compose configuration (since HTTPS will probably not work on localhost):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"DISABLE_HTTPS=1\nENABLE_HTTP_REDIRECT=0\nENABLE_LETS_ENCRYPT=0\n"})}),"\n",(0,s.jsx)(n.h3,{id:"do-not-expose-the-jitsi-meets-ports-publicly",children:"Do not expose the Jitsi Meet's ports publicly"}),"\n",(0,s.jsxs)(n.p,{children:["By default, the ",(0,s.jsx)(n.code,{children:"HTTP_PORT"})," and ",(0,s.jsx)(n.code,{children:"HTTPS_PORT"})," are binding to any ip address, so are publicly open unless a firewall blocks them. When using a reverse proxy, this is not necessary. This can be changed by updating the web container's ports configuration:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:" - '127.0.0.1:${HTTP_PORT}:80'\n - '127.0.0.1:${HTTPS_PORT}:443'\n"})}),"\n",(0,s.jsx)(n.p,{children:"instead of"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:" - '${HTTP_PORT}:80'\n - '${HTTPS_PORT}:443'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"reverse-proxy-configuration",children:"Reverse proxy configuration"}),"\n",(0,s.jsx)(n.p,{children:"By default this setup is using WebSocket connections for 2 core components:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Signalling (XMPP)"}),"\n",(0,s.jsx)(n.li,{children:"Bridge channel (colibri)"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Due to the hop-by-hop nature of WebSockets the reverse proxy must properly terminate and forward WebSocket connections. There 2 routes require such treatment:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"/xmpp-websocket"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"/colibri-ws"})}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The other HTTP requests must be handled by the web container."}),"\n",(0,s.jsxs)(n.p,{children:["In the following configuration examples, ",(0,s.jsx)(n.code,{children:"http://localhost:8000/"})," is the url of the web service's ingress (",(0,s.jsx)(n.code,{children:"8000"})," corresponds to ",(0,s.jsx)(n.code,{children:"HTTP_PORT"}),")."]}),"\n",(0,s.jsx)(n.h4,{id:"nginx",children:"nginx"}),"\n",(0,s.jsx)(n.p,{children:"With nginx, these routes can be forwarded using the following config snippet:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-nginx",children:'location /xmpp-websocket {\n proxy_pass http://localhost:8000/xmpp-websocket;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection "upgrade";\n}\n\nlocation /colibri-ws {\n proxy_pass http://localhost:8080/colibri-ws;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection "upgrade";\n}\n\nlocation / {\n proxy_pass http://localhost:8000/;\n proxy_http_version 1.1;\n}\n'})}),"\n",(0,s.jsx)(n.h4,{id:"apache",children:"Apache"}),"\n",(0,s.jsxs)(n.p,{children:["With Apache, ",(0,s.jsx)(n.code,{children:"mod_proxy"}),", ",(0,s.jsx)(n.code,{children:"mod_proxy_http"})," and ",(0,s.jsx)(n.code,{children:"mod_proxy_wstunnel"})," need to be enabled."]}),"\n",(0,s.jsx)(n.p,{children:"The reverse proxy can be configured using the following config snippet:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-apache",children:"\n \n ProxyTimeout 900\n ProxyPass /xmpp-websocket ws://localhost:8000/xmpp-websocket\n ProxyPass /colibri-ws/ ws://localhost:8000/colibri-ws/\n ProxyPass / http://localhost:8000/\n ProxyPassReverse / http://localhost:8000/\n \n\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disabling-websocket-connections",children:"Disabling WebSocket connections"}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"This is not the recommended setup."})}),"\n",(0,s.jsx)(n.p,{children:"If using WebSockets is not an option, these environment variables can be set to fallback to HTTP polling and WebRTC datachannels:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"ENABLE_SCTP=1\nENABLE_COLIBRI_WEBSOCKET=0\nENABLE_XMPP_WEBSOCKET=0\n"})})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},386:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/docker-jitsi-meet-afafdf87fea30a2fa6412baa4a3f8248.png"},8453:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(6540);const r={},d=s.createContext(r);function t(e){const n=s.useContext(d);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/31c6f806.12d7699f.js b/assets/js/31c6f806.aaeea83f.js similarity index 98% rename from assets/js/31c6f806.12d7699f.js rename to assets/js/31c6f806.aaeea83f.js index cb7469664..d1bd98571 100644 --- a/assets/js/31c6f806.12d7699f.js +++ b/assets/js/31c6f806.aaeea83f.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7508],{9063:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var s=t(4848),n=t(8453);const o={id:"devops-guide-bsd",title:"Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD",sidebar_label:"BSD"},r=void 0,d={id:"devops-guide/devops-guide-bsd",title:"Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD",description:"This document is a reference point for pointing to the upstream packages provided by the FreeBSD, NetBSD and OpenBSD distributions. Jitsi only officially supports Linux, for any problems with the BSD packages you can contact their respective mailing lists.",source:"@site/docs/devops-guide/bsd.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-bsd",permalink:"/handbook/docs/devops-guide/devops-guide-bsd",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/bsd.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"devops-guide-bsd",title:"Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD",sidebar_label:"BSD"}},a={},c=[{value:"FreeBSD",id:"freebsd",level:2},{value:"NetBSD",id:"netbsd",level:2},{value:"OpenBSD",id:"openbsd",level:2},{value:"Limitations",id:"limitations",level:2}];function l(e){const i={a:"a",code:"code",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.p,{children:"This document is a reference point for pointing to the upstream packages provided by the FreeBSD, NetBSD and OpenBSD distributions. Jitsi only officially supports Linux, for any problems with the BSD packages you can contact their respective mailing lists."}),"\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"Note"}),": Many of the installation steps require root access."]}),"\n",(0,s.jsx)(i.h2,{id:"freebsd",children:"FreeBSD"}),"\n",(0,s.jsxs)(i.p,{children:["FreeBSD provides ports for ",(0,s.jsx)(i.a,{href:"https://www.freshports.org/net-im/jitsi-meet-full",children:"Jitsi"})," along with documentation on how to configure it and the current limitations - ",(0,s.jsx)(i.a,{href:"https://wiki.freebsd.org/Jitsi",children:"https://wiki.freebsd.org/Jitsi"}),"."]}),"\n",(0,s.jsxs)(i.p,{children:["Jitsi can be installed using the meta port ",(0,s.jsx)(i.a,{href:"https://www.freshports.org/net-im/jitsi-meet-full",children:"net-im/jitsi-meet-full"})," which pulls in Jitsi Videobridge, Jicofo and Jitsi Meet Web UI, along with prosody, the Jitsi prosody plugins, nginx and other required dependencies. Instructions on how to build the port can be read on the FreeBSD Foundation site - ",(0,s.jsx)(i.a,{href:"https://freebsdfoundation.org/freebsd-project/resourcesold/installing-a-port-on-freebsd/",children:"https://freebsdfoundation.org/freebsd-project/resourcesold/installing-a-port-on-freebsd/"}),"."]}),"\n",(0,s.jsx)(i.h2,{id:"netbsd",children:"NetBSD"}),"\n",(0,s.jsxs)(i.p,{children:["NetBSD provides individual ports for ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/chat/jitsi-videobridge",children:"Jitsi Videobridge"}),", ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/chat/jicofo",children:"Jicofo"}),", ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/chat/jitsi-meet-prosody",children:"Jitsi prosody plugins"})," and ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/wip/jitsi-meet",children:"Jitsi Meet Web UI"}),". They can be installed using the command ",(0,s.jsx)(i.code,{children:"pkg_add "}),"."]}),"\n",(0,s.jsx)(i.h2,{id:"openbsd",children:"OpenBSD"}),"\n",(0,s.jsxs)(i.p,{children:["OpenBSD provides ports for ",(0,s.jsx)(i.a,{href:"https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/meta/jitsi/",children:"Jitsi"}),", along with a pkg-readme which details how to configure Jitsi for a single host install, located at ",(0,s.jsx)(i.a,{href:"https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/meta/jitsi/pkg/",children:"/usr/local/share/docs/pkg-readme/jitsi"}),"."]}),"\n",(0,s.jsxs)(i.p,{children:["The meta port can be installed by the command ",(0,s.jsx)(i.code,{children:"pkg_add jitsi"}),", which pulls in the individual ports, Jitsi Videobridge, Jicofo and Jitsi Meet Web UI, along with prosody, Jitsi prosody plugins and other required dependencies."]}),"\n",(0,s.jsx)(i.h2,{id:"limitations",children:"Limitations"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsx)(i.li,{children:"Jigasi and Jibri have not yet been ported to work with any BSD systems."}),"\n"]})]})}function p(e={}){const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,i,t)=>{t.d(i,{R:()=>r,x:()=>d});var s=t(6540);const n={},o=s.createContext(n);function r(e){const i=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),s.createElement(o.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7508],{9063:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var s=t(4848),n=t(8453);const o={id:"devops-guide-bsd",title:"Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD",sidebar_label:"BSD"},r=void 0,d={id:"devops-guide/devops-guide-bsd",title:"Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD",description:"This document is a reference point for pointing to the upstream packages provided by the FreeBSD, NetBSD and OpenBSD distributions. Jitsi only officially supports Linux, for any problems with the BSD packages you can contact their respective mailing lists.",source:"@site/docs/devops-guide/bsd.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-bsd",permalink:"/handbook/docs/devops-guide/devops-guide-bsd",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/bsd.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"devops-guide-bsd",title:"Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD",sidebar_label:"BSD"}},a={},c=[{value:"FreeBSD",id:"freebsd",level:2},{value:"NetBSD",id:"netbsd",level:2},{value:"OpenBSD",id:"openbsd",level:2},{value:"Limitations",id:"limitations",level:2}];function l(e){const i={a:"a",code:"code",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.p,{children:"This document is a reference point for pointing to the upstream packages provided by the FreeBSD, NetBSD and OpenBSD distributions. Jitsi only officially supports Linux, for any problems with the BSD packages you can contact their respective mailing lists."}),"\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"Note"}),": Many of the installation steps require root access."]}),"\n",(0,s.jsx)(i.h2,{id:"freebsd",children:"FreeBSD"}),"\n",(0,s.jsxs)(i.p,{children:["FreeBSD provides ports for ",(0,s.jsx)(i.a,{href:"https://www.freshports.org/net-im/jitsi-meet-full",children:"Jitsi"})," along with documentation on how to configure it and the current limitations - ",(0,s.jsx)(i.a,{href:"https://wiki.freebsd.org/Jitsi",children:"https://wiki.freebsd.org/Jitsi"}),"."]}),"\n",(0,s.jsxs)(i.p,{children:["Jitsi can be installed using the meta port ",(0,s.jsx)(i.a,{href:"https://www.freshports.org/net-im/jitsi-meet-full",children:"net-im/jitsi-meet-full"})," which pulls in Jitsi Videobridge, Jicofo and Jitsi Meet Web UI, along with prosody, the Jitsi prosody plugins, nginx and other required dependencies. Instructions on how to build the port can be read on the FreeBSD Foundation site - ",(0,s.jsx)(i.a,{href:"https://freebsdfoundation.org/freebsd-project/resourcesold/installing-a-port-on-freebsd/",children:"https://freebsdfoundation.org/freebsd-project/resourcesold/installing-a-port-on-freebsd/"}),"."]}),"\n",(0,s.jsx)(i.h2,{id:"netbsd",children:"NetBSD"}),"\n",(0,s.jsxs)(i.p,{children:["NetBSD provides individual ports for ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/chat/jitsi-videobridge",children:"Jitsi Videobridge"}),", ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/chat/jicofo",children:"Jicofo"}),", ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/chat/jitsi-meet-prosody",children:"Jitsi prosody plugins"})," and ",(0,s.jsx)(i.a,{href:"https://pkgsrc.se/wip/jitsi-meet",children:"Jitsi Meet Web UI"}),". They can be installed using the command ",(0,s.jsx)(i.code,{children:"pkg_add "}),"."]}),"\n",(0,s.jsx)(i.h2,{id:"openbsd",children:"OpenBSD"}),"\n",(0,s.jsxs)(i.p,{children:["OpenBSD provides ports for ",(0,s.jsx)(i.a,{href:"https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/meta/jitsi/",children:"Jitsi"}),", along with a pkg-readme which details how to configure Jitsi for a single host install, located at ",(0,s.jsx)(i.a,{href:"https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/meta/jitsi/pkg/",children:"/usr/local/share/docs/pkg-readme/jitsi"}),"."]}),"\n",(0,s.jsxs)(i.p,{children:["The meta port can be installed by the command ",(0,s.jsx)(i.code,{children:"pkg_add jitsi"}),", which pulls in the individual ports, Jitsi Videobridge, Jicofo and Jitsi Meet Web UI, along with prosody, Jitsi prosody plugins and other required dependencies."]}),"\n",(0,s.jsx)(i.h2,{id:"limitations",children:"Limitations"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsx)(i.li,{children:"Jigasi and Jibri have not yet been ported to work with any BSD systems."}),"\n"]})]})}function p(e={}){const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,i,t)=>{t.d(i,{R:()=>r,x:()=>d});var s=t(6540);const n={},o=s.createContext(n);function r(e){const i=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),s.createElement(o.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3280bb49.2304d427.js b/assets/js/3280bb49.9bf63a1c.js similarity index 99% rename from assets/js/3280bb49.2304d427.js rename to assets/js/3280bb49.9bf63a1c.js index cd280723b..6f42c7350 100644 --- a/assets/js/3280bb49.2304d427.js +++ b/assets/js/3280bb49.9bf63a1c.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7713],{4348:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var s=i(4848),o=i(8453);const r={id:"devops-guide-opensuse",title:"Self-Hosting Guide - openSUSE",sidebar_label:"openSUSE"},t=void 0,d={id:"devops-guide/devops-guide-opensuse",title:"Self-Hosting Guide - openSUSE",description:"This document describes the steps for a quick Jitsi-Meet installation, paired",source:"@site/docs/devops-guide/opensuse.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-opensuse",permalink:"/handbook/docs/devops-guide/devops-guide-opensuse",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/opensuse.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"devops-guide-opensuse",title:"Self-Hosting Guide - openSUSE",sidebar_label:"openSUSE"},sidebar:"docs",previous:{title:"Debian/Ubuntu server",permalink:"/handbook/docs/devops-guide/devops-guide-quickstart"},next:{title:"Docker",permalink:"/handbook/docs/devops-guide/devops-guide-docker"}},c={},l=[{value:"Installation",id:"installation",level:2},{value:"optional Add-Ons",id:"optional-add-ons",level:3},{value:"Configuration",id:"configuration",level:2},{value:"Prosody",id:"prosody",level:3},{value:"Nginx",id:"nginx",level:3},{value:"Jitsi-Meet",id:"jitsi-meet",level:3},{value:"Jitsi-Videobridge",id:"jitsi-videobridge",level:3},{value:"Jitsi-Jicofo",id:"jitsi-jicofo",level:3},{value:"Add-On: Jitsi-Jibri",id:"add-on-jitsi-jibri",level:2},{value:"Add-On: Jitsi-Jigasi",id:"add-on-jitsi-jigasi",level:2},{value:"Services",id:"services",level:2},{value:"Final notes",id:"final-notes",level:2}];function a(e){const n={a:"a",admonition:"admonition",br:"br",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"This document describes the steps for a quick Jitsi-Meet installation, paired\nwith a single Videobridge and a single Jicofo on openSUSE Leap 15.2."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note"}),": Many of the installation steps require root access."]}),"\n",(0,s.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["Add the OBS repository:",(0,s.jsx)(n.br,{}),"\n",(0,s.jsx)(n.strong,{children:"Note:"})," When Jitsi-Meet is merged into openSUSE Factory, this will be obsolete."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"zypper addrepo https://download.opensuse.org/repositories/home:/SchoolGuy:/jitsi/openSUSE_Leap_15.2/home:SchoolGuy:jitsi.repo\n"})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:"Refresh the repositories:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"zypper refresh\n"})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:"Install Jitsi-Meet and its dependencies:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"zypper install nginx prosody lua51-zlib jitsi-meet jitsi-videobridge jitsi-jicofo\n"})}),"\n",(0,s.jsx)(n.h3,{id:"optional-add-ons",children:"optional Add-Ons"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Install the Jibri Add-On: ",(0,s.jsx)(n.code,{children:"zypper install jitsi-jibri"})]}),"\n",(0,s.jsxs)(n.li,{children:["Install the Jigasi Add-On: ",(0,s.jsx)(n.code,{children:"zypper install jitsi-jigasi"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"configuration",children:"Configuration"}),"\n",(0,s.jsxs)(n.p,{children:["The following sections describe how to configure the different packages.",(0,s.jsx)(n.br,{}),"\n","Replace ",(0,s.jsx)(n.code,{children:""})," with your domain name and ",(0,s.jsx)(n.code,{children:"YOURSECRET3"})," with a strong password."]}),"\n",(0,s.jsx)(n.h3,{id:"prosody",children:"Prosody"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Open and adjust the Prosody configuration file under ",(0,s.jsx)(n.code,{children:"/etc/prosody/prosody.cfg.lua"}),":"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-lua",children:'---------- Server-wide settings ----------\nadmins = { "focus@auth." }\ncross_domain_bosh = true;\nmodules_enabled = {\n -- HTTP modules\n "bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"\n -- jitsi\n "smacks";\n "mam";\n "lastactivity";\n "offline";\n "pubsub";\n "adhoc";\n "websocket";\n "http_altconnect";\n "compression";\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Create a new configuration file named ",(0,s.jsx)(n.code,{children:".cfg.lua"})," in ",(0,s.jsx)(n.code,{children:"/etc/prosody/conf.avail/"}),"\nwith the following content:"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-lua",metastring:'title="/etc/prosody/conf.avail/meet.example.org.cfg.lua"',children:'plugin_paths = { "/usr/share/jitsi-meet/prosody-plugins/" }\n\n-- As per https://prosody.im/doc/setting_up_bosh#proxying_requests\nconsider_bosh_secure = true\n\n-- domain mapper options, must at least have domain base set to use the mapper\nmuc_mapper_domain_base = "";\n\nturncredentials_secret = "YOURSECRET3";\n\nturncredentials = {\n { type = "stun", host = "", port = "3478" },\n { type = "turn", host = "", port = "3478", transport = "udp" },\n -- { type = "turns", host = "", port = "443", transport = "tcp" }\n};\n\nVirtualHost ""\n authentication = "anonymous"\n ssl = {\n key = "/var/lib/prosody/.key";\n certificate = "/var/lib/prosody/.crt";\n }\n speakerstats_component = "speakerstats."\n conference_duration_component = "conferenceduration."\n modules_enabled = {\n "bosh";\n "pubsub";\n\t "speakerstats";\n\t "turncredentials";\n "conference_duration";\n }\n c2s_require_encryption = false\n\nComponent "conference." "muc"\n modules_enabled = {\n "muc_meeting_id";\n "muc_domain_mapper";\n }\n admins = { "focus@auth." }\n muc_room_locking = false\n muc_room_default_public_jids = true\n\n-- internal muc component\nComponent "internal.auth." "muc"\n modules_enabled = {\n "ping";\n }\n admins = { "focus@auth." }\n muc_room_locking = false\n muc_room_default_public_jids = true\n muc_room_cache_size = 1000\n\nComponent "jitsi-videobridge."\n component_secret = "YOURSECRET3"\n\nVirtualHost "auth."\n ssl = {\n key = "/var/lib/prosody/auth..key";\n certificate = "/var/lib/prosody/auth..crt";\n }\n authentication = "internal_plain"\n\nComponent "focus."\n component_secret = "YOURSECRET3"\n\nComponent "speakerstats." "speakerstats_component"\n muc_component = "conference."\n\nComponent "conferenceduration." "conference_duration_component"\n muc_component = "conference."\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create a symlink for the configuration:",(0,s.jsx)(n.br,{}),"\n",(0,s.jsx)(n.code,{children:"ln --symbolic /etc/prosody/conf.avail/.cfg.lua /etc/prosody/conf.d/.cfg.lua"})]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create the certificates via ",(0,s.jsx)(n.code,{children:"prosodyctl cert generate "}),".",(0,s.jsx)(n.br,{}),"\n","The value ",(0,s.jsx)(n.code,{children:""})," represents the following URLs."]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"auth."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"conference."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"conferenceduration."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"internal.auth."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"FQDN"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"focus."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"jitsi-videobridge."})}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"callcontrol."})," ",(0,s.jsx)(n.strong,{children:"Note:"})," This is only needed if you deploy Jigasi"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"recorder."})," ",(0,s.jsx)(n.strong,{children:"Note:"})," This is only needed if you deploy Jibri"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"/var/lib/prosody/"}),": Symlink all generated ",(0,s.jsx)(n.code,{children:"*.crt"})," and ",(0,s.jsx)(n.code,{children:"*.key"})," files to ",(0,s.jsx)(n.code,{children:"/etc/prosody/certs/"}),"."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"Please do not link other certificates."})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Add the certificates to the system keystore:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"ln --symbolic --force /var/lib/prosody/auth..crt /usr/local/share/ca-certificates/auth..crt"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"update-ca-certificates --fresh"})}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Create conference focus user: ",(0,s.jsx)(n.code,{children:"prosodyctl register focus auth. YOURSECRET3"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"nginx",children:"Nginx"}),"\n",(0,s.jsxs)(n.p,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"jitsi-meet.conf"})," in ",(0,s.jsx)(n.code,{children:"/etc/nginx/vhosts.d/"})," (which was installed\nalong with ",(0,s.jsx)(n.code,{children:"jitsi-meet"}),") and do the following:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Check the ",(0,s.jsx)(n.code,{children:"server_name"})," value."]}),"\n",(0,s.jsx)(n.li,{children:"Check the TLS certificates (Let's Encrypt for production use, Prosody for testing, for example)."}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," If you are using an existing server, please make sure to adjust the websocket and bosh part, too."]}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-meet",children:"Jitsi-Meet"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Go to ",(0,s.jsx)(n.code,{children:"/srv/jitsi-meet"})," and edit ",(0,s.jsx)(n.code,{children:"config.js"}),":"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",metastring:'title="/srv/jitsi-meet/config.js"',children:"var config = {\n hosts: {\n domain: '',\n muc: 'conference.',\n bridge: 'jitsi-videobridge.',\n focus: 'focus.'\n },\n useNicks: false,\n bosh: '///http-bind',\n};\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Please be aware that this is the minimal configuration."]}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-videobridge",children:"Jitsi-Videobridge"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," We use a combination of the ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-videobridge/blob/master/doc/muc.md#videobridge-configuration",children:"new Videobridge configuration"}),"\nand the legacy one with the ",(0,s.jsx)(n.code,{children:"sip-communicator.properties"})," file. We have\nto do this because of the ",(0,s.jsx)(n.code,{children:"STATISTICS_TRANSPORT"})," property."]}),"\n",(0,s.jsxs)(n.p,{children:["If we remove ",(0,s.jsx)(n.code,{children:"org.jitsi.videobridge.STATISTICS_TRANSPORT=muc,colibri"}),"\nfrom ",(0,s.jsx)(n.code,{children:"sip-communicator.properties"}),", the videobridge will not work!"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Go to the directory ",(0,s.jsx)(n.code,{children:"/etc/jitsi/videobridge"})]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"jitsi-videobridge.conf"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Set ",(0,s.jsx)(n.code,{children:"JVB_HOSTNAME"})," to your ",(0,s.jsx)(n.code,{children:""}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set ",(0,s.jsx)(n.code,{children:"JVB_SECRET"})," to your own secret."]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"application.conf"})," and adjust the values under ",(0,s.jsx)(n.code,{children:"apis"}),"\nand ",(0,s.jsx)(n.code,{children:"websockets"}),", especially set a unique ID as ",(0,s.jsx)(n.code,{children:"muc_nickname"}),"\nwith ",(0,s.jsx)(n.code,{children:"uuidgen"})," for example."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-HUCON",children:'apis {\n xmpp-client {\n configs {\n xmpp-server-1 {\n hostname="localhost"\n domain = "auth.${FQDN}"\n username = "focus"\n password = "YOURSECRET3"\n muc_jids = "JvbBrewery@internal.auth.${FQDN}"\n # The muc_nickname must be unique across all jitsi-videobridge instances\n muc_nickname = "unique-id"\n disable_certificate_verification = true\n }\n }\n }\n}\nwebsockets {\n enabled=true\n server-id="default-id"\n domain="${FQDN}"\n}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-jicofo",children:"Jitsi-Jicofo"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Go to the directory ",(0,s.jsx)(n.code,{children:"/etc/jitsi/jicofo"})]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"jitsi-jicofo.conf"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_HOSTNAME"})," to ",(0,s.jsx)(n.code,{children:""}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_SECRET"})," to the password the Prosody user got in above setup."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_AUTH_DOMAIN"})," to ",(0,s.jsx)(n.code,{children:"auth."}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_AUTH_USER"})," to the Prosody user from above setup."]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"sip-cmmunicator.properties"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"org.jitsi.jicofo.BRIDGE_MUC"})," to ",(0,s.jsx)(n.code,{children:"JvbBrewery@internal.auth."}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"org.jitsi.jicofo.jibri.BREWERY"})," to ",(0,s.jsx)(n.code,{children:"JibriBrewery@internal.auth."}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Depending on your cert setup set ",(0,s.jsx)(n.code,{children:"org.jitsi.jicofo.ALWAYS_TRUST_MODE_ENABLED"})," to ",(0,s.jsx)(n.code,{children:"true"})," or ",(0,s.jsx)(n.code,{children:"false"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"add-on-jitsi-jibri",children:"Add-On: Jitsi-Jibri"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Add to the file ",(0,s.jsx)(n.code,{children:"/etc/prosody/conf.avail/.cfg.lua"})," the following snippet at the end of the file."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-lua",children:'VirtualHost "recorder."\n modules_enabled = {\n "ping";\n }\n authentication = "internal_plain"\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Run ",(0,s.jsx)(n.code,{children:"prosodyctl register jibri auth. YOURSECRET3"})," and replace ",(0,s.jsx)(n.code,{children:"YOURSECRET3"})," with an appropiate one."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"prosodyctl register recorder recorder. YOURSECRET3"})," and replace ",(0,s.jsx)(n.code,{children:"YOURSECRET3"})," with an appropiate one."]}),"\n",(0,s.jsxs)(n.li,{children:["Go to the directory ",(0,s.jsx)(n.code,{children:"/etc/jitsi/jibri"})," and edit the following properties you see listed below. The rest can be left as is."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-HUCON",children:'jibri{\n api{\n environments = [\n {\n xmpp-domain = ""\n control-muc {\n domain = "internal."\n }\n control-login {\n domain = "recorder."\n username = "recorder"\n password = "YOURSECRET3"\n } \n call-login {\n domain = "recorder."\n username = "recorder"\n password = "YOURSECRET3"\n }\n }\n ]\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"/etc/jitsi/jicofo/sip-communicator.properties"})," and add the\nfollowing properties:"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-HUCON",children:"org.jitsi.jicofo.jibri.BREWERY=JibriBrewery@internal.auth.\norg.jitsi.jicofo.jibri.PENDING_TIMEOUT=90\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"/srv/jitsi-meet/config.js"})," and set the\nfollowing properties:"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"fileRecordingsEnabled: true, // If you want to enable file recording\nliveStreamingEnabled: true, // If you want to enable live streaming\nhiddenDomain: 'recorder.',\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Edit ",(0,s.jsx)(n.code,{children:"/srv/jitsi-meet/interface_config.js"})," and make sure the\n",(0,s.jsx)(n.code,{children:"TOOLBAR_BUTTONS"})," array contains the ",(0,s.jsx)(n.code,{children:"recording"})," and\nthe ",(0,s.jsx)(n.code,{children:"livestreaming"})," value if you want those features."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"TOOLBAR_BUTTONS: [\n 'microphone', 'camera', 'closedcaptions', 'desktop', 'embedmeeting', 'fullscreen',\n 'fodeviceselection', 'hangup', 'profile', 'chat', 'recording',\n 'livestreaming', 'etherpad', 'sharedvideo', 'settings', 'raisehand',\n 'videoquality', 'filmstrip', 'invite', 'feedback', 'stats', 'shortcuts',\n 'tileview', 'videobackgroundblur', 'download', 'help', 'mute-everyone', 'security'\n],\n"})}),"\n",(0,s.jsx)(n.h2,{id:"add-on-jitsi-jigasi",children:"Add-On: Jitsi-Jigasi"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note from openSUSE packagers:"})," We've packaged it but we don't have the infrastructure to set up this component. Hence we can't provide a guide for this so far."]}),"\n",(0,s.jsx)(n.h2,{id:"services",children:"Services"}),"\n",(0,s.jsx)(n.p,{children:"Now everything should be working. That means you are ready to start everything up:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start prosody"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start jitsi-videbridge"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start jitsi-jicofo"})}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"systemctl start jitsi-jibri"})," (if configured and installed beforehand)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"systemctl start jitsi-jigasi"})," (if configured and installed beforehand)"]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start nginx"})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"final-notes",children:"Final notes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"The Jitsi Software has a lot of dependencies and thus we recommend to run\nthis on a dedicated host for Jitsi."}),"\n",(0,s.jsx)(n.li,{children:"Updating Jitsi is crucial to get rid of bugs and updated dependencies with\npossible security fixes."}),"\n",(0,s.jsx)(n.li,{children:"Although tempted through Chrome: Don't install a full X11 stack like KDE or\nGnome for this."}),"\n",(0,s.jsxs)(n.li,{children:["Don't mix the ",(0,s.jsx)(n.code,{children:"rpms"})," or ",(0,s.jsx)(n.code,{children:"debs"})," with a source installation of the same component."]}),"\n",(0,s.jsx)(n.li,{children:"Securely backup your configuration, preferably in a VCS. This saves time and\npain when doing rollbacks or dealing with other problems."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>d});var s=i(6540);const o={},r=s.createContext(o);function t(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7713],{4348:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var s=i(4848),o=i(8453);const r={id:"devops-guide-opensuse",title:"Self-Hosting Guide - openSUSE",sidebar_label:"openSUSE"},t=void 0,d={id:"devops-guide/devops-guide-opensuse",title:"Self-Hosting Guide - openSUSE",description:"This document describes the steps for a quick Jitsi-Meet installation, paired",source:"@site/docs/devops-guide/opensuse.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-opensuse",permalink:"/handbook/docs/devops-guide/devops-guide-opensuse",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/opensuse.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"devops-guide-opensuse",title:"Self-Hosting Guide - openSUSE",sidebar_label:"openSUSE"},sidebar:"docs",previous:{title:"Debian/Ubuntu server",permalink:"/handbook/docs/devops-guide/devops-guide-quickstart"},next:{title:"Docker",permalink:"/handbook/docs/devops-guide/devops-guide-docker"}},c={},l=[{value:"Installation",id:"installation",level:2},{value:"optional Add-Ons",id:"optional-add-ons",level:3},{value:"Configuration",id:"configuration",level:2},{value:"Prosody",id:"prosody",level:3},{value:"Nginx",id:"nginx",level:3},{value:"Jitsi-Meet",id:"jitsi-meet",level:3},{value:"Jitsi-Videobridge",id:"jitsi-videobridge",level:3},{value:"Jitsi-Jicofo",id:"jitsi-jicofo",level:3},{value:"Add-On: Jitsi-Jibri",id:"add-on-jitsi-jibri",level:2},{value:"Add-On: Jitsi-Jigasi",id:"add-on-jitsi-jigasi",level:2},{value:"Services",id:"services",level:2},{value:"Final notes",id:"final-notes",level:2}];function a(e){const n={a:"a",admonition:"admonition",br:"br",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"This document describes the steps for a quick Jitsi-Meet installation, paired\nwith a single Videobridge and a single Jicofo on openSUSE Leap 15.2."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note"}),": Many of the installation steps require root access."]}),"\n",(0,s.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["Add the OBS repository:",(0,s.jsx)(n.br,{}),"\n",(0,s.jsx)(n.strong,{children:"Note:"})," When Jitsi-Meet is merged into openSUSE Factory, this will be obsolete."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"zypper addrepo https://download.opensuse.org/repositories/home:/SchoolGuy:/jitsi/openSUSE_Leap_15.2/home:SchoolGuy:jitsi.repo\n"})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:"Refresh the repositories:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"zypper refresh\n"})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:"Install Jitsi-Meet and its dependencies:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"zypper install nginx prosody lua51-zlib jitsi-meet jitsi-videobridge jitsi-jicofo\n"})}),"\n",(0,s.jsx)(n.h3,{id:"optional-add-ons",children:"optional Add-Ons"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Install the Jibri Add-On: ",(0,s.jsx)(n.code,{children:"zypper install jitsi-jibri"})]}),"\n",(0,s.jsxs)(n.li,{children:["Install the Jigasi Add-On: ",(0,s.jsx)(n.code,{children:"zypper install jitsi-jigasi"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"configuration",children:"Configuration"}),"\n",(0,s.jsxs)(n.p,{children:["The following sections describe how to configure the different packages.",(0,s.jsx)(n.br,{}),"\n","Replace ",(0,s.jsx)(n.code,{children:""})," with your domain name and ",(0,s.jsx)(n.code,{children:"YOURSECRET3"})," with a strong password."]}),"\n",(0,s.jsx)(n.h3,{id:"prosody",children:"Prosody"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Open and adjust the Prosody configuration file under ",(0,s.jsx)(n.code,{children:"/etc/prosody/prosody.cfg.lua"}),":"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-lua",children:'---------- Server-wide settings ----------\nadmins = { "focus@auth." }\ncross_domain_bosh = true;\nmodules_enabled = {\n -- HTTP modules\n "bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"\n -- jitsi\n "smacks";\n "mam";\n "lastactivity";\n "offline";\n "pubsub";\n "adhoc";\n "websocket";\n "http_altconnect";\n "compression";\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Create a new configuration file named ",(0,s.jsx)(n.code,{children:".cfg.lua"})," in ",(0,s.jsx)(n.code,{children:"/etc/prosody/conf.avail/"}),"\nwith the following content:"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-lua",metastring:'title="/etc/prosody/conf.avail/meet.example.org.cfg.lua"',children:'plugin_paths = { "/usr/share/jitsi-meet/prosody-plugins/" }\n\n-- As per https://prosody.im/doc/setting_up_bosh#proxying_requests\nconsider_bosh_secure = true\n\n-- domain mapper options, must at least have domain base set to use the mapper\nmuc_mapper_domain_base = "";\n\nturncredentials_secret = "YOURSECRET3";\n\nturncredentials = {\n { type = "stun", host = "", port = "3478" },\n { type = "turn", host = "", port = "3478", transport = "udp" },\n -- { type = "turns", host = "", port = "443", transport = "tcp" }\n};\n\nVirtualHost ""\n authentication = "anonymous"\n ssl = {\n key = "/var/lib/prosody/.key";\n certificate = "/var/lib/prosody/.crt";\n }\n speakerstats_component = "speakerstats."\n conference_duration_component = "conferenceduration."\n modules_enabled = {\n "bosh";\n "pubsub";\n\t "speakerstats";\n\t "turncredentials";\n "conference_duration";\n }\n c2s_require_encryption = false\n\nComponent "conference." "muc"\n modules_enabled = {\n "muc_meeting_id";\n "muc_domain_mapper";\n }\n admins = { "focus@auth." }\n muc_room_locking = false\n muc_room_default_public_jids = true\n\n-- internal muc component\nComponent "internal.auth." "muc"\n modules_enabled = {\n "ping";\n }\n admins = { "focus@auth." }\n muc_room_locking = false\n muc_room_default_public_jids = true\n muc_room_cache_size = 1000\n\nComponent "jitsi-videobridge."\n component_secret = "YOURSECRET3"\n\nVirtualHost "auth."\n ssl = {\n key = "/var/lib/prosody/auth..key";\n certificate = "/var/lib/prosody/auth..crt";\n }\n authentication = "internal_plain"\n\nComponent "focus."\n component_secret = "YOURSECRET3"\n\nComponent "speakerstats." "speakerstats_component"\n muc_component = "conference."\n\nComponent "conferenceduration." "conference_duration_component"\n muc_component = "conference."\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create a symlink for the configuration:",(0,s.jsx)(n.br,{}),"\n",(0,s.jsx)(n.code,{children:"ln --symbolic /etc/prosody/conf.avail/.cfg.lua /etc/prosody/conf.d/.cfg.lua"})]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Create the certificates via ",(0,s.jsx)(n.code,{children:"prosodyctl cert generate "}),".",(0,s.jsx)(n.br,{}),"\n","The value ",(0,s.jsx)(n.code,{children:""})," represents the following URLs."]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"auth."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"conference."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"conferenceduration."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"internal.auth."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"FQDN"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"focus."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"jitsi-videobridge."})}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"callcontrol."})," ",(0,s.jsx)(n.strong,{children:"Note:"})," This is only needed if you deploy Jigasi"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"recorder."})," ",(0,s.jsx)(n.strong,{children:"Note:"})," This is only needed if you deploy Jibri"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"/var/lib/prosody/"}),": Symlink all generated ",(0,s.jsx)(n.code,{children:"*.crt"})," and ",(0,s.jsx)(n.code,{children:"*.key"})," files to ",(0,s.jsx)(n.code,{children:"/etc/prosody/certs/"}),"."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"Please do not link other certificates."})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Add the certificates to the system keystore:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"ln --symbolic --force /var/lib/prosody/auth..crt /usr/local/share/ca-certificates/auth..crt"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"update-ca-certificates --fresh"})}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Create conference focus user: ",(0,s.jsx)(n.code,{children:"prosodyctl register focus auth. YOURSECRET3"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"nginx",children:"Nginx"}),"\n",(0,s.jsxs)(n.p,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"jitsi-meet.conf"})," in ",(0,s.jsx)(n.code,{children:"/etc/nginx/vhosts.d/"})," (which was installed\nalong with ",(0,s.jsx)(n.code,{children:"jitsi-meet"}),") and do the following:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Check the ",(0,s.jsx)(n.code,{children:"server_name"})," value."]}),"\n",(0,s.jsx)(n.li,{children:"Check the TLS certificates (Let's Encrypt for production use, Prosody for testing, for example)."}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," If you are using an existing server, please make sure to adjust the websocket and bosh part, too."]}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-meet",children:"Jitsi-Meet"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Go to ",(0,s.jsx)(n.code,{children:"/srv/jitsi-meet"})," and edit ",(0,s.jsx)(n.code,{children:"config.js"}),":"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",metastring:'title="/srv/jitsi-meet/config.js"',children:"var config = {\n hosts: {\n domain: '',\n muc: 'conference.',\n bridge: 'jitsi-videobridge.',\n focus: 'focus.'\n },\n useNicks: false,\n bosh: '///http-bind',\n};\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Please be aware that this is the minimal configuration."]}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-videobridge",children:"Jitsi-Videobridge"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," We use a combination of the ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-videobridge/blob/master/doc/muc.md#videobridge-configuration",children:"new Videobridge configuration"}),"\nand the legacy one with the ",(0,s.jsx)(n.code,{children:"sip-communicator.properties"})," file. We have\nto do this because of the ",(0,s.jsx)(n.code,{children:"STATISTICS_TRANSPORT"})," property."]}),"\n",(0,s.jsxs)(n.p,{children:["If we remove ",(0,s.jsx)(n.code,{children:"org.jitsi.videobridge.STATISTICS_TRANSPORT=muc,colibri"}),"\nfrom ",(0,s.jsx)(n.code,{children:"sip-communicator.properties"}),", the videobridge will not work!"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Go to the directory ",(0,s.jsx)(n.code,{children:"/etc/jitsi/videobridge"})]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"jitsi-videobridge.conf"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Set ",(0,s.jsx)(n.code,{children:"JVB_HOSTNAME"})," to your ",(0,s.jsx)(n.code,{children:""}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set ",(0,s.jsx)(n.code,{children:"JVB_SECRET"})," to your own secret."]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"application.conf"})," and adjust the values under ",(0,s.jsx)(n.code,{children:"apis"}),"\nand ",(0,s.jsx)(n.code,{children:"websockets"}),", especially set a unique ID as ",(0,s.jsx)(n.code,{children:"muc_nickname"}),"\nwith ",(0,s.jsx)(n.code,{children:"uuidgen"})," for example."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-HUCON",children:'apis {\n xmpp-client {\n configs {\n xmpp-server-1 {\n hostname="localhost"\n domain = "auth.${FQDN}"\n username = "focus"\n password = "YOURSECRET3"\n muc_jids = "JvbBrewery@internal.auth.${FQDN}"\n # The muc_nickname must be unique across all jitsi-videobridge instances\n muc_nickname = "unique-id"\n disable_certificate_verification = true\n }\n }\n }\n}\nwebsockets {\n enabled=true\n server-id="default-id"\n domain="${FQDN}"\n}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"jitsi-jicofo",children:"Jitsi-Jicofo"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Go to the directory ",(0,s.jsx)(n.code,{children:"/etc/jitsi/jicofo"})]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"jitsi-jicofo.conf"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_HOSTNAME"})," to ",(0,s.jsx)(n.code,{children:""}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_SECRET"})," to the password the Prosody user got in above setup."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_AUTH_DOMAIN"})," to ",(0,s.jsx)(n.code,{children:"auth."}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"JICOFO_AUTH_USER"})," to the Prosody user from above setup."]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"sip-cmmunicator.properties"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"org.jitsi.jicofo.BRIDGE_MUC"})," to ",(0,s.jsx)(n.code,{children:"JvbBrewery@internal.auth."}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Set the property ",(0,s.jsx)(n.code,{children:"org.jitsi.jicofo.jibri.BREWERY"})," to ",(0,s.jsx)(n.code,{children:"JibriBrewery@internal.auth."}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Depending on your cert setup set ",(0,s.jsx)(n.code,{children:"org.jitsi.jicofo.ALWAYS_TRUST_MODE_ENABLED"})," to ",(0,s.jsx)(n.code,{children:"true"})," or ",(0,s.jsx)(n.code,{children:"false"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"add-on-jitsi-jibri",children:"Add-On: Jitsi-Jibri"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Add to the file ",(0,s.jsx)(n.code,{children:"/etc/prosody/conf.avail/.cfg.lua"})," the following snippet at the end of the file."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-lua",children:'VirtualHost "recorder."\n modules_enabled = {\n "ping";\n }\n authentication = "internal_plain"\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Run ",(0,s.jsx)(n.code,{children:"prosodyctl register jibri auth. YOURSECRET3"})," and replace ",(0,s.jsx)(n.code,{children:"YOURSECRET3"})," with an appropiate one."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"prosodyctl register recorder recorder. YOURSECRET3"})," and replace ",(0,s.jsx)(n.code,{children:"YOURSECRET3"})," with an appropiate one."]}),"\n",(0,s.jsxs)(n.li,{children:["Go to the directory ",(0,s.jsx)(n.code,{children:"/etc/jitsi/jibri"})," and edit the following properties you see listed below. The rest can be left as is."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-HUCON",children:'jibri{\n api{\n environments = [\n {\n xmpp-domain = ""\n control-muc {\n domain = "internal."\n }\n control-login {\n domain = "recorder."\n username = "recorder"\n password = "YOURSECRET3"\n } \n call-login {\n domain = "recorder."\n username = "recorder"\n password = "YOURSECRET3"\n }\n }\n ]\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"/etc/jitsi/jicofo/sip-communicator.properties"})," and add the\nfollowing properties:"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-HUCON",children:"org.jitsi.jicofo.jibri.BREWERY=JibriBrewery@internal.auth.\norg.jitsi.jicofo.jibri.PENDING_TIMEOUT=90\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Edit the file ",(0,s.jsx)(n.code,{children:"/srv/jitsi-meet/config.js"})," and set the\nfollowing properties:"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"fileRecordingsEnabled: true, // If you want to enable file recording\nliveStreamingEnabled: true, // If you want to enable live streaming\nhiddenDomain: 'recorder.',\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Edit ",(0,s.jsx)(n.code,{children:"/srv/jitsi-meet/interface_config.js"})," and make sure the\n",(0,s.jsx)(n.code,{children:"TOOLBAR_BUTTONS"})," array contains the ",(0,s.jsx)(n.code,{children:"recording"})," and\nthe ",(0,s.jsx)(n.code,{children:"livestreaming"})," value if you want those features."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"TOOLBAR_BUTTONS: [\n 'microphone', 'camera', 'closedcaptions', 'desktop', 'embedmeeting', 'fullscreen',\n 'fodeviceselection', 'hangup', 'profile', 'chat', 'recording',\n 'livestreaming', 'etherpad', 'sharedvideo', 'settings', 'raisehand',\n 'videoquality', 'filmstrip', 'invite', 'feedback', 'stats', 'shortcuts',\n 'tileview', 'videobackgroundblur', 'download', 'help', 'mute-everyone', 'security'\n],\n"})}),"\n",(0,s.jsx)(n.h2,{id:"add-on-jitsi-jigasi",children:"Add-On: Jitsi-Jigasi"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note from openSUSE packagers:"})," We've packaged it but we don't have the infrastructure to set up this component. Hence we can't provide a guide for this so far."]}),"\n",(0,s.jsx)(n.h2,{id:"services",children:"Services"}),"\n",(0,s.jsx)(n.p,{children:"Now everything should be working. That means you are ready to start everything up:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start prosody"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start jitsi-videbridge"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start jitsi-jicofo"})}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"systemctl start jitsi-jibri"})," (if configured and installed beforehand)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"systemctl start jitsi-jigasi"})," (if configured and installed beforehand)"]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"systemctl start nginx"})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"final-notes",children:"Final notes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"The Jitsi Software has a lot of dependencies and thus we recommend to run\nthis on a dedicated host for Jitsi."}),"\n",(0,s.jsx)(n.li,{children:"Updating Jitsi is crucial to get rid of bugs and updated dependencies with\npossible security fixes."}),"\n",(0,s.jsx)(n.li,{children:"Although tempted through Chrome: Don't install a full X11 stack like KDE or\nGnome for this."}),"\n",(0,s.jsxs)(n.li,{children:["Don't mix the ",(0,s.jsx)(n.code,{children:"rpms"})," or ",(0,s.jsx)(n.code,{children:"debs"})," with a source installation of the same component."]}),"\n",(0,s.jsx)(n.li,{children:"Securely backup your configuration, preferably in a VCS. This saves time and\npain when doing rollbacks or dealing with other problems."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>d});var s=i(6540);const o={},r=s.createContext(o);function t(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/39715811.1d7fd578.js b/assets/js/39715811.01e35776.js similarity index 99% rename from assets/js/39715811.1d7fd578.js rename to assets/js/39715811.01e35776.js index 668a0fa1d..271cbc266 100644 --- a/assets/js/39715811.1d7fd578.js +++ b/assets/js/39715811.01e35776.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2750],{8838:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var t=n(4848),i=n(8453);const o={id:"ldap-authentication",title:"LDAP authentication",sidebar_label:"LDAP Authentication"},a=void 0,d={id:"devops-guide/ldap-authentication",title:"LDAP authentication",description:"This is a first draft and might not work on your system. It has been tested on Debian 11 installation with prosody 0.11 and authenticates against an OpenLDAP directory, and on Ubuntu 24.04 with Prosody 0.12 against an Active Directory.",source:"@site/docs/devops-guide/ldap-authentication.md",sourceDirName:"devops-guide",slug:"/devops-guide/ldap-authentication",permalink:"/handbook/docs/devops-guide/ldap-authentication",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/ldap-authentication.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"ldap-authentication",title:"LDAP authentication",sidebar_label:"LDAP Authentication"},sidebar:"docs",previous:{title:"Authentication (Secure Domain)",permalink:"/handbook/docs/devops-guide/secure-domain"},next:{title:"Scalable setup",permalink:"/handbook/docs/devops-guide/devops-guide-scalable"}},r={},c=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Required packages",id:"required-packages",level:3},{value:"Install and set up Cyrus SASL",id:"install-and-set-up-cyrus-sasl",level:2},{value:"Test LDAP authentication",id:"test-ldap-authentication",level:3},{value:"Enable the saslauthd service",id:"enable-the-saslauthd-service",level:3},{value:"Cyrus SASL Configuration file",id:"cyrus-sasl-configuration-file",level:3},{value:"Set up Prosody",id:"set-up-prosody",level:2},{value:"Set Permissions",id:"set-permissions",level:3}];function l(e){const s={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.admonition,{type:"note",children:(0,t.jsx)(s.p,{children:"This is a first draft and might not work on your system. It has been tested on Debian 11 installation with prosody 0.11 and authenticates against an OpenLDAP directory, and on Ubuntu 24.04 with Prosody 0.12 against an Active Directory."})}),"\n",(0,t.jsx)(s.p,{children:"If you want to authenticate your users against an LDAP directory instead\nof the local Prosody user database, you can use the Cyrus SASL package.\nUsing this package you might be able to validate user-supplied credentials\nagainst other sources, such as PAM, SQL and more - but this is beyond\nthis article."}),"\n",(0,t.jsx)(s.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsxs)(s.p,{children:["Before following this article, make sure you have set up Prosody as\ndescribed in ",(0,t.jsx)(s.a,{href:"/handbook/docs/devops-guide/secure-domain",children:"Authentication (Secure Domain)"})," first."]}),"\n",(0,t.jsx)(s.h3,{id:"required-packages",children:"Required packages"}),"\n",(0,t.jsx)(s.p,{children:"On Debian systems you need to install some required packages:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo apt-get install sasl2-bin libsasl2-modules-ldap lua-cyrussasl prosody-modules\nsudo prosodyctl install --server=https://modules.prosody.im/rocks/ mod_auth_cyrus\n"})}),"\n",(0,t.jsxs)(s.p,{children:["The first two packages are necessary for Cyrus' ",(0,t.jsx)(s.code,{children:"saslauthd"})," and allow it\nto connect to an LDAP directory. The ",(0,t.jsx)(s.code,{children:"lua-cyrussasl"}),"-package allows\nProsody to access Cyrus SASL."]}),"\n",(0,t.jsxs)(s.p,{children:["Installing the ",(0,t.jsx)(s.a,{href:"https://modules.prosody.im/mod_auth_cyrus",children:"mod_auth_cyrus"})," module is neccessary because support for Cyrus SASL has been ",(0,t.jsx)(s.a,{href:"https://prosody.im/doc/cyrus_sasl",children:"removed"})," from mainline Prosody and placed in the community module repository."]}),"\n",(0,t.jsx)(s.h2,{id:"install-and-set-up-cyrus-sasl",children:"Install and set up Cyrus SASL"}),"\n",(0,t.jsxs)(s.p,{children:["The following options define a basic LDAP configuration. A full set of\npossible options can be found in ",(0,t.jsx)(s.a,{href:"https://github.com/winlibs/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD",children:"LDAP_SASLAUTHD"}),"."]}),"\n",(0,t.jsxs)(s.p,{children:["By default Cyrus' ",(0,t.jsx)(s.code,{children:"saslauthd"})," searches for its LDAP configuration in\n",(0,t.jsx)(s.code,{children:"/etc/saslauthd.conf"}),". So create this file and enter something similar\nto define your LDAP environment:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"ldap_servers: ldaps://ldap.example.com\nldap_bind_dn: admin@example.com\nldap_bind_pw: topsecret\nldap_auth_method: bind\nldap_search_base: ou=people,dc=example,dc=com\n"})}),"\n",(0,t.jsxs)(s.admonition,{type:"note",children:[(0,t.jsxs)(s.p,{children:["One omitted option you might want to look into is ",(0,t.jsx)(s.code,{children:"ldap_filter"})," which defaults to ",(0,t.jsx)(s.code,{children:"uid=%u"})," and should work for a lot of systems. If you are using a Samba or Microsoft AD instance as your LDAP server you may need to change this to ",(0,t.jsx)(s.code,{children:"ldap_filter: (sAMAccountName=%U)"})," as ",(0,t.jsx)(s.code,{children:"uid"})," is NULL by default many configurations. You can also use the ",(0,t.jsx)(s.code,{children:"ldap_filter"})," to allow only specific users access. For more details on this and other options see the ",(0,t.jsx)(s.code,{children:"LDAP_SASLAUTHD"})," document linked above."]}),(0,t.jsxs)(s.p,{children:['Please note that Prosody may experience issues with usernames containing the "@"-symbol. You can work around this issue by changing ',(0,t.jsx)(s.code,{children:"uid=%u"})," to ",(0,t.jsx)(s.code,{children:"uid=%U"}),", which is ",(0,t.jsx)(s.a,{href:"https://github.com/winlibs/cyrus-sasl/blob/d933c030ce12ec0668469d79ab8378e347a1b3ba/saslauthd/LDAP_SASLAUTHD#L126",children:"defined"}),' as the "user portion of %u (%U = test when %u = ',(0,t.jsx)(s.a,{href:"mailto:test@domain.tld",children:"test@domain.tld"}),')"']})]}),"\n",(0,t.jsx)(s.h3,{id:"test-ldap-authentication",children:"Test LDAP authentication"}),"\n",(0,t.jsxs)(s.p,{children:["To test if the LDAP configuration is working, you can start ",(0,t.jsx)(s.code,{children:"saslauthd"})," in\ndebug mode while specifying the mandatory LDAP authentication mechanism:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo saslauthd -d -a ldap\n"})}),"\n",(0,t.jsxs)(s.p,{children:["The test utility for the SASL authentication server can then be used in a\nsecondary terminal. Replace ",(0,t.jsx)(s.code,{children:"user"})," and ",(0,t.jsx)(s.code,{children:"password"})," with credentials stored\nin LDAP."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'sudo testsaslauthd -u user -p password\n0: OK "Success."\n\nsudo testsaslauthd -u user -p wrongpassword\n0: NO "authentication failed"\n'})}),"\n",(0,t.jsxs)(s.p,{children:["After testing, you can stop ",(0,t.jsx)(s.code,{children:"saslauthd"})," using ",(0,t.jsx)(s.code,{children:"ctrl-c"}),"."]}),"\n",(0,t.jsxs)(s.h3,{id:"enable-the-saslauthd-service",children:["Enable the ",(0,t.jsx)(s.code,{children:"saslauthd"})," service"]}),"\n",(0,t.jsxs)(s.p,{children:["You will need to edit the ",(0,t.jsx)(s.code,{children:"/etc/default/saslauthd"})," to enable the ",(0,t.jsx)(s.code,{children:"saslauthd"})," service to run at boot and have it use LDAP for authentication. You can use sed to do this quickly."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'sudo sed -i -e "s/START=.*/START=yes/" -e "s/MECHANISMS=.*/MECHANISMS=\\"ldap\\"/" /etc/default/saslauthd\n'})}),"\n",(0,t.jsxs)(s.p,{children:["This will make the following changes to ",(0,t.jsx)(s.code,{children:"/etc/default/saslauthd"}),"."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'[...]\n# Should saslauthd run automatically on startup? (default: no)\nSTART=yes\n[...]\n# Example: MECHANISMS="pam"\nMECHANISMS="ldap"\n[...]\n'})}),"\n",(0,t.jsxs)(s.p,{children:["It is not necessary to point ",(0,t.jsx)(s.code,{children:"MECH_OPTIONS"})," to the LDAP configuration file\nsince this is the default for this mechanism."]}),"\n",(0,t.jsxs)(s.p,{children:["Now you can start, restart and stop ",(0,t.jsx)(s.code,{children:"saslauthd"})," using the ",(0,t.jsx)(s.code,{children:"service"})," scripts:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo service saslauthd restart\n"})}),"\n",(0,t.jsxs)(s.p,{children:["If you experience issues, check ",(0,t.jsx)(s.code,{children:"/var/log/auth.log"})," for ",(0,t.jsx)(s.code,{children:"saslauthd"})," entries."]}),"\n",(0,t.jsx)(s.h3,{id:"cyrus-sasl-configuration-file",children:"Cyrus SASL Configuration file"}),"\n",(0,t.jsxs)(s.p,{children:["Cyrus SASL requires a configuration file in order to know how to check user\ncredentials. For Prosody, the file is named ",(0,t.jsx)(s.code,{children:"prosody.conf"})," by default.\nIts location varies by OS and distribution as shown in the following table:"]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Platform"}),(0,t.jsx)(s.th,{children:"Location"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Debian and Ubuntu"}),(0,t.jsx)(s.td,{children:"/etc/sasl"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Arch, RHEL/CentOS"}),(0,t.jsx)(s.td,{children:"/etc/sasl2"})]})]})]}),"\n",(0,t.jsxs)(s.p,{children:["So for Debian systems, create the file ",(0,t.jsx)(s.code,{children:"/etc/sasl/prosody.conf"}),".\nThe directory ",(0,t.jsx)(s.code,{children:"/etc/sasl"})," might not yet exist."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo mkdir /etc/sasl/\n\ncat << 'EOF' |sudo tee /etc/sasl/prosody.conf > /dev/null\npwcheck_method: saslauthd\nmech_list: PLAIN\nEOF\n"})}),"\n",(0,t.jsx)(s.admonition,{type:"note",children:(0,t.jsxs)(s.p,{children:["The filename ",(0,t.jsx)(s.code,{children:"prosody.conf"})," corresponds to a value for ",(0,t.jsx)(s.code,{children:"cyrus_application_name"}),"\nin the Prosody config. Since we have not changed the default this has a value of ",(0,t.jsx)(s.code,{children:"prosody"}),"."]})}),"\n",(0,t.jsxs)(s.p,{children:["The Prosody documentation has more details on a\n",(0,t.jsx)(s.a,{href:"https://prosody.im/doc/cyrus_sasl",children:"Cyrus SASL-related setup"}),"."]}),"\n",(0,t.jsx)(s.h2,{id:"set-up-prosody",children:"Set up Prosody"}),"\n",(0,t.jsxs)(s.p,{children:["If you have tested the LDAP authentication successfully and enabled the ",(0,t.jsx)(s.code,{children:"saslauthd"})," service, you can change Prosody's authentication to the Cyrus backend by changing the ",(0,t.jsx)(s.code,{children:"authentication"})," setting in ",(0,t.jsx)(s.code,{children:"/etc/prosody/conf.avail/$(hostname -f).cfg.lua"})," via the command:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'sed -i -E -e "/^ *VirtualHost \\"$(hostname -f)\\"/,/^ *VirtualHost/ {s/authentication ?=.*$/authentication = \\"cyrus\\"/}" /etc/prosody/conf.avail/$(hostname -f).cfg.lua\n'})}),"\n",(0,t.jsxs)(s.p,{children:["You might also have to add the ",(0,t.jsx)(s.code,{children:"allow_unencrypted_plain_auth"})," option to allow\nplain-text passwords to be sent over the network. ",(0,t.jsx)(s.em,{children:"This is not recommended"})," as it\nmakes the setup less secure. So please try without this line first and only add\nit if you have problems authenticating."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:' authentication = "cyrus"\n allow_unencrypted_plain_auth = true\n'})}),"\n",(0,t.jsx)(s.h3,{id:"set-permissions",children:"Set Permissions"}),"\n",(0,t.jsxs)(s.p,{children:["Prosody will now try to access the saslauthd socket in\n",(0,t.jsx)(s.code,{children:"/var/run/saslauthd/"})," to communicate with the authentication daemon.\nThis folder only allows access to user ",(0,t.jsx)(s.code,{children:"root"})," and group ",(0,t.jsx)(s.code,{children:"sasl"})," while prosody\nruns as the system user/group ",(0,t.jsx)(s.code,{children:"prosody"}),"."]}),"\n",(0,t.jsxs)(s.p,{children:["The easiest solution is to add the ",(0,t.jsx)(s.code,{children:"sasl"})," group to the ",(0,t.jsx)(s.code,{children:"prosody"})," user and\nrestart the service."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo adduser prosody sasl\nsudo service prosody restart\n"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>d});var t=n(6540);const i={},o=t.createContext(i);function a(e){const s=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2750],{8838:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var t=n(4848),i=n(8453);const o={id:"ldap-authentication",title:"LDAP authentication",sidebar_label:"LDAP Authentication"},a=void 0,d={id:"devops-guide/ldap-authentication",title:"LDAP authentication",description:"This is a first draft and might not work on your system. It has been tested on Debian 11 installation with prosody 0.11 and authenticates against an OpenLDAP directory, and on Ubuntu 24.04 with Prosody 0.12 against an Active Directory.",source:"@site/docs/devops-guide/ldap-authentication.md",sourceDirName:"devops-guide",slug:"/devops-guide/ldap-authentication",permalink:"/handbook/docs/devops-guide/ldap-authentication",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/ldap-authentication.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"ldap-authentication",title:"LDAP authentication",sidebar_label:"LDAP Authentication"},sidebar:"docs",previous:{title:"Authentication (Secure Domain)",permalink:"/handbook/docs/devops-guide/secure-domain"},next:{title:"Scalable setup",permalink:"/handbook/docs/devops-guide/devops-guide-scalable"}},r={},c=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Required packages",id:"required-packages",level:3},{value:"Install and set up Cyrus SASL",id:"install-and-set-up-cyrus-sasl",level:2},{value:"Test LDAP authentication",id:"test-ldap-authentication",level:3},{value:"Enable the saslauthd service",id:"enable-the-saslauthd-service",level:3},{value:"Cyrus SASL Configuration file",id:"cyrus-sasl-configuration-file",level:3},{value:"Set up Prosody",id:"set-up-prosody",level:2},{value:"Set Permissions",id:"set-permissions",level:3}];function l(e){const s={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.admonition,{type:"note",children:(0,t.jsx)(s.p,{children:"This is a first draft and might not work on your system. It has been tested on Debian 11 installation with prosody 0.11 and authenticates against an OpenLDAP directory, and on Ubuntu 24.04 with Prosody 0.12 against an Active Directory."})}),"\n",(0,t.jsx)(s.p,{children:"If you want to authenticate your users against an LDAP directory instead\nof the local Prosody user database, you can use the Cyrus SASL package.\nUsing this package you might be able to validate user-supplied credentials\nagainst other sources, such as PAM, SQL and more - but this is beyond\nthis article."}),"\n",(0,t.jsx)(s.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsxs)(s.p,{children:["Before following this article, make sure you have set up Prosody as\ndescribed in ",(0,t.jsx)(s.a,{href:"/handbook/docs/devops-guide/secure-domain",children:"Authentication (Secure Domain)"})," first."]}),"\n",(0,t.jsx)(s.h3,{id:"required-packages",children:"Required packages"}),"\n",(0,t.jsx)(s.p,{children:"On Debian systems you need to install some required packages:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo apt-get install sasl2-bin libsasl2-modules-ldap lua-cyrussasl prosody-modules\nsudo prosodyctl install --server=https://modules.prosody.im/rocks/ mod_auth_cyrus\n"})}),"\n",(0,t.jsxs)(s.p,{children:["The first two packages are necessary for Cyrus' ",(0,t.jsx)(s.code,{children:"saslauthd"})," and allow it\nto connect to an LDAP directory. The ",(0,t.jsx)(s.code,{children:"lua-cyrussasl"}),"-package allows\nProsody to access Cyrus SASL."]}),"\n",(0,t.jsxs)(s.p,{children:["Installing the ",(0,t.jsx)(s.a,{href:"https://modules.prosody.im/mod_auth_cyrus",children:"mod_auth_cyrus"})," module is neccessary because support for Cyrus SASL has been ",(0,t.jsx)(s.a,{href:"https://prosody.im/doc/cyrus_sasl",children:"removed"})," from mainline Prosody and placed in the community module repository."]}),"\n",(0,t.jsx)(s.h2,{id:"install-and-set-up-cyrus-sasl",children:"Install and set up Cyrus SASL"}),"\n",(0,t.jsxs)(s.p,{children:["The following options define a basic LDAP configuration. A full set of\npossible options can be found in ",(0,t.jsx)(s.a,{href:"https://github.com/winlibs/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD",children:"LDAP_SASLAUTHD"}),"."]}),"\n",(0,t.jsxs)(s.p,{children:["By default Cyrus' ",(0,t.jsx)(s.code,{children:"saslauthd"})," searches for its LDAP configuration in\n",(0,t.jsx)(s.code,{children:"/etc/saslauthd.conf"}),". So create this file and enter something similar\nto define your LDAP environment:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"ldap_servers: ldaps://ldap.example.com\nldap_bind_dn: admin@example.com\nldap_bind_pw: topsecret\nldap_auth_method: bind\nldap_search_base: ou=people,dc=example,dc=com\n"})}),"\n",(0,t.jsxs)(s.admonition,{type:"note",children:[(0,t.jsxs)(s.p,{children:["One omitted option you might want to look into is ",(0,t.jsx)(s.code,{children:"ldap_filter"})," which defaults to ",(0,t.jsx)(s.code,{children:"uid=%u"})," and should work for a lot of systems. If you are using a Samba or Microsoft AD instance as your LDAP server you may need to change this to ",(0,t.jsx)(s.code,{children:"ldap_filter: (sAMAccountName=%U)"})," as ",(0,t.jsx)(s.code,{children:"uid"})," is NULL by default many configurations. You can also use the ",(0,t.jsx)(s.code,{children:"ldap_filter"})," to allow only specific users access. For more details on this and other options see the ",(0,t.jsx)(s.code,{children:"LDAP_SASLAUTHD"})," document linked above."]}),(0,t.jsxs)(s.p,{children:['Please note that Prosody may experience issues with usernames containing the "@"-symbol. You can work around this issue by changing ',(0,t.jsx)(s.code,{children:"uid=%u"})," to ",(0,t.jsx)(s.code,{children:"uid=%U"}),", which is ",(0,t.jsx)(s.a,{href:"https://github.com/winlibs/cyrus-sasl/blob/d933c030ce12ec0668469d79ab8378e347a1b3ba/saslauthd/LDAP_SASLAUTHD#L126",children:"defined"}),' as the "user portion of %u (%U = test when %u = ',(0,t.jsx)(s.a,{href:"mailto:test@domain.tld",children:"test@domain.tld"}),')"']})]}),"\n",(0,t.jsx)(s.h3,{id:"test-ldap-authentication",children:"Test LDAP authentication"}),"\n",(0,t.jsxs)(s.p,{children:["To test if the LDAP configuration is working, you can start ",(0,t.jsx)(s.code,{children:"saslauthd"})," in\ndebug mode while specifying the mandatory LDAP authentication mechanism:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo saslauthd -d -a ldap\n"})}),"\n",(0,t.jsxs)(s.p,{children:["The test utility for the SASL authentication server can then be used in a\nsecondary terminal. Replace ",(0,t.jsx)(s.code,{children:"user"})," and ",(0,t.jsx)(s.code,{children:"password"})," with credentials stored\nin LDAP."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'sudo testsaslauthd -u user -p password\n0: OK "Success."\n\nsudo testsaslauthd -u user -p wrongpassword\n0: NO "authentication failed"\n'})}),"\n",(0,t.jsxs)(s.p,{children:["After testing, you can stop ",(0,t.jsx)(s.code,{children:"saslauthd"})," using ",(0,t.jsx)(s.code,{children:"ctrl-c"}),"."]}),"\n",(0,t.jsxs)(s.h3,{id:"enable-the-saslauthd-service",children:["Enable the ",(0,t.jsx)(s.code,{children:"saslauthd"})," service"]}),"\n",(0,t.jsxs)(s.p,{children:["You will need to edit the ",(0,t.jsx)(s.code,{children:"/etc/default/saslauthd"})," to enable the ",(0,t.jsx)(s.code,{children:"saslauthd"})," service to run at boot and have it use LDAP for authentication. You can use sed to do this quickly."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'sudo sed -i -e "s/START=.*/START=yes/" -e "s/MECHANISMS=.*/MECHANISMS=\\"ldap\\"/" /etc/default/saslauthd\n'})}),"\n",(0,t.jsxs)(s.p,{children:["This will make the following changes to ",(0,t.jsx)(s.code,{children:"/etc/default/saslauthd"}),"."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'[...]\n# Should saslauthd run automatically on startup? (default: no)\nSTART=yes\n[...]\n# Example: MECHANISMS="pam"\nMECHANISMS="ldap"\n[...]\n'})}),"\n",(0,t.jsxs)(s.p,{children:["It is not necessary to point ",(0,t.jsx)(s.code,{children:"MECH_OPTIONS"})," to the LDAP configuration file\nsince this is the default for this mechanism."]}),"\n",(0,t.jsxs)(s.p,{children:["Now you can start, restart and stop ",(0,t.jsx)(s.code,{children:"saslauthd"})," using the ",(0,t.jsx)(s.code,{children:"service"})," scripts:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo service saslauthd restart\n"})}),"\n",(0,t.jsxs)(s.p,{children:["If you experience issues, check ",(0,t.jsx)(s.code,{children:"/var/log/auth.log"})," for ",(0,t.jsx)(s.code,{children:"saslauthd"})," entries."]}),"\n",(0,t.jsx)(s.h3,{id:"cyrus-sasl-configuration-file",children:"Cyrus SASL Configuration file"}),"\n",(0,t.jsxs)(s.p,{children:["Cyrus SASL requires a configuration file in order to know how to check user\ncredentials. For Prosody, the file is named ",(0,t.jsx)(s.code,{children:"prosody.conf"})," by default.\nIts location varies by OS and distribution as shown in the following table:"]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Platform"}),(0,t.jsx)(s.th,{children:"Location"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Debian and Ubuntu"}),(0,t.jsx)(s.td,{children:"/etc/sasl"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Arch, RHEL/CentOS"}),(0,t.jsx)(s.td,{children:"/etc/sasl2"})]})]})]}),"\n",(0,t.jsxs)(s.p,{children:["So for Debian systems, create the file ",(0,t.jsx)(s.code,{children:"/etc/sasl/prosody.conf"}),".\nThe directory ",(0,t.jsx)(s.code,{children:"/etc/sasl"})," might not yet exist."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo mkdir /etc/sasl/\n\ncat << 'EOF' |sudo tee /etc/sasl/prosody.conf > /dev/null\npwcheck_method: saslauthd\nmech_list: PLAIN\nEOF\n"})}),"\n",(0,t.jsx)(s.admonition,{type:"note",children:(0,t.jsxs)(s.p,{children:["The filename ",(0,t.jsx)(s.code,{children:"prosody.conf"})," corresponds to a value for ",(0,t.jsx)(s.code,{children:"cyrus_application_name"}),"\nin the Prosody config. Since we have not changed the default this has a value of ",(0,t.jsx)(s.code,{children:"prosody"}),"."]})}),"\n",(0,t.jsxs)(s.p,{children:["The Prosody documentation has more details on a\n",(0,t.jsx)(s.a,{href:"https://prosody.im/doc/cyrus_sasl",children:"Cyrus SASL-related setup"}),"."]}),"\n",(0,t.jsx)(s.h2,{id:"set-up-prosody",children:"Set up Prosody"}),"\n",(0,t.jsxs)(s.p,{children:["If you have tested the LDAP authentication successfully and enabled the ",(0,t.jsx)(s.code,{children:"saslauthd"})," service, you can change Prosody's authentication to the Cyrus backend by changing the ",(0,t.jsx)(s.code,{children:"authentication"})," setting in ",(0,t.jsx)(s.code,{children:"/etc/prosody/conf.avail/$(hostname -f).cfg.lua"})," via the command:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:'sed -i -E -e "/^ *VirtualHost \\"$(hostname -f)\\"/,/^ *VirtualHost/ {s/authentication ?=.*$/authentication = \\"cyrus\\"/}" /etc/prosody/conf.avail/$(hostname -f).cfg.lua\n'})}),"\n",(0,t.jsxs)(s.p,{children:["You might also have to add the ",(0,t.jsx)(s.code,{children:"allow_unencrypted_plain_auth"})," option to allow\nplain-text passwords to be sent over the network. ",(0,t.jsx)(s.em,{children:"This is not recommended"})," as it\nmakes the setup less secure. So please try without this line first and only add\nit if you have problems authenticating."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:' authentication = "cyrus"\n allow_unencrypted_plain_auth = true\n'})}),"\n",(0,t.jsx)(s.h3,{id:"set-permissions",children:"Set Permissions"}),"\n",(0,t.jsxs)(s.p,{children:["Prosody will now try to access the saslauthd socket in\n",(0,t.jsx)(s.code,{children:"/var/run/saslauthd/"})," to communicate with the authentication daemon.\nThis folder only allows access to user ",(0,t.jsx)(s.code,{children:"root"})," and group ",(0,t.jsx)(s.code,{children:"sasl"})," while prosody\nruns as the system user/group ",(0,t.jsx)(s.code,{children:"prosody"}),"."]}),"\n",(0,t.jsxs)(s.p,{children:["The easiest solution is to add the ",(0,t.jsx)(s.code,{children:"sasl"})," group to the ",(0,t.jsx)(s.code,{children:"prosody"})," user and\nrestart the service."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"sudo adduser prosody sasl\nsudo service prosody restart\n"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>d});var t=n(6540);const i={},o=t.createContext(i);function a(e){const s=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3dddb2f7.ca3680b7.js b/assets/js/3dddb2f7.b368f608.js similarity index 99% rename from assets/js/3dddb2f7.ca3680b7.js rename to assets/js/3dddb2f7.b368f608.js index f27474017..a300129c0 100644 --- a/assets/js/3dddb2f7.ca3680b7.js +++ b/assets/js/3dddb2f7.b368f608.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[1647],{4152:(e,d,i)=>{i.r(d),i.d(d,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var n=i(4848),t=i(8453);const s={id:"user-guide-advanced",title:"User Guide (advanced)",sidebar_label:"Advanced options"},r=void 0,c={id:"user-guide/user-guide-advanced",title:"User Guide (advanced)",description:"There are some options to tweak the invitation link to unlock more features in",source:"@site/docs/user-guide/advanced.md",sourceDirName:"user-guide",slug:"/user-guide/user-guide-advanced",permalink:"/handbook/docs/user-guide/user-guide-advanced",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/advanced.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"user-guide-advanced",title:"User Guide (advanced)",sidebar_label:"Advanced options"},sidebar:"docs",previous:{title:"Basic options",permalink:"/handbook/docs/user-guide/user-guide-basic"},next:{title:"Developer Guide",permalink:"/handbook/docs/category/developer-guide"}},l={},a=[{value:"Invitations",id:"invitations",level:2},{value:"UI",id:"ui",level:2},{value:"Video",id:"video",level:2},{value:"Audio",id:"audio",level:2}];function o(e){const d={code:"code",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(d.p,{children:"There are some options to tweak the invitation link to unlock more features in\nJitsi. The following parameters apply to the web, iframe and mobile version."}),"\n",(0,n.jsxs)(d.p,{children:["All keys listed here are prefixed with ",(0,n.jsx)(d.code,{children:"config."}),".\nYou pick a key, combine it with its value using ",(0,n.jsx)(d.code,{children:"="})," and link parameters\nwith ",(0,n.jsx)(d.code,{children:"&"}),", e.g. ",(0,n.jsx)(d.code,{children:"#config.defaultLanguage=en&config.minParticipants=3"}),"."]}),"\n",(0,n.jsx)(d.h2,{id:"invitations",children:"Invitations"}),"\n",(0,n.jsx)(d.p,{children:"These parameters affect how you can invite people either before or within a session."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableInviteFunctions"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable invite function of the app"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"minParticipants"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"2"})}),(0,n.jsx)(d.td,{children:"override the minimum number of participants before starting a call"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"prejoinConfig.enabled"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"show an intermediate page before joining to allow for adjustment of devices"})]})]})]}),"\n",(0,n.jsx)(d.h2,{id:"ui",children:"UI"}),"\n",(0,n.jsx)(d.p,{children:"These parameters have an effect on the user interface."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"defaultLanguage"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"en"})}),(0,n.jsx)(d.td,{children:"change the UI default language"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableThirdPartyRequests"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"generate avatars locally and disable callstats integration"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"enableDisplayNameInStats"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"send display names of participants to callstats"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"enableEmailInStats"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"send email (if available) to callstats and other analytics"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"enableInsecureRoomNameWarning"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"show a warning label if the room name is deemed insecure"})]})]})]}),"\n",(0,n.jsx)(d.h2,{id:"video",children:"Video"}),"\n",(0,n.jsx)(d.p,{children:"Use these parameters to influence the video of a session."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"desktopSharingFrameRate.min"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"5"})}),(0,n.jsx)(d.td,{children:"override the minimum framerate for desktop sharing"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"desktopSharingFrameRate.max"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"5"})}),(0,n.jsx)(d.td,{children:"override the maximum framerate for desktop sharing"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"startWithVideoMuted"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable video when joining"})]})]})]}),"\n",(0,n.jsx)(d.h2,{id:"audio",children:"Audio"}),"\n",(0,n.jsx)(d.p,{children:"Use these parameters to influence the audio of a session."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableAudioLevels"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable audio statistics polling (thereby perhaps improving performance)"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableRemoteMute"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable all muting operations of remote participants"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"startWithAudioMuted"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"turn off audio input when joining"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"startSilent"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"mute audio input and output"})]})]})]})]})}function h(e={}){const{wrapper:d}={...(0,t.R)(),...e.components};return d?(0,n.jsx)(d,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},8453:(e,d,i)=>{i.d(d,{R:()=>r,x:()=>c});var n=i(6540);const t={},s=n.createContext(t);function r(e){const d=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(d):{...d,...e}}),[d,e])}function c(e){let d;return d=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(s.Provider,{value:d},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[1647],{4152:(e,d,i)=>{i.r(d),i.d(d,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var n=i(4848),t=i(8453);const s={id:"user-guide-advanced",title:"User Guide (advanced)",sidebar_label:"Advanced options"},r=void 0,c={id:"user-guide/user-guide-advanced",title:"User Guide (advanced)",description:"There are some options to tweak the invitation link to unlock more features in",source:"@site/docs/user-guide/advanced.md",sourceDirName:"user-guide",slug:"/user-guide/user-guide-advanced",permalink:"/handbook/docs/user-guide/user-guide-advanced",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/advanced.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"user-guide-advanced",title:"User Guide (advanced)",sidebar_label:"Advanced options"},sidebar:"docs",previous:{title:"Basic options",permalink:"/handbook/docs/user-guide/user-guide-basic"},next:{title:"Developer Guide",permalink:"/handbook/docs/category/developer-guide"}},l={},a=[{value:"Invitations",id:"invitations",level:2},{value:"UI",id:"ui",level:2},{value:"Video",id:"video",level:2},{value:"Audio",id:"audio",level:2}];function o(e){const d={code:"code",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(d.p,{children:"There are some options to tweak the invitation link to unlock more features in\nJitsi. The following parameters apply to the web, iframe and mobile version."}),"\n",(0,n.jsxs)(d.p,{children:["All keys listed here are prefixed with ",(0,n.jsx)(d.code,{children:"config."}),".\nYou pick a key, combine it with its value using ",(0,n.jsx)(d.code,{children:"="})," and link parameters\nwith ",(0,n.jsx)(d.code,{children:"&"}),", e.g. ",(0,n.jsx)(d.code,{children:"#config.defaultLanguage=en&config.minParticipants=3"}),"."]}),"\n",(0,n.jsx)(d.h2,{id:"invitations",children:"Invitations"}),"\n",(0,n.jsx)(d.p,{children:"These parameters affect how you can invite people either before or within a session."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableInviteFunctions"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable invite function of the app"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"minParticipants"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"2"})}),(0,n.jsx)(d.td,{children:"override the minimum number of participants before starting a call"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"prejoinConfig.enabled"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"show an intermediate page before joining to allow for adjustment of devices"})]})]})]}),"\n",(0,n.jsx)(d.h2,{id:"ui",children:"UI"}),"\n",(0,n.jsx)(d.p,{children:"These parameters have an effect on the user interface."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"defaultLanguage"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"en"})}),(0,n.jsx)(d.td,{children:"change the UI default language"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableThirdPartyRequests"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"generate avatars locally and disable callstats integration"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"enableDisplayNameInStats"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"send display names of participants to callstats"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"enableEmailInStats"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"send email (if available) to callstats and other analytics"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"enableInsecureRoomNameWarning"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"show a warning label if the room name is deemed insecure"})]})]})]}),"\n",(0,n.jsx)(d.h2,{id:"video",children:"Video"}),"\n",(0,n.jsx)(d.p,{children:"Use these parameters to influence the video of a session."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"desktopSharingFrameRate.min"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"5"})}),(0,n.jsx)(d.td,{children:"override the minimum framerate for desktop sharing"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"desktopSharingFrameRate.max"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"5"})}),(0,n.jsx)(d.td,{children:"override the maximum framerate for desktop sharing"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"startWithVideoMuted"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable video when joining"})]})]})]}),"\n",(0,n.jsx)(d.h2,{id:"audio",children:"Audio"}),"\n",(0,n.jsx)(d.p,{children:"Use these parameters to influence the audio of a session."}),"\n",(0,n.jsxs)(d.table,{children:[(0,n.jsx)(d.thead,{children:(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.th,{children:"Key"}),(0,n.jsx)(d.th,{children:"Value"}),(0,n.jsx)(d.th,{children:"Effect"})]})}),(0,n.jsxs)(d.tbody,{children:[(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableAudioLevels"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable audio statistics polling (thereby perhaps improving performance)"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"disableRemoteMute"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"disable all muting operations of remote participants"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"startWithAudioMuted"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"turn off audio input when joining"})]}),(0,n.jsxs)(d.tr,{children:[(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"startSilent"})}),(0,n.jsx)(d.td,{children:(0,n.jsx)(d.code,{children:"true"})}),(0,n.jsx)(d.td,{children:"mute audio input and output"})]})]})]})]})}function h(e={}){const{wrapper:d}={...(0,t.R)(),...e.components};return d?(0,n.jsx)(d,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},8453:(e,d,i)=>{i.d(d,{R:()=>r,x:()=>c});var n=i(6540);const t={},s=n.createContext(t);function r(e){const d=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(d):{...d,...e}}),[d,e])}function c(e){let d;return d=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(s.Provider,{value:d},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4835d996.5010b215.js b/assets/js/4835d996.f3b018d6.js similarity index 99% rename from assets/js/4835d996.5010b215.js rename to assets/js/4835d996.f3b018d6.js index 98c20bdd5..510f53ae2 100644 --- a/assets/js/4835d996.5010b215.js +++ b/assets/js/4835d996.f3b018d6.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[1239],{5914:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(4848),s=i(8453);const o={id:"dev-guide-react-sdk",title:"React SDK"},r=void 0,a={id:"dev-guide/dev-guide-react-sdk",title:"React SDK",description:"The Jitsi Meet React SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps.",source:"@site/docs/dev-guide/react-sdk.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-react-sdk",permalink:"/handbook/docs/dev-guide/dev-guide-react-sdk",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/react-sdk.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"dev-guide-react-sdk",title:"React SDK"},sidebar:"docs",previous:{title:"Electron SDK",permalink:"/handbook/docs/dev-guide/dev-guide-electron-sdk"},next:{title:"Android SDK",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk"}},d={},c=[{value:"Sample application using the SDK",id:"sample-application-using-the-sdk",level:2},{value:"Installation",id:"installation",level:2},{value:"Modules",id:"modules",level:2},{value:"JitsiMeeting",id:"jitsimeeting",level:3},{value:"Properties specific to the JitsiMeeting component",id:"properties-specific-to-the-jitsimeeting-component",level:4},{value:"JaaSMeeting",id:"jaasmeeting",level:3},{value:"Properties specific to the JaaSMeeting component",id:"properties-specific-to-the-jaasmeeting-component",level:4},{value:"Common properties",id:"common-properties",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"The Jitsi Meet React SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps."}),"\n",(0,t.jsx)(n.admonition,{type:"important",children:(0,t.jsx)(n.p,{children:"React 16 or higher is required."})}),"\n",(0,t.jsx)(n.h2,{id:"sample-application-using-the-sdk",children:"Sample application using the SDK"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to see how easy integrating the Jitsi Meet React SDK into a React application is, take a look at our ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-react-sdk/tree/main/example",children:"example"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,t.jsx)(n.p,{children:"To access the React SDK modules in your application you need to install it as a dependency:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"npm install @jitsi/react-sdk\n"})}),"\n",(0,t.jsx)(n.h2,{id:"modules",children:"Modules"}),"\n",(0,t.jsx)(n.p,{children:"The SDK exposes two components with similar properties, intended for different use-cases."}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeeting",children:"JitsiMeeting"}),"\n",(0,t.jsx)(n.p,{children:"To be used with custom domains as-it-is in React projects:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:" {\n // here you can attach custom event listeners to the Jitsi Meet External API\n // you can also store it locally to execute commands\n } }\n getIFrameRef = { (iframeRef) => { iframeRef.style.height = '400px'; } }\n/>\n"})}),"\n",(0,t.jsxs)(n.h4,{id:"properties-specific-to-the-jitsimeeting-component",children:["Properties specific to the ",(0,t.jsx)(n.code,{children:"JitsiMeeting"})," component"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"domain"}),": Optional. Field used to retrieve the external_api.js file that initializes the IFrame. If omitted, defaults to ",(0,t.jsx)(n.code,{children:"meet.jit.si"}),"."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"jaasmeeting",children:"JaaSMeeting"}),"\n",(0,t.jsxs)(n.p,{children:["To be used with the ",(0,t.jsx)(n.code,{children:"8x8.vc"})," domain as-it-is in React projects:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:" { ... } }\n/>\n"})}),"\n",(0,t.jsxs)(n.p,{children:["...or with the ",(0,t.jsx)(n.code,{children:"stage.8x8.vc"})," domain:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-js",children:'\n'})}),"\n",(0,t.jsxs)(n.h4,{id:"properties-specific-to-the-jaasmeeting-component",children:["Properties specific to the ",(0,t.jsx)(n.code,{children:"JaaSMeeting"})," component"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"appId"}),": Required. Provides an isolated context and prefixes the room name."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"useStaging"}),": Optional. Tells whether to use the staging environment or not."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"common-properties",children:"Common properties"}),"\n",(0,t.jsxs)(n.p,{children:["The component modules support a similar kind of customization to the Jitsi Meet IFrame. The following properties can be passed down to your instances of ",(0,t.jsx)(n.code,{children:"JitsiMeeting"})," or ",(0,t.jsx)(n.code,{children:"JaaSMeeting"}),"."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"roomName"}),": Required. The name of the room to join."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"configOverwrite"}),": Optional. The JS object with overrides for options defined in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/config.js",children:"config.js"})," file."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"interfaceConfigOverwrite"}),": Optional. The JS object with overrides for options defined in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/interface_config.js",children:"interface_config.js"})," file."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"jwt"}),": Optional. The ",(0,t.jsx)(n.a,{href:"https://jwt.io/",children:"JWT"})," token."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"invitees"}),": Optional. Object arrays that contain information about participants invited to a call."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"devices"}),": Optional. Information map about the devices used in a call."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"userInfo"}),": Optional. The JS object that contains information about the participant starting or joining the meeting (e.g., email)."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"release"}),": Optional. Information regarding the ",(0,t.jsx)(n.code,{children:"stage.8x8.vc"})," or ",(0,t.jsx)(n.code,{children:"8x8.vc"})," release version. Expects the following format: ",(0,t.jsx)(n.code,{children:"release-1234"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"spinner"}),": Optional. The custom spinner to be displayed while the IFrame is loading."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"onApiReady"}),": Optional. The external API reference for events and commands."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"onReadyToClose"}),": Optional. The callback for when the meeting is ready to be closed."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"getIFrameRef"}),": Optional. The parent node used by the IFrame."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(6540);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[1239],{5914:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(4848),s=i(8453);const o={id:"dev-guide-react-sdk",title:"React SDK"},r=void 0,a={id:"dev-guide/dev-guide-react-sdk",title:"React SDK",description:"The Jitsi Meet React SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps.",source:"@site/docs/dev-guide/react-sdk.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-react-sdk",permalink:"/handbook/docs/dev-guide/dev-guide-react-sdk",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/react-sdk.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"dev-guide-react-sdk",title:"React SDK"},sidebar:"docs",previous:{title:"Electron SDK",permalink:"/handbook/docs/dev-guide/dev-guide-electron-sdk"},next:{title:"Android SDK",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk"}},d={},c=[{value:"Sample application using the SDK",id:"sample-application-using-the-sdk",level:2},{value:"Installation",id:"installation",level:2},{value:"Modules",id:"modules",level:2},{value:"JitsiMeeting",id:"jitsimeeting",level:3},{value:"Properties specific to the JitsiMeeting component",id:"properties-specific-to-the-jitsimeeting-component",level:4},{value:"JaaSMeeting",id:"jaasmeeting",level:3},{value:"Properties specific to the JaaSMeeting component",id:"properties-specific-to-the-jaasmeeting-component",level:4},{value:"Common properties",id:"common-properties",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"The Jitsi Meet React SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps."}),"\n",(0,t.jsx)(n.admonition,{type:"important",children:(0,t.jsx)(n.p,{children:"React 16 or higher is required."})}),"\n",(0,t.jsx)(n.h2,{id:"sample-application-using-the-sdk",children:"Sample application using the SDK"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to see how easy integrating the Jitsi Meet React SDK into a React application is, take a look at our ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-react-sdk/tree/main/example",children:"example"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,t.jsx)(n.p,{children:"To access the React SDK modules in your application you need to install it as a dependency:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"npm install @jitsi/react-sdk\n"})}),"\n",(0,t.jsx)(n.h2,{id:"modules",children:"Modules"}),"\n",(0,t.jsx)(n.p,{children:"The SDK exposes two components with similar properties, intended for different use-cases."}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeeting",children:"JitsiMeeting"}),"\n",(0,t.jsx)(n.p,{children:"To be used with custom domains as-it-is in React projects:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:" {\n // here you can attach custom event listeners to the Jitsi Meet External API\n // you can also store it locally to execute commands\n } }\n getIFrameRef = { (iframeRef) => { iframeRef.style.height = '400px'; } }\n/>\n"})}),"\n",(0,t.jsxs)(n.h4,{id:"properties-specific-to-the-jitsimeeting-component",children:["Properties specific to the ",(0,t.jsx)(n.code,{children:"JitsiMeeting"})," component"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"domain"}),": Optional. Field used to retrieve the external_api.js file that initializes the IFrame. If omitted, defaults to ",(0,t.jsx)(n.code,{children:"meet.jit.si"}),"."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"jaasmeeting",children:"JaaSMeeting"}),"\n",(0,t.jsxs)(n.p,{children:["To be used with the ",(0,t.jsx)(n.code,{children:"8x8.vc"})," domain as-it-is in React projects:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:" { ... } }\n/>\n"})}),"\n",(0,t.jsxs)(n.p,{children:["...or with the ",(0,t.jsx)(n.code,{children:"stage.8x8.vc"})," domain:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-js",children:'\n'})}),"\n",(0,t.jsxs)(n.h4,{id:"properties-specific-to-the-jaasmeeting-component",children:["Properties specific to the ",(0,t.jsx)(n.code,{children:"JaaSMeeting"})," component"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"appId"}),": Required. Provides an isolated context and prefixes the room name."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"useStaging"}),": Optional. Tells whether to use the staging environment or not."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"common-properties",children:"Common properties"}),"\n",(0,t.jsxs)(n.p,{children:["The component modules support a similar kind of customization to the Jitsi Meet IFrame. The following properties can be passed down to your instances of ",(0,t.jsx)(n.code,{children:"JitsiMeeting"})," or ",(0,t.jsx)(n.code,{children:"JaaSMeeting"}),"."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"roomName"}),": Required. The name of the room to join."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"configOverwrite"}),": Optional. The JS object with overrides for options defined in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/config.js",children:"config.js"})," file."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"interfaceConfigOverwrite"}),": Optional. The JS object with overrides for options defined in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/interface_config.js",children:"interface_config.js"})," file."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"jwt"}),": Optional. The ",(0,t.jsx)(n.a,{href:"https://jwt.io/",children:"JWT"})," token."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"invitees"}),": Optional. Object arrays that contain information about participants invited to a call."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"devices"}),": Optional. Information map about the devices used in a call."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"userInfo"}),": Optional. The JS object that contains information about the participant starting or joining the meeting (e.g., email)."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"release"}),": Optional. Information regarding the ",(0,t.jsx)(n.code,{children:"stage.8x8.vc"})," or ",(0,t.jsx)(n.code,{children:"8x8.vc"})," release version. Expects the following format: ",(0,t.jsx)(n.code,{children:"release-1234"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"spinner"}),": Optional. The custom spinner to be displayed while the IFrame is loading."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"onApiReady"}),": Optional. The external API reference for events and commands."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"onReadyToClose"}),": Optional. The callback for when the meeting is ready to be closed."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"getIFrameRef"}),": Optional. The parent node used by the IFrame."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(6540);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4a0a1b35.ddd7bf2b.js b/assets/js/4a0a1b35.fea9d6a5.js similarity index 96% rename from assets/js/4a0a1b35.ddd7bf2b.js rename to assets/js/4a0a1b35.fea9d6a5.js index c03574694..c385469c3 100644 --- a/assets/js/4a0a1b35.ddd7bf2b.js +++ b/assets/js/4a0a1b35.fea9d6a5.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7090],{2741:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>c,frontMatter:()=>n,metadata:()=>r,toc:()=>l});var o=i(4848),s=i(8453);const n={id:"mobile-feature-flags",title:"Feature flags"},a=void 0,r={id:"dev-guide/mobile-feature-flags",title:"Feature flags",description:"The mobile SDK supports a number of feature flags which allow for customizing certain",source:"@site/docs/dev-guide/mobile-feature-flags.md",sourceDirName:"dev-guide",slug:"/dev-guide/mobile-feature-flags",permalink:"/handbook/docs/dev-guide/mobile-feature-flags",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/mobile-feature-flags.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"mobile-feature-flags",title:"Feature flags"},sidebar:"docs",previous:{title:"Jitsi Meet development",permalink:"/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet"},next:{title:"Android SDK",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk"}},d={},l=[];function u(e){const t={a:"a",p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"The mobile SDK supports a number of feature flags which allow for customizing certain\nUI aspects and behavior."}),"\n",(0,o.jsxs)(t.p,{children:["All flags are defined ",(0,o.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/flags/constants.ts",children:"here"}),"."]})]})}function c(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>r});var o=i(6540);const s={},n=o.createContext(s);function a(e){const t=o.useContext(n);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7090],{2741:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>c,frontMatter:()=>n,metadata:()=>r,toc:()=>l});var o=i(4848),s=i(8453);const n={id:"mobile-feature-flags",title:"Feature flags"},a=void 0,r={id:"dev-guide/mobile-feature-flags",title:"Feature flags",description:"The mobile SDK supports a number of feature flags which allow for customizing certain",source:"@site/docs/dev-guide/mobile-feature-flags.md",sourceDirName:"dev-guide",slug:"/dev-guide/mobile-feature-flags",permalink:"/handbook/docs/dev-guide/mobile-feature-flags",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/mobile-feature-flags.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"mobile-feature-flags",title:"Feature flags"},sidebar:"docs",previous:{title:"Jitsi Meet development",permalink:"/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet"},next:{title:"Android SDK",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk"}},d={},l=[];function u(e){const t={a:"a",p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"The mobile SDK supports a number of feature flags which allow for customizing certain\nUI aspects and behavior."}),"\n",(0,o.jsxs)(t.p,{children:["All flags are defined ",(0,o.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/flags/constants.ts",children:"here"}),"."]})]})}function c(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>r});var o=i(6540);const s={},n=o.createContext(s);function a(e){const t=o.useContext(n);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4d66996a.8c66492a.js b/assets/js/4d66996a.9b4581ea.js similarity index 99% rename from assets/js/4d66996a.8c66492a.js rename to assets/js/4d66996a.9b4581ea.js index fa8fa6e50..7c7bdda73 100644 --- a/assets/js/4d66996a.8c66492a.js +++ b/assets/js/4d66996a.9b4581ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2378],{4864:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>T,contentTitle:()=>I,default:()=>_,frontMatter:()=>S,metadata:()=>V,toc:()=>E});var n=s(4848),r=s(8453),i=s(6540),a=s(4164),l=s(3104),o=s(6347),d=s(205),c=s(7485),u=s(1682),h=s(679);function p(e){var t,s;return null!=(t=null==(s=i.Children.toArray(e).filter((function(e){return"\n"!==e})).map((function(e){if(!e||(0,i.isValidElement)(e)&&((t=e.props)&&"object"==typeof t&&"value"in t))return e;var t;throw new Error("Docusaurus error: Bad child <"+("string"==typeof e.type?e.type:e.type.name)+'>: all children of the component should be , and every should have a unique "value" prop.')})))?void 0:s.filter(Boolean))?t:[]}function j(e){var t=e.values,s=e.children;return(0,i.useMemo)((function(){var e=null!=t?t:function(e){return p(e).map((function(e){var t=e.props;return{value:t.value,label:t.label,attributes:t.attributes,default:t.default}}))}(s);return function(e){var t=(0,u.XI)(e,(function(e,t){return e.value===t.value}));if(t.length>0)throw new Error('Docusaurus error: Duplicate values "'+t.map((function(e){return e.value})).join(", ")+'" found in . Every value needs to be unique.')}(e),e}),[t,s])}function b(e){var t=e.value;return e.tabValues.some((function(e){return e.value===t}))}function x(e){var t=e.queryString,s=void 0!==t&&t,n=e.groupId,r=(0,o.W6)(),a=function(e){var t=e.queryString,s=void 0!==t&&t,n=e.groupId;if("string"==typeof s)return s;if(!1===s)return null;if(!0===s&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return null!=n?n:null}({queryString:s,groupId:n});return[(0,c.aZ)(a),(0,i.useCallback)((function(e){if(a){var t=new URLSearchParams(r.location.search);t.set(a,e),r.replace(Object.assign({},r.location,{search:t.toString()}))}}),[a,r])]}function g(e){var t,s,n,r,a=e.defaultValue,l=e.queryString,o=void 0!==l&&l,c=e.groupId,u=j(e),p=(0,i.useState)((function(){return function(e){var t,s=e.defaultValue,n=e.tabValues;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(s){if(!b({value:s,tabValues:n}))throw new Error('Docusaurus error: The has a defaultValue "'+s+'" but none of its children has the corresponding value. Available values are: '+n.map((function(e){return e.value})).join(", ")+". If you intend to show no default tab, use defaultValue={null} instead.");return s}var r=null!=(t=n.find((function(e){return e.default})))?t:n[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:a,tabValues:u})})),g=p[0],f=p[1],m=x({queryString:o,groupId:c}),v=m[0],y=m[1],w=(t=function(e){return e?"docusaurus.tab."+e:null}({groupId:c}.groupId),s=(0,h.Dv)(t),n=s[0],r=s[1],[n,(0,i.useCallback)((function(e){t&&r.set(e)}),[t,r])]),k=w[0],A=w[1],D=function(){var e=null!=v?v:k;return b({value:e,tabValues:u})?e:null}();return(0,d.A)((function(){D&&f(D)}),[D]),{selectedValue:g,selectValue:(0,i.useCallback)((function(e){if(!b({value:e,tabValues:u}))throw new Error("Can't select invalid tab value="+e);f(e),y(e),A(e)}),[y,A,u]),tabValues:u}}var f=s(2303);const m={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function v(e){var t=e.className,s=e.block,r=e.selectedValue,i=e.selectValue,o=e.tabValues,d=[],c=(0,l.a_)().blockElementScrollPositionUntilNextRender,u=function(e){var t=e.currentTarget,s=d.indexOf(t),n=o[s].value;n!==r&&(c(t),i(n))},h=function(e){var t,s=null;switch(e.key){case"Enter":u(e);break;case"ArrowRight":var n,r=d.indexOf(e.currentTarget)+1;s=null!=(n=d[r])?n:d[0];break;case"ArrowLeft":var i,a=d.indexOf(e.currentTarget)-1;s=null!=(i=d[a])?i:d[d.length-1]}null==(t=s)||t.focus()};return(0,n.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,a.A)("tabs",{"tabs--block":s},t),children:o.map((function(e){var t=e.value,s=e.label,i=e.attributes;return(0,n.jsx)("li",Object.assign({role:"tab",tabIndex:r===t?0:-1,"aria-selected":r===t,ref:function(e){return d.push(e)},onKeyDown:h,onClick:u},i,{className:(0,a.A)("tabs__item",m.tabItem,null==i?void 0:i.className,{"tabs__item--active":r===t}),children:null!=s?s:t}),t)}))})}function y(e){var t=e.lazy,s=e.children,r=e.selectedValue,l=(Array.isArray(s)?s:[s]).filter(Boolean);if(t){var o=l.find((function(e){return e.props.value===r}));return o?(0,i.cloneElement)(o,{className:(0,a.A)("margin-top--md",o.props.className)}):null}return(0,n.jsx)("div",{className:"margin-top--md",children:l.map((function(e,t){return(0,i.cloneElement)(e,{key:t,hidden:e.props.value!==r})}))})}function w(e){var t=g(e);return(0,n.jsxs)("div",{className:(0,a.A)("tabs-container",m.tabList),children:[(0,n.jsx)(v,Object.assign({},t,e)),(0,n.jsx)(y,Object.assign({},t,e))]})}function k(e){var t=(0,f.A)();return(0,n.jsx)(w,Object.assign({},e,{children:p(e.children)}),String(t))}const A={tabItem:"tabItem_Ymn6"};function D(e){var t=e.children,s=e.hidden,r=e.className;return(0,n.jsx)("div",{role:"tabpanel",className:(0,a.A)(A.tabItem,r),hidden:s,children:t})}const S={id:"releases",title:"Releases"},I=void 0,V={id:"releases",title:"Releases",description:"Release notes for Jitsi Meet are kept here.",source:"@site/docs/releases.md",sourceDirName:".",slug:"/releases",permalink:"/handbook/docs/releases",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/releases.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"releases",title:"Releases"},sidebar:"releases-sidebar"},T={},E=[{value:"Apps",id:"apps",level:3},{value:"Apps (beta)",id:"apps-beta",level:3},{value:"SDKs",id:"sdks",level:3},{value:"Docker images",id:"docker-images",level:3},{value:"Debian/Ubuntu packages",id:"debianubuntu-packages",level:3},{value:"Web frontend",id:"web-frontend",level:3}];function N(e){const t={a:"a",admonition:"admonition",code:"code",h3:"h3",img:"img",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Release notes for Jitsi Meet are kept ",(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-release-notes",children:"here"}),"."]})}),"\n","\n",(0,n.jsxs)(k,{queryString:"release",children:[(0,n.jsxs)(D,{value:"mobile",label:"Mobile",default:!0,children:[(0,n.jsx)(t.h3,{id:"apps",children:"Apps"}),(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android (F-Droid)"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"iOS"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://play.google.com/store/apps/details?id=org.jitsi.meet",children:(0,n.jsx)("img",{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/google-play-badge.png",height:"50"})})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://f-droid.org/en/packages/org.jitsi.meet/",children:(0,n.jsx)("img",{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/f-droid-badge.png",height:"50"})})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://itunes.apple.com/us/app/jitsi-meet/id1165103905",children:(0,n.jsx)("img",{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/appstore-badge.png",height:"50"})})})]})})]}),(0,n.jsx)(t.h3,{id:"apps-beta",children:"Apps (beta)"}),(0,n.jsx)(t.p,{children:"If you are feeling adventurous and want to get an early scoop of the features as they are being\ndeveloped you can also sign up for our open beta testing here:"}),(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"iOS"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://play.google.com/apps/testing/org.jitsi.meet",children:"Play Store Beta"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://testflight.apple.com/join/isy6ja7S",children:"TestFlight"})})]})})]}),(0,n.jsx)(t.h3,{id:"sdks",children:"SDKs"}),(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"iOS"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk#use-pre-build-sdk-artifactsbinaries",children:"Maven repository"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://cocoapods.org/pods/JitsiMeetSDK",children:"CocoaPods"})})]})})]})]}),(0,n.jsxs)(D,{value:"desktop",label:"Desktop",children:[(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Windows"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"macOS"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"GNU/Linux (AppImage)"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"GNU/Linux (Deb)"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet.exe",children:"Download"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet.dmg",children:"Download"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet-x86_64.AppImage",children:"Download"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet-amd64.deb",children:"Download"})})]})})]}),(0,n.jsxs)(t.p,{children:["The desktop applications are based on Electron. For macOS, it is also available as a ",(0,n.jsx)(t.code,{children:"brew"})," cask which can be installed using ",(0,n.jsx)(t.code,{children:"brew install jitsi-meet"}),"."]})]}),(0,n.jsxs)(D,{value:"server",label:"Server",children:[(0,n.jsx)(t.h3,{id:"docker-images",children:"Docker images"}),(0,n.jsxs)(t.p,{children:["See the Docker image releases ",(0,n.jsx)(t.a,{href:"https://github.com/jitsi/docker-jitsi-meet/releases",children:"here"}),"."]}),(0,n.jsx)(t.h3,{id:"debianubuntu-packages",children:"Debian/Ubuntu packages"}),(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.a,{href:"https://download.jitsi.org/stable/",children:(0,n.jsx)(t.code,{children:"stable"})})," (",(0,n.jsx)(t.a,{href:"https://jitsi.org/downloads/ubuntu-debian-installations-instructions/",children:"instructions"}),")"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.a,{href:"https://download.jitsi.org/testing/",children:(0,n.jsx)(t.code,{children:"testing"})})," (",(0,n.jsx)(t.a,{href:"https://jitsi.org/downloads/ubuntu-debian-installations-instructions-for-testing/",children:"instructions"}),")"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.a,{href:"https://download.jitsi.org/unstable/",children:(0,n.jsx)(t.code,{children:"nightly"})})," (",(0,n.jsx)(t.a,{href:"https://jitsi.org/downloads/ubuntu-debian-installations-instructions-nightly/",children:"instructions"}),")"]}),"\n"]}),(0,n.jsx)(t.h3,{id:"web-frontend",children:"Web frontend"}),(0,n.jsx)(t.table,{children:(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Latest stable release"}),(0,n.jsx)(t.th,{children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet/releases/latest",children:(0,n.jsx)(t.img,{src:"https://img.shields.io/badge/release-latest-green.svg",alt:"release"})})})]})})}),(0,n.jsxs)(t.p,{children:["Prebuilt ",(0,n.jsx)(t.a,{href:"https://download.jitsi.org/jitsi-meet/src/",children:"source builds"})," are also available."]}),(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsx)(t.p,{children:"Generally, you won't need to download this, as it's part of the Debian packages and Docker images already."})})]})]})]})}function _(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(N,{...e})}):N(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>a,x:()=>l});var n=s(6540);const r={},i=n.createContext(r);function a(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2378],{4864:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>T,contentTitle:()=>I,default:()=>_,frontMatter:()=>S,metadata:()=>V,toc:()=>E});var n=s(4848),r=s(8453),i=s(6540),a=s(4164),l=s(3104),o=s(6347),d=s(205),c=s(7485),u=s(1682),h=s(679);function p(e){var t,s;return null!=(t=null==(s=i.Children.toArray(e).filter((function(e){return"\n"!==e})).map((function(e){if(!e||(0,i.isValidElement)(e)&&((t=e.props)&&"object"==typeof t&&"value"in t))return e;var t;throw new Error("Docusaurus error: Bad child <"+("string"==typeof e.type?e.type:e.type.name)+'>: all children of the component should be , and every should have a unique "value" prop.')})))?void 0:s.filter(Boolean))?t:[]}function j(e){var t=e.values,s=e.children;return(0,i.useMemo)((function(){var e=null!=t?t:function(e){return p(e).map((function(e){var t=e.props;return{value:t.value,label:t.label,attributes:t.attributes,default:t.default}}))}(s);return function(e){var t=(0,u.XI)(e,(function(e,t){return e.value===t.value}));if(t.length>0)throw new Error('Docusaurus error: Duplicate values "'+t.map((function(e){return e.value})).join(", ")+'" found in . Every value needs to be unique.')}(e),e}),[t,s])}function b(e){var t=e.value;return e.tabValues.some((function(e){return e.value===t}))}function x(e){var t=e.queryString,s=void 0!==t&&t,n=e.groupId,r=(0,o.W6)(),a=function(e){var t=e.queryString,s=void 0!==t&&t,n=e.groupId;if("string"==typeof s)return s;if(!1===s)return null;if(!0===s&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return null!=n?n:null}({queryString:s,groupId:n});return[(0,c.aZ)(a),(0,i.useCallback)((function(e){if(a){var t=new URLSearchParams(r.location.search);t.set(a,e),r.replace(Object.assign({},r.location,{search:t.toString()}))}}),[a,r])]}function g(e){var t,s,n,r,a=e.defaultValue,l=e.queryString,o=void 0!==l&&l,c=e.groupId,u=j(e),p=(0,i.useState)((function(){return function(e){var t,s=e.defaultValue,n=e.tabValues;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(s){if(!b({value:s,tabValues:n}))throw new Error('Docusaurus error: The has a defaultValue "'+s+'" but none of its children has the corresponding value. Available values are: '+n.map((function(e){return e.value})).join(", ")+". If you intend to show no default tab, use defaultValue={null} instead.");return s}var r=null!=(t=n.find((function(e){return e.default})))?t:n[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:a,tabValues:u})})),g=p[0],f=p[1],m=x({queryString:o,groupId:c}),v=m[0],y=m[1],w=(t=function(e){return e?"docusaurus.tab."+e:null}({groupId:c}.groupId),s=(0,h.Dv)(t),n=s[0],r=s[1],[n,(0,i.useCallback)((function(e){t&&r.set(e)}),[t,r])]),k=w[0],A=w[1],D=function(){var e=null!=v?v:k;return b({value:e,tabValues:u})?e:null}();return(0,d.A)((function(){D&&f(D)}),[D]),{selectedValue:g,selectValue:(0,i.useCallback)((function(e){if(!b({value:e,tabValues:u}))throw new Error("Can't select invalid tab value="+e);f(e),y(e),A(e)}),[y,A,u]),tabValues:u}}var f=s(2303);const m={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function v(e){var t=e.className,s=e.block,r=e.selectedValue,i=e.selectValue,o=e.tabValues,d=[],c=(0,l.a_)().blockElementScrollPositionUntilNextRender,u=function(e){var t=e.currentTarget,s=d.indexOf(t),n=o[s].value;n!==r&&(c(t),i(n))},h=function(e){var t,s=null;switch(e.key){case"Enter":u(e);break;case"ArrowRight":var n,r=d.indexOf(e.currentTarget)+1;s=null!=(n=d[r])?n:d[0];break;case"ArrowLeft":var i,a=d.indexOf(e.currentTarget)-1;s=null!=(i=d[a])?i:d[d.length-1]}null==(t=s)||t.focus()};return(0,n.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,a.A)("tabs",{"tabs--block":s},t),children:o.map((function(e){var t=e.value,s=e.label,i=e.attributes;return(0,n.jsx)("li",Object.assign({role:"tab",tabIndex:r===t?0:-1,"aria-selected":r===t,ref:function(e){return d.push(e)},onKeyDown:h,onClick:u},i,{className:(0,a.A)("tabs__item",m.tabItem,null==i?void 0:i.className,{"tabs__item--active":r===t}),children:null!=s?s:t}),t)}))})}function y(e){var t=e.lazy,s=e.children,r=e.selectedValue,l=(Array.isArray(s)?s:[s]).filter(Boolean);if(t){var o=l.find((function(e){return e.props.value===r}));return o?(0,i.cloneElement)(o,{className:(0,a.A)("margin-top--md",o.props.className)}):null}return(0,n.jsx)("div",{className:"margin-top--md",children:l.map((function(e,t){return(0,i.cloneElement)(e,{key:t,hidden:e.props.value!==r})}))})}function w(e){var t=g(e);return(0,n.jsxs)("div",{className:(0,a.A)("tabs-container",m.tabList),children:[(0,n.jsx)(v,Object.assign({},t,e)),(0,n.jsx)(y,Object.assign({},t,e))]})}function k(e){var t=(0,f.A)();return(0,n.jsx)(w,Object.assign({},e,{children:p(e.children)}),String(t))}const A={tabItem:"tabItem_Ymn6"};function D(e){var t=e.children,s=e.hidden,r=e.className;return(0,n.jsx)("div",{role:"tabpanel",className:(0,a.A)(A.tabItem,r),hidden:s,children:t})}const S={id:"releases",title:"Releases"},I=void 0,V={id:"releases",title:"Releases",description:"Release notes for Jitsi Meet are kept here.",source:"@site/docs/releases.md",sourceDirName:".",slug:"/releases",permalink:"/handbook/docs/releases",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/releases.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"releases",title:"Releases"},sidebar:"releases-sidebar"},T={},E=[{value:"Apps",id:"apps",level:3},{value:"Apps (beta)",id:"apps-beta",level:3},{value:"SDKs",id:"sdks",level:3},{value:"Docker images",id:"docker-images",level:3},{value:"Debian/Ubuntu packages",id:"debianubuntu-packages",level:3},{value:"Web frontend",id:"web-frontend",level:3}];function N(e){const t={a:"a",admonition:"admonition",code:"code",h3:"h3",img:"img",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Release notes for Jitsi Meet are kept ",(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-release-notes",children:"here"}),"."]})}),"\n","\n",(0,n.jsxs)(k,{queryString:"release",children:[(0,n.jsxs)(D,{value:"mobile",label:"Mobile",default:!0,children:[(0,n.jsx)(t.h3,{id:"apps",children:"Apps"}),(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android (F-Droid)"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"iOS"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://play.google.com/store/apps/details?id=org.jitsi.meet",children:(0,n.jsx)("img",{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/google-play-badge.png",height:"50"})})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://f-droid.org/en/packages/org.jitsi.meet/",children:(0,n.jsx)("img",{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/f-droid-badge.png",height:"50"})})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://itunes.apple.com/us/app/jitsi-meet/id1165103905",children:(0,n.jsx)("img",{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/appstore-badge.png",height:"50"})})})]})})]}),(0,n.jsx)(t.h3,{id:"apps-beta",children:"Apps (beta)"}),(0,n.jsx)(t.p,{children:"If you are feeling adventurous and want to get an early scoop of the features as they are being\ndeveloped you can also sign up for our open beta testing here:"}),(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"iOS"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://play.google.com/apps/testing/org.jitsi.meet",children:"Play Store Beta"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://testflight.apple.com/join/isy6ja7S",children:"TestFlight"})})]})})]}),(0,n.jsx)(t.h3,{id:"sdks",children:"SDKs"}),(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Android"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"iOS"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk#use-pre-build-sdk-artifactsbinaries",children:"Maven repository"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://cocoapods.org/pods/JitsiMeetSDK",children:"CocoaPods"})})]})})]})]}),(0,n.jsxs)(D,{value:"desktop",label:"Desktop",children:[(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Windows"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"macOS"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"GNU/Linux (AppImage)"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"GNU/Linux (Deb)"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet.exe",children:"Download"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet.dmg",children:"Download"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet-x86_64.AppImage",children:"Download"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet-amd64.deb",children:"Download"})})]})})]}),(0,n.jsxs)(t.p,{children:["The desktop applications are based on Electron. For macOS, it is also available as a ",(0,n.jsx)(t.code,{children:"brew"})," cask which can be installed using ",(0,n.jsx)(t.code,{children:"brew install jitsi-meet"}),"."]})]}),(0,n.jsxs)(D,{value:"server",label:"Server",children:[(0,n.jsx)(t.h3,{id:"docker-images",children:"Docker images"}),(0,n.jsxs)(t.p,{children:["See the Docker image releases ",(0,n.jsx)(t.a,{href:"https://github.com/jitsi/docker-jitsi-meet/releases",children:"here"}),"."]}),(0,n.jsx)(t.h3,{id:"debianubuntu-packages",children:"Debian/Ubuntu packages"}),(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.a,{href:"https://download.jitsi.org/stable/",children:(0,n.jsx)(t.code,{children:"stable"})})," (",(0,n.jsx)(t.a,{href:"https://jitsi.org/downloads/ubuntu-debian-installations-instructions/",children:"instructions"}),")"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.a,{href:"https://download.jitsi.org/testing/",children:(0,n.jsx)(t.code,{children:"testing"})})," (",(0,n.jsx)(t.a,{href:"https://jitsi.org/downloads/ubuntu-debian-installations-instructions-for-testing/",children:"instructions"}),")"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.a,{href:"https://download.jitsi.org/unstable/",children:(0,n.jsx)(t.code,{children:"nightly"})})," (",(0,n.jsx)(t.a,{href:"https://jitsi.org/downloads/ubuntu-debian-installations-instructions-nightly/",children:"instructions"}),")"]}),"\n"]}),(0,n.jsx)(t.h3,{id:"web-frontend",children:"Web frontend"}),(0,n.jsx)(t.table,{children:(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Latest stable release"}),(0,n.jsx)(t.th,{children:(0,n.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet/releases/latest",children:(0,n.jsx)(t.img,{src:"https://img.shields.io/badge/release-latest-green.svg",alt:"release"})})})]})})}),(0,n.jsxs)(t.p,{children:["Prebuilt ",(0,n.jsx)(t.a,{href:"https://download.jitsi.org/jitsi-meet/src/",children:"source builds"})," are also available."]}),(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsx)(t.p,{children:"Generally, you won't need to download this, as it's part of the Debian packages and Docker images already."})})]})]})]})}function _(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(N,{...e})}):N(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>a,x:()=>l});var n=s(6540);const r={},i=n.createContext(r);function a(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4e572726.de94bab1.js b/assets/js/4e572726.f5a73512.js similarity index 99% rename from assets/js/4e572726.de94bab1.js rename to assets/js/4e572726.f5a73512.js index 6b46e7648..f8077c95c 100644 --- a/assets/js/4e572726.de94bab1.js +++ b/assets/js/4e572726.f5a73512.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3351],{5323:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=n(4848),i=n(8453),s=n(3514);const o={id:"devops-guide-start",title:"Self-Hosting Guide - Overview",sidebar_label:"Overview"},a=void 0,c={id:"devops-guide/devops-guide-start",title:"Self-Hosting Guide - Overview",description:"These guides help you to host your own Jitsi-Meet server.",source:"@site/docs/devops-guide/devops-guide.md",sourceDirName:"devops-guide",slug:"/devops-guide/",permalink:"/handbook/docs/devops-guide/",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/devops-guide.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"devops-guide-start",title:"Self-Hosting Guide - Overview",sidebar_label:"Overview"},sidebar:"docs",previous:{title:"Configuration",permalink:"/handbook/docs/dev-guide/dev-guide-configuration"},next:{title:"Deployment",permalink:"/handbook/docs/category/deployment"}},l={},d=[{value:"First, a bit of general advice",id:"first-a-bit-of-general-advice",level:2}];function u(e){const t={a:"a",admonition:"admonition",br:"br",em:"em",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"note",children:(0,r.jsxs)(t.p,{children:["These guides help you to ",(0,r.jsx)(t.em,{children:(0,r.jsx)(t.strong,{children:"host your own Jitsi-Meet server"})}),".",(0,r.jsx)(t.br,{}),"\n","If you want to have a video conference without setting up any infrastructure, use ",(0,r.jsx)(t.a,{href:"https://meet.jit.si",children:"https://meet.jit.si"})," instead."]})}),"\n",(0,r.jsx)(t.h2,{id:"first-a-bit-of-general-advice",children:"First, a bit of general advice"}),"\n",(0,r.jsxs)(t.p,{children:["Jitsi Meet being based on ",(0,r.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/WebRTC",children:"WebRTC"}),", an encrypted communication link (https) is ",(0,r.jsx)(t.em,{children:(0,r.jsx)(t.strong,{children:"necessary"})})," to get working multimedia, and the setup is not always trivial."]}),"\n",(0,r.jsxs)(t.p,{children:["The best option is an Internet server with a certificate for a domain registered in the ",(0,r.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/Domain_Name_System#Domain_name_registration",children:"DNS"}),"."]}),"\n",(0,r.jsx)(t.p,{children:"While it's possible to setup a server on a private network and/or a self-signed certificate, it can be less straightforward and you can expect difficulties, first if you want access both from the private network and the public internet, and second when using phones as these clients often don't accept self-signed certificates."}),"\n",(0,r.jsxs)(t.p,{children:["In case of trouble with clients using phones, ",(0,r.jsx)(t.a,{href:"https://whatsmychaincert.com",children:"check your certificate"}),"."]}),"\n",(0,r.jsx)("hr",{}),"\n","\n",(0,r.jsx)(s.A,{})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},3514:(e,t,n)=>{n.d(t,{A:()=>x});n(6540);var r=n(4164),i=n(2583),s=n(8774),o=n(5846),a=n(6654),c=n(1312),l=n(1107);const d={cardContainer:"cardContainer_fWXF",cardTitle:"cardTitle_rnsV",cardDescription:"cardDescription_PWke"};var u=n(4848);function h(e){var t=e.href,n=e.children;return(0,u.jsx)(s.A,{href:t,className:(0,r.A)("card padding--lg",d.cardContainer),children:n})}function p(e){var t=e.href,n=e.icon,i=e.title,s=e.description;return(0,u.jsxs)(h,{href:t,children:[(0,u.jsxs)(l.A,{as:"h2",className:(0,r.A)("text--truncate",d.cardTitle),title:i,children:[n," ",i]}),s&&(0,u.jsx)("p",{className:(0,r.A)("text--truncate",d.cardDescription),title:s,children:s})]})}function f(e){var t,n,r=e.item,s=(0,i.Nr)(r),a=(n=(0,o.W)().selectMessage,function(e){return n(e,(0,c.T)({message:"1 item|{count} items",id:"theme.docs.DocCard.categoryDescription.plurals",description:"The default description for a category card in the generated index about how many items this category includes"},{count:e}))});return s?(0,u.jsx)(p,{href:s,icon:"\ud83d\uddc3\ufe0f",title:r.label,description:null!=(t=r.description)?t:a(r.items.length)}):null}function m(e){var t,n,r=e.item,s=(0,a.A)(r.href)?"\ud83d\udcc4\ufe0f":"\ud83d\udd17",o=(0,i.cC)(null!=(t=r.docId)?t:void 0);return(0,u.jsx)(p,{href:r.href,icon:s,title:r.label,description:null!=(n=r.description)?n:null==o?void 0:o.description})}function g(e){var t=e.item;switch(t.type){case"link":return(0,u.jsx)(m,{item:t});case"category":return(0,u.jsx)(f,{item:t});default:throw new Error("unknown item type "+JSON.stringify(t))}}function v(e){var t=e.className,n=(0,i.$S)();return(0,u.jsx)(x,{items:n.items,className:t})}function x(e){var t=e.items,n=e.className;if(!t)return(0,u.jsx)(v,Object.assign({},e));var s=(0,i.d1)(t);return(0,u.jsx)("section",{className:(0,r.A)("row",n),children:s.map((function(e,t){return(0,u.jsx)("article",{className:"col col--6 margin-bottom--lg",children:(0,u.jsx)(g,{item:e})},t)}))})}},5846:(e,t,n)=>{n.d(t,{W:()=>l});var r=n(6540),i=n(4586),s=["zero","one","two","few","many","other"];function o(e){return s.filter((function(t){return e.includes(t)}))}var a={locale:"en",pluralForms:o(["one","other"]),select:function(e){return 1===e?"one":"other"}};function c(){var e=(0,i.A)().i18n.currentLocale;return(0,r.useMemo)((function(){try{return t=e,n=new Intl.PluralRules(t),{locale:t,pluralForms:o(n.resolvedOptions().pluralCategories),select:function(e){return n.select(e)}}}catch(r){return console.error('Failed to use Intl.PluralRules for locale "'+e+'".\nDocusaurus will fallback to the default (English) implementation.\nError: '+r.message+"\n"),a}var t,n}),[e])}function l(){var e=c();return{selectMessage:function(t,n){return function(e,t,n){var r=e.split("|");if(1===r.length)return r[0];r.length>n.pluralForms.length&&console.error("For locale="+n.locale+", a maximum of "+n.pluralForms.length+" plural forms are expected ("+n.pluralForms.join(",")+"), but the message contains "+r.length+": "+e);var i=n.select(t),s=n.pluralForms.indexOf(i);return r[Math.min(s,r.length-1)]}(n,t,e)}}}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var r=n(6540);const i={},s=r.createContext(i);function o(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3351],{5323:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=n(4848),i=n(8453),s=n(3514);const o={id:"devops-guide-start",title:"Self-Hosting Guide - Overview",sidebar_label:"Overview"},a=void 0,c={id:"devops-guide/devops-guide-start",title:"Self-Hosting Guide - Overview",description:"These guides help you to host your own Jitsi-Meet server.",source:"@site/docs/devops-guide/devops-guide.md",sourceDirName:"devops-guide",slug:"/devops-guide/",permalink:"/handbook/docs/devops-guide/",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/devops-guide.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"devops-guide-start",title:"Self-Hosting Guide - Overview",sidebar_label:"Overview"},sidebar:"docs",previous:{title:"Configuration",permalink:"/handbook/docs/dev-guide/dev-guide-configuration"},next:{title:"Deployment",permalink:"/handbook/docs/category/deployment"}},l={},d=[{value:"First, a bit of general advice",id:"first-a-bit-of-general-advice",level:2}];function u(e){const t={a:"a",admonition:"admonition",br:"br",em:"em",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"note",children:(0,r.jsxs)(t.p,{children:["These guides help you to ",(0,r.jsx)(t.em,{children:(0,r.jsx)(t.strong,{children:"host your own Jitsi-Meet server"})}),".",(0,r.jsx)(t.br,{}),"\n","If you want to have a video conference without setting up any infrastructure, use ",(0,r.jsx)(t.a,{href:"https://meet.jit.si",children:"https://meet.jit.si"})," instead."]})}),"\n",(0,r.jsx)(t.h2,{id:"first-a-bit-of-general-advice",children:"First, a bit of general advice"}),"\n",(0,r.jsxs)(t.p,{children:["Jitsi Meet being based on ",(0,r.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/WebRTC",children:"WebRTC"}),", an encrypted communication link (https) is ",(0,r.jsx)(t.em,{children:(0,r.jsx)(t.strong,{children:"necessary"})})," to get working multimedia, and the setup is not always trivial."]}),"\n",(0,r.jsxs)(t.p,{children:["The best option is an Internet server with a certificate for a domain registered in the ",(0,r.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/Domain_Name_System#Domain_name_registration",children:"DNS"}),"."]}),"\n",(0,r.jsx)(t.p,{children:"While it's possible to setup a server on a private network and/or a self-signed certificate, it can be less straightforward and you can expect difficulties, first if you want access both from the private network and the public internet, and second when using phones as these clients often don't accept self-signed certificates."}),"\n",(0,r.jsxs)(t.p,{children:["In case of trouble with clients using phones, ",(0,r.jsx)(t.a,{href:"https://whatsmychaincert.com",children:"check your certificate"}),"."]}),"\n",(0,r.jsx)("hr",{}),"\n","\n",(0,r.jsx)(s.A,{})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},3514:(e,t,n)=>{n.d(t,{A:()=>x});n(6540);var r=n(4164),i=n(2583),s=n(8774),o=n(5846),a=n(6654),c=n(1312),l=n(1107);const d={cardContainer:"cardContainer_fWXF",cardTitle:"cardTitle_rnsV",cardDescription:"cardDescription_PWke"};var u=n(4848);function h(e){var t=e.href,n=e.children;return(0,u.jsx)(s.A,{href:t,className:(0,r.A)("card padding--lg",d.cardContainer),children:n})}function p(e){var t=e.href,n=e.icon,i=e.title,s=e.description;return(0,u.jsxs)(h,{href:t,children:[(0,u.jsxs)(l.A,{as:"h2",className:(0,r.A)("text--truncate",d.cardTitle),title:i,children:[n," ",i]}),s&&(0,u.jsx)("p",{className:(0,r.A)("text--truncate",d.cardDescription),title:s,children:s})]})}function f(e){var t,n,r=e.item,s=(0,i.Nr)(r),a=(n=(0,o.W)().selectMessage,function(e){return n(e,(0,c.T)({message:"1 item|{count} items",id:"theme.docs.DocCard.categoryDescription.plurals",description:"The default description for a category card in the generated index about how many items this category includes"},{count:e}))});return s?(0,u.jsx)(p,{href:s,icon:"\ud83d\uddc3\ufe0f",title:r.label,description:null!=(t=r.description)?t:a(r.items.length)}):null}function m(e){var t,n,r=e.item,s=(0,a.A)(r.href)?"\ud83d\udcc4\ufe0f":"\ud83d\udd17",o=(0,i.cC)(null!=(t=r.docId)?t:void 0);return(0,u.jsx)(p,{href:r.href,icon:s,title:r.label,description:null!=(n=r.description)?n:null==o?void 0:o.description})}function g(e){var t=e.item;switch(t.type){case"link":return(0,u.jsx)(m,{item:t});case"category":return(0,u.jsx)(f,{item:t});default:throw new Error("unknown item type "+JSON.stringify(t))}}function v(e){var t=e.className,n=(0,i.$S)();return(0,u.jsx)(x,{items:n.items,className:t})}function x(e){var t=e.items,n=e.className;if(!t)return(0,u.jsx)(v,Object.assign({},e));var s=(0,i.d1)(t);return(0,u.jsx)("section",{className:(0,r.A)("row",n),children:s.map((function(e,t){return(0,u.jsx)("article",{className:"col col--6 margin-bottom--lg",children:(0,u.jsx)(g,{item:e})},t)}))})}},5846:(e,t,n)=>{n.d(t,{W:()=>l});var r=n(6540),i=n(4586),s=["zero","one","two","few","many","other"];function o(e){return s.filter((function(t){return e.includes(t)}))}var a={locale:"en",pluralForms:o(["one","other"]),select:function(e){return 1===e?"one":"other"}};function c(){var e=(0,i.A)().i18n.currentLocale;return(0,r.useMemo)((function(){try{return t=e,n=new Intl.PluralRules(t),{locale:t,pluralForms:o(n.resolvedOptions().pluralCategories),select:function(e){return n.select(e)}}}catch(r){return console.error('Failed to use Intl.PluralRules for locale "'+e+'".\nDocusaurus will fallback to the default (English) implementation.\nError: '+r.message+"\n"),a}var t,n}),[e])}function l(){var e=c();return{selectMessage:function(t,n){return function(e,t,n){var r=e.split("|");if(1===r.length)return r[0];r.length>n.pluralForms.length&&console.error("For locale="+n.locale+", a maximum of "+n.pluralForms.length+" plural forms are expected ("+n.pluralForms.join(",")+"), but the message contains "+r.length+": "+e);var i=n.select(t),s=n.pluralForms.indexOf(i);return r[Math.min(s,r.length-1)]}(n,t,e)}}}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var r=n(6540);const i={},s=r.createContext(i);function o(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4e8cc489.1ce498f2.js b/assets/js/4e8cc489.bd968a42.js similarity index 96% rename from assets/js/4e8cc489.1ce498f2.js rename to assets/js/4e8cc489.bd968a42.js index d52406d02..8cc843d27 100644 --- a/assets/js/4e8cc489.1ce498f2.js +++ b/assets/js/4e8cc489.bd968a42.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2609],{3754:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>u,contentTitle:()=>r,default:()=>l,frontMatter:()=>n,metadata:()=>d,toc:()=>c});var i=s(4848),o=s(8453);const n={id:"user-guide-basic",title:"User Guide (basic)",sidebar_label:"Basic options"},r=void 0,d={id:"user-guide/user-guide-basic",title:"User Guide (basic)",description:"Welcome to the user guide!",source:"@site/docs/user-guide/basic.md",sourceDirName:"user-guide",slug:"/user-guide/user-guide-basic",permalink:"/handbook/docs/user-guide/user-guide-basic",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/basic.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"user-guide-basic",title:"User Guide (basic)",sidebar_label:"Basic options"},sidebar:"docs",previous:{title:"Keyboard shortcuts",permalink:"/handbook/docs/user-guide/keyboard-shortcuts"},next:{title:"Advanced options",permalink:"/handbook/docs/user-guide/user-guide-advanced"}},u={},c=[];function a(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"Welcome to the user guide!"}),"\n",(0,i.jsx)(t.p,{children:"Check back soon!"})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>r,x:()=>d});var i=s(6540);const o={},n=i.createContext(o);function r(e){const t=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2609],{3754:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>u,contentTitle:()=>r,default:()=>l,frontMatter:()=>n,metadata:()=>d,toc:()=>c});var i=s(4848),o=s(8453);const n={id:"user-guide-basic",title:"User Guide (basic)",sidebar_label:"Basic options"},r=void 0,d={id:"user-guide/user-guide-basic",title:"User Guide (basic)",description:"Welcome to the user guide!",source:"@site/docs/user-guide/basic.md",sourceDirName:"user-guide",slug:"/user-guide/user-guide-basic",permalink:"/handbook/docs/user-guide/user-guide-basic",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/basic.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"user-guide-basic",title:"User Guide (basic)",sidebar_label:"Basic options"},sidebar:"docs",previous:{title:"Keyboard shortcuts",permalink:"/handbook/docs/user-guide/keyboard-shortcuts"},next:{title:"Advanced options",permalink:"/handbook/docs/user-guide/user-guide-advanced"}},u={},c=[];function a(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"Welcome to the user guide!"}),"\n",(0,i.jsx)(t.p,{children:"Check back soon!"})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>r,x:()=>d});var i=s(6540);const o={},n=i.createContext(o);function r(e){const t=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5055ed84.f6b56831.js b/assets/js/5055ed84.fa980b96.js similarity index 99% rename from assets/js/5055ed84.f6b56831.js rename to assets/js/5055ed84.fa980b96.js index ee9803ed5..0c535ab90 100644 --- a/assets/js/5055ed84.f6b56831.js +++ b/assets/js/5055ed84.fa980b96.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[1401],{5292:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=o(4848),t=o(8453);const r={id:"reservation",title:"Reservation System setup",sidebar_label:"Reservation System"},i=void 0,c={id:"devops-guide/reservation",title:"Reservation System setup",description:"Support for a reservation system over REST API",source:"@site/docs/devops-guide/reservation.md",sourceDirName:"devops-guide",slug:"/devops-guide/reservation",permalink:"/handbook/docs/devops-guide/reservation",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/reservation.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"reservation",title:"Reservation System setup",sidebar_label:"Reservation System"},sidebar:"docs",previous:{title:"Scalable setup",permalink:"/handbook/docs/devops-guide/devops-guide-scalable"},next:{title:"TURN setup",permalink:"/handbook/docs/devops-guide/turn"}},a={},l=[{value:"Support for a reservation system over REST API",id:"support-for-a-reservation-system-over-rest-api",level:3},{value:"Enable reservation system",id:"enable-reservation-system",level:4},{value:"Call flow",id:"call-flow",level:4},{value:"Notes",id:"notes",level:5},{value:"Conference allocation",id:"conference-allocation",level:5},{value:"HTTP 200 or 201 Conference created successfully",id:"http-200-or-201-conference-created-successfully",level:6},{value:"HTTP 409 - Conference already exists",id:"http-409---conference-already-exists",level:6},{value:"HTTP 4xx",id:"http-4xx",level:6},{value:"Reading conference info",id:"reading-conference-info",level:5},{value:"Deleting conference",id:"deleting-conference",level:5},{value:"Implementation diagram",id:"implementation-diagram",level:4}];function d(e){const n={a:"a",code:"code",h3:"h3",h4:"h4",h5:"h5",h6:"h6",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h3,{id:"support-for-a-reservation-system-over-rest-api",children:"Support for a reservation system over REST API"}),"\n",(0,s.jsx)(n.p,{children:"It is possible to connect to an external conference reservation system using a\nREST API. Before a new Jitsi Meet conference is created, the reservation system will be\nqueried for room availability. The system is supposed to return a positive or\nnegative response code, which also contains conference duration. Prosody will enforce\nconference duration and if the time limit is exceeded the conference will be\nterminated."}),"\n",(0,s.jsx)(n.h4,{id:"enable-reservation-system",children:"Enable reservation system"}),"\n",(0,s.jsxs)(n.p,{children:['In order to enable the reservation system, the URL base for the REST API endpoint must be\nconfigured. Under the main virtual host in prosody, enable module "reservations" and\nadd the config ',(0,s.jsx)(n.code,{children:"reservations_api_prefix"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'VirtualHost "jitmeet.example.com"\n -- ....\n modules_enabled = {\n -- ....\n "reservations";\n }\n reservations_api_prefix = "http://reservation.example.com"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["The URL base is used to construct the request URL. Currently, only ",(0,s.jsx)(n.code,{children:"'/conference'"}),"\nendpoint is supported, so all request will go to:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"http://reservation.example.com/conference\n"})}),"\n",(0,s.jsx)(n.p,{children:"Additional configuration options are available:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"reservations_api_timeout" to change API call timeouts (defaults to 20 seconds)'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_headers" to specify custom HTTP headers included in\nall API calls e.g. to provide auth tokens.'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_retry_count" to specify the number of times API call failures are retried (defaults to 3)'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_retry_delay" seconds to wait between retries (defaults to 3s)'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_should_retry_for_code" as a function that takes an HTTP response code and\nreturns true if the API call should be retried. By default, retries are done for 5XX\nresponses. Timeouts are never retried, and HTTP call failures are always retried.'}),"\n",(0,s.jsxs)(n.li,{children:['"reservations_enable_max_occupants" to enable support for setting max occupants. If this is set to ',(0,s.jsx)(n.code,{children:"true"}),', and if\nthe API response payload includes a "max_occupants" value, then that value will be set as the max occupancy limit\nfor that specific room.',"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"muc_max_occupants" module must also be enabled for this to work.'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:['"reservations_enable_lobby_support" to enable support for lobby. If this is set to ',(0,s.jsx)(n.code,{children:"true"}),', and if\nthe API response payload includes a "lobby" field set to ',(0,s.jsx)(n.code,{children:"true"})," , then the lobby will be enabled for the room.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"muc_lobby_rooms" and "persistent_lobby" modules must also be enabled for this to work.'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:['"reservations_enable_password_support" to enable support for room password. If this is set to ',(0,s.jsx)(n.code,{children:"true"}),', and if\nthe API response payload includes a "password" value, then that value will be set as room password. Users will then\nbe required to know that password to be able to join the room, or in the case where lobby is enabled, can use the\npassword to bypass the lobby.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:' --- The following are all optional\n reservations_api_headers = {\n ["Authorization"] = "Bearer TOKEN-237958623045";\n }\n reservations_api_timeout = 10 -- timeout if API does not respond within 10s\n reservations_api_retry_count = 5 -- retry up to 5 times\n reservations_api_retry_delay = 1 -- wait 1s between retries\n reservations_api_should_retry_for_code = function (code)\n return code >= 500 or code == 408\n end\n reservations_enable_max_occupants = true -- enable integration with muc_max_occupants\n reservations_enable_lobby_support = true -- enable integration with muc_lobby_rooms\n reservations_enable_password_support = true -- enable support for setting room passwords\n'})}),"\n",(0,s.jsx)(n.h4,{id:"call-flow",children:"Call flow"}),"\n",(0,s.jsx)(n.h5,{id:"notes",children:"Notes"}),"\n",(0,s.jsx)(n.p,{children:"All API calls use the following datetime format:"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"yyyy-MM-dd'T'HH:mm:ss.SSSX"})," - more info can be found in\n",(0,s.jsx)(n.code,{children:"SimpleDateFormat"})," ",(0,s.jsx)(n.a,{href:"https://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html",children:"JavaDoc"})]}),"\n",(0,s.jsx)(n.h5,{id:"conference-allocation",children:"Conference allocation"}),"\n",(0,s.jsxs)(n.p,{children:["When the first user joins a MUC room (i.e. Jitsi Meet URL is opened), an ",(0,s.jsx)(n.code,{children:"HTTP POST"}),"\nrequest is sent to ",(0,s.jsx)(n.code,{children:"'/conference'"})," endpoint with the following parameters\nincluded:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"name (string)"})," - short name of the conference room (not full MUC address). If tenant is used, the name will be ",(0,s.jsx)(n.code,{children:"[tenant]roomname"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"start_time (string)"})," - conference start date and time"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mail_owner (string)"})," - if authentication system is enabled this field will\ncontain user's identity. It that case it will not be possible to create a new\nconference room without authenticating."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The payload sent to the endpoint will be encoded as ",(0,s.jsx)(n.code,{children:"application/x-www-form-urlencoded"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"The reservation system is expected to respond with one of the following\nresponses:"}),"\n",(0,s.jsx)(n.h6,{id:"http-200-or-201-conference-created-successfully",children:"HTTP 200 or 201 Conference created successfully"}),"\n",(0,s.jsxs)(n.p,{children:["In the HTTP response, a JSON object is expected. It should contain conference ",(0,s.jsx)(n.code,{children:"id"}),"\nassigned by the system and ",(0,s.jsx)(n.code,{children:"duration"})," measured in seconds. Sample response body:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "id": 364758328,\n "name": "conference1234",\n "mail_owner": "user@server.com",\n "start_time": "2048-04-20T17:55:12.000Z",\n "duration": 900000\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:["The object can optionally include a ",(0,s.jsx)(n.code,{children:"max_occupants"})," key with an integer value. When provided, and if\n",(0,s.jsx)(n.code,{children:"reservations_enable_max_occupants"})," is enabled, then the value will be passed to muc_mod_max_occupants to enforce\nper-room occupancy limits."]}),"\n",(0,s.jsx)(n.h6,{id:"http-409---conference-already-exists",children:"HTTP 409 - Conference already exists"}),"\n",(0,s.jsxs)(n.p,{children:["This is to recover from previous failures. If for some reason the conference was\nrestarted and the user tries to create the room again, this response informs Prosody\nthat the conference room already exists. It is expected to contain\n",(0,s.jsx)(n.code,{children:"conflict_id"})," in the JSON response body:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "conflict_id": 364758328\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Prosody will use ",(0,s.jsx)(n.code,{children:"HTTP GET"})," to fetch information about the conflicting conference for the\ngiven ",(0,s.jsx)(n.code,{children:"conflict_id"}),'. More info about this request can be found in the "Reading conference info"\nsection.']}),"\n",(0,s.jsx)(n.h6,{id:"http-4xx",children:"HTTP 4xx"}),"\n",(0,s.jsxs)(n.p,{children:["Other response codes will cause conference creation failure. The JSON response\ncan contain a ",(0,s.jsx)(n.code,{children:"message"})," object which will be sent back to the client."]}),"\n",(0,s.jsxs)(n.p,{children:["For example ",(0,s.jsx)(n.code,{children:"user1"})," tries to start a new conference by sending\n",(0,s.jsx)(n.code,{children:"conference"})," IQ to Jicofo. The system will reject the request."]}),"\n",(0,s.jsx)(n.p,{children:"Client -> Jicofo:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"\n \n\n"})}),"\n",(0,s.jsx)(n.p,{children:"Prosody -> Reservation system:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"POST /conference HTTP/1.1\ncontent-type:application/x-www-form-urlencoded;charset=utf-8\nhost: http://reservation.example.com\ncontent-length: length\n\nname=testroom1&start_time=2048-04-20T17%3A55%3A12.000Z&mail_owner=client1%40xmpp.com\n"})}),"\n",(0,s.jsx)(n.p,{children:"Reservation system -> Prosody:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'HTTP/1.1 403 Forbidden\nContent-Type: application/json; charset=utf-8\nContent-Length: length\n\n{\n "message": "client1 is not allowed to create the room at this time"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Prosody -> Client:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"\n \n \n \n client1 is not allowed to create the room at this time\n \n \n \n\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The application can use ",(0,s.jsx)(n.code,{children:"text"})," and ",(0,s.jsx)(n.code,{children:"reservation-error"})," elements to\nprovide meaningful information to the user."]}),"\n",(0,s.jsx)(n.h5,{id:"reading-conference-info",children:"Reading conference info"}),"\n",(0,s.jsxs)(n.p,{children:["In case of a ",(0,s.jsx)(n.code,{children:"409"})," response to the ",(0,s.jsx)(n.code,{children:"HTTP POST"})," request, Prosody will try\nto read information about the conflicting conference using an ",(0,s.jsx)(n.code,{children:"HTTP GET"}),"\n",(0,s.jsx)(n.code,{children:"/conference/{conflict_id}"})," endpoint. The response should provide all\ninformation about the conference stored in the reservation system:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"id"'}),": conference identifier assigned by the reservation system"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"name"'}),": conference room name"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"mail_owner"'}),": identity of the user who has created the conference"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"start_time"'}),": conference start date and time"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"duration"'}),": scheduled conference duration in seconds"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The optional ",(0,s.jsx)(n.code,{children:"max_occupants"})," value should also be provided if applicable."]}),"\n",(0,s.jsxs)(n.p,{children:["Sample response JSON body (contains the same info as ",(0,s.jsx)(n.code,{children:"200 OK"})," to\n",(0,s.jsx)(n.code,{children:"HTTP POST"}),"):"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "id": 364758328,\n "name": "conference1234",\n "mail_owner": "user@server.com",\n "start_time": "2048-04-20T17:55:12.000Z",\n "duration": 900000\n}\n'})}),"\n",(0,s.jsx)(n.h5,{id:"deleting-conference",children:"Deleting conference"}),"\n",(0,s.jsxs)(n.p,{children:["Prosody deletes conferences in the reservation system in two cases. First when\nall users leave XMPP Multi User Chat room. Secondly when the conference duration limit\nis exceeded. In the latter case Prosody will destroy the XMPP MUC room.\nAfter the MUC room is destroyed, Prosody sends an ",(0,s.jsx)(n.code,{children:"HTTP DELETE"})," request to\n",(0,s.jsx)(n.code,{children:"'/conference/{id}'"})," endpoint where ",(0,s.jsx)(n.code,{children:"{id}"})," is replaced with\nconference identifier assigned by the reservation system."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"DELETE /conference/364758328 HTTP/1.1\nhost: http://reservation.example.com\n...\n"})}),"\n",(0,s.jsx)(n.h4,{id:"implementation-diagram",children:"Implementation diagram"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/reservation-api.png",alt:""})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>c});var s=o(6540);const t={},r=s.createContext(t);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[1401],{5292:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=o(4848),t=o(8453);const r={id:"reservation",title:"Reservation System setup",sidebar_label:"Reservation System"},i=void 0,c={id:"devops-guide/reservation",title:"Reservation System setup",description:"Support for a reservation system over REST API",source:"@site/docs/devops-guide/reservation.md",sourceDirName:"devops-guide",slug:"/devops-guide/reservation",permalink:"/handbook/docs/devops-guide/reservation",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/reservation.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"reservation",title:"Reservation System setup",sidebar_label:"Reservation System"},sidebar:"docs",previous:{title:"Scalable setup",permalink:"/handbook/docs/devops-guide/devops-guide-scalable"},next:{title:"TURN setup",permalink:"/handbook/docs/devops-guide/turn"}},a={},l=[{value:"Support for a reservation system over REST API",id:"support-for-a-reservation-system-over-rest-api",level:3},{value:"Enable reservation system",id:"enable-reservation-system",level:4},{value:"Call flow",id:"call-flow",level:4},{value:"Notes",id:"notes",level:5},{value:"Conference allocation",id:"conference-allocation",level:5},{value:"HTTP 200 or 201 Conference created successfully",id:"http-200-or-201-conference-created-successfully",level:6},{value:"HTTP 409 - Conference already exists",id:"http-409---conference-already-exists",level:6},{value:"HTTP 4xx",id:"http-4xx",level:6},{value:"Reading conference info",id:"reading-conference-info",level:5},{value:"Deleting conference",id:"deleting-conference",level:5},{value:"Implementation diagram",id:"implementation-diagram",level:4}];function d(e){const n={a:"a",code:"code",h3:"h3",h4:"h4",h5:"h5",h6:"h6",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h3,{id:"support-for-a-reservation-system-over-rest-api",children:"Support for a reservation system over REST API"}),"\n",(0,s.jsx)(n.p,{children:"It is possible to connect to an external conference reservation system using a\nREST API. Before a new Jitsi Meet conference is created, the reservation system will be\nqueried for room availability. The system is supposed to return a positive or\nnegative response code, which also contains conference duration. Prosody will enforce\nconference duration and if the time limit is exceeded the conference will be\nterminated."}),"\n",(0,s.jsx)(n.h4,{id:"enable-reservation-system",children:"Enable reservation system"}),"\n",(0,s.jsxs)(n.p,{children:['In order to enable the reservation system, the URL base for the REST API endpoint must be\nconfigured. Under the main virtual host in prosody, enable module "reservations" and\nadd the config ',(0,s.jsx)(n.code,{children:"reservations_api_prefix"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'VirtualHost "jitmeet.example.com"\n -- ....\n modules_enabled = {\n -- ....\n "reservations";\n }\n reservations_api_prefix = "http://reservation.example.com"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["The URL base is used to construct the request URL. Currently, only ",(0,s.jsx)(n.code,{children:"'/conference'"}),"\nendpoint is supported, so all request will go to:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"http://reservation.example.com/conference\n"})}),"\n",(0,s.jsx)(n.p,{children:"Additional configuration options are available:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"reservations_api_timeout" to change API call timeouts (defaults to 20 seconds)'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_headers" to specify custom HTTP headers included in\nall API calls e.g. to provide auth tokens.'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_retry_count" to specify the number of times API call failures are retried (defaults to 3)'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_retry_delay" seconds to wait between retries (defaults to 3s)'}),"\n",(0,s.jsx)(n.li,{children:'"reservations_api_should_retry_for_code" as a function that takes an HTTP response code and\nreturns true if the API call should be retried. By default, retries are done for 5XX\nresponses. Timeouts are never retried, and HTTP call failures are always retried.'}),"\n",(0,s.jsxs)(n.li,{children:['"reservations_enable_max_occupants" to enable support for setting max occupants. If this is set to ',(0,s.jsx)(n.code,{children:"true"}),', and if\nthe API response payload includes a "max_occupants" value, then that value will be set as the max occupancy limit\nfor that specific room.',"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"muc_max_occupants" module must also be enabled for this to work.'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:['"reservations_enable_lobby_support" to enable support for lobby. If this is set to ',(0,s.jsx)(n.code,{children:"true"}),', and if\nthe API response payload includes a "lobby" field set to ',(0,s.jsx)(n.code,{children:"true"})," , then the lobby will be enabled for the room.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"muc_lobby_rooms" and "persistent_lobby" modules must also be enabled for this to work.'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:['"reservations_enable_password_support" to enable support for room password. If this is set to ',(0,s.jsx)(n.code,{children:"true"}),', and if\nthe API response payload includes a "password" value, then that value will be set as room password. Users will then\nbe required to know that password to be able to join the room, or in the case where lobby is enabled, can use the\npassword to bypass the lobby.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:' --- The following are all optional\n reservations_api_headers = {\n ["Authorization"] = "Bearer TOKEN-237958623045";\n }\n reservations_api_timeout = 10 -- timeout if API does not respond within 10s\n reservations_api_retry_count = 5 -- retry up to 5 times\n reservations_api_retry_delay = 1 -- wait 1s between retries\n reservations_api_should_retry_for_code = function (code)\n return code >= 500 or code == 408\n end\n reservations_enable_max_occupants = true -- enable integration with muc_max_occupants\n reservations_enable_lobby_support = true -- enable integration with muc_lobby_rooms\n reservations_enable_password_support = true -- enable support for setting room passwords\n'})}),"\n",(0,s.jsx)(n.h4,{id:"call-flow",children:"Call flow"}),"\n",(0,s.jsx)(n.h5,{id:"notes",children:"Notes"}),"\n",(0,s.jsx)(n.p,{children:"All API calls use the following datetime format:"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"yyyy-MM-dd'T'HH:mm:ss.SSSX"})," - more info can be found in\n",(0,s.jsx)(n.code,{children:"SimpleDateFormat"})," ",(0,s.jsx)(n.a,{href:"https://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html",children:"JavaDoc"})]}),"\n",(0,s.jsx)(n.h5,{id:"conference-allocation",children:"Conference allocation"}),"\n",(0,s.jsxs)(n.p,{children:["When the first user joins a MUC room (i.e. Jitsi Meet URL is opened), an ",(0,s.jsx)(n.code,{children:"HTTP POST"}),"\nrequest is sent to ",(0,s.jsx)(n.code,{children:"'/conference'"})," endpoint with the following parameters\nincluded:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"name (string)"})," - short name of the conference room (not full MUC address). If tenant is used, the name will be ",(0,s.jsx)(n.code,{children:"[tenant]roomname"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"start_time (string)"})," - conference start date and time"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mail_owner (string)"})," - if authentication system is enabled this field will\ncontain user's identity. It that case it will not be possible to create a new\nconference room without authenticating."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The payload sent to the endpoint will be encoded as ",(0,s.jsx)(n.code,{children:"application/x-www-form-urlencoded"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"The reservation system is expected to respond with one of the following\nresponses:"}),"\n",(0,s.jsx)(n.h6,{id:"http-200-or-201-conference-created-successfully",children:"HTTP 200 or 201 Conference created successfully"}),"\n",(0,s.jsxs)(n.p,{children:["In the HTTP response, a JSON object is expected. It should contain conference ",(0,s.jsx)(n.code,{children:"id"}),"\nassigned by the system and ",(0,s.jsx)(n.code,{children:"duration"})," measured in seconds. Sample response body:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "id": 364758328,\n "name": "conference1234",\n "mail_owner": "user@server.com",\n "start_time": "2048-04-20T17:55:12.000Z",\n "duration": 900000\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:["The object can optionally include a ",(0,s.jsx)(n.code,{children:"max_occupants"})," key with an integer value. When provided, and if\n",(0,s.jsx)(n.code,{children:"reservations_enable_max_occupants"})," is enabled, then the value will be passed to muc_mod_max_occupants to enforce\nper-room occupancy limits."]}),"\n",(0,s.jsx)(n.h6,{id:"http-409---conference-already-exists",children:"HTTP 409 - Conference already exists"}),"\n",(0,s.jsxs)(n.p,{children:["This is to recover from previous failures. If for some reason the conference was\nrestarted and the user tries to create the room again, this response informs Prosody\nthat the conference room already exists. It is expected to contain\n",(0,s.jsx)(n.code,{children:"conflict_id"})," in the JSON response body:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "conflict_id": 364758328\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Prosody will use ",(0,s.jsx)(n.code,{children:"HTTP GET"})," to fetch information about the conflicting conference for the\ngiven ",(0,s.jsx)(n.code,{children:"conflict_id"}),'. More info about this request can be found in the "Reading conference info"\nsection.']}),"\n",(0,s.jsx)(n.h6,{id:"http-4xx",children:"HTTP 4xx"}),"\n",(0,s.jsxs)(n.p,{children:["Other response codes will cause conference creation failure. The JSON response\ncan contain a ",(0,s.jsx)(n.code,{children:"message"})," object which will be sent back to the client."]}),"\n",(0,s.jsxs)(n.p,{children:["For example ",(0,s.jsx)(n.code,{children:"user1"})," tries to start a new conference by sending\n",(0,s.jsx)(n.code,{children:"conference"})," IQ to Jicofo. The system will reject the request."]}),"\n",(0,s.jsx)(n.p,{children:"Client -> Jicofo:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"\n \n\n"})}),"\n",(0,s.jsx)(n.p,{children:"Prosody -> Reservation system:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"POST /conference HTTP/1.1\ncontent-type:application/x-www-form-urlencoded;charset=utf-8\nhost: http://reservation.example.com\ncontent-length: length\n\nname=testroom1&start_time=2048-04-20T17%3A55%3A12.000Z&mail_owner=client1%40xmpp.com\n"})}),"\n",(0,s.jsx)(n.p,{children:"Reservation system -> Prosody:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'HTTP/1.1 403 Forbidden\nContent-Type: application/json; charset=utf-8\nContent-Length: length\n\n{\n "message": "client1 is not allowed to create the room at this time"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Prosody -> Client:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"\n \n \n \n client1 is not allowed to create the room at this time\n \n \n \n\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The application can use ",(0,s.jsx)(n.code,{children:"text"})," and ",(0,s.jsx)(n.code,{children:"reservation-error"})," elements to\nprovide meaningful information to the user."]}),"\n",(0,s.jsx)(n.h5,{id:"reading-conference-info",children:"Reading conference info"}),"\n",(0,s.jsxs)(n.p,{children:["In case of a ",(0,s.jsx)(n.code,{children:"409"})," response to the ",(0,s.jsx)(n.code,{children:"HTTP POST"})," request, Prosody will try\nto read information about the conflicting conference using an ",(0,s.jsx)(n.code,{children:"HTTP GET"}),"\n",(0,s.jsx)(n.code,{children:"/conference/{conflict_id}"})," endpoint. The response should provide all\ninformation about the conference stored in the reservation system:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"id"'}),": conference identifier assigned by the reservation system"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"name"'}),": conference room name"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"mail_owner"'}),": identity of the user who has created the conference"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"start_time"'}),": conference start date and time"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:'"duration"'}),": scheduled conference duration in seconds"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The optional ",(0,s.jsx)(n.code,{children:"max_occupants"})," value should also be provided if applicable."]}),"\n",(0,s.jsxs)(n.p,{children:["Sample response JSON body (contains the same info as ",(0,s.jsx)(n.code,{children:"200 OK"})," to\n",(0,s.jsx)(n.code,{children:"HTTP POST"}),"):"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "id": 364758328,\n "name": "conference1234",\n "mail_owner": "user@server.com",\n "start_time": "2048-04-20T17:55:12.000Z",\n "duration": 900000\n}\n'})}),"\n",(0,s.jsx)(n.h5,{id:"deleting-conference",children:"Deleting conference"}),"\n",(0,s.jsxs)(n.p,{children:["Prosody deletes conferences in the reservation system in two cases. First when\nall users leave XMPP Multi User Chat room. Secondly when the conference duration limit\nis exceeded. In the latter case Prosody will destroy the XMPP MUC room.\nAfter the MUC room is destroyed, Prosody sends an ",(0,s.jsx)(n.code,{children:"HTTP DELETE"})," request to\n",(0,s.jsx)(n.code,{children:"'/conference/{id}'"})," endpoint where ",(0,s.jsx)(n.code,{children:"{id}"})," is replaced with\nconference identifier assigned by the reservation system."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"DELETE /conference/364758328 HTTP/1.1\nhost: http://reservation.example.com\n...\n"})}),"\n",(0,s.jsx)(n.h4,{id:"implementation-diagram",children:"Implementation diagram"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/reservation-api.png",alt:""})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>c});var s=o(6540);const t={},r=s.createContext(t);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5281b7a2.bc1588ba.js b/assets/js/5281b7a2.8795a892.js similarity index 99% rename from assets/js/5281b7a2.bc1588ba.js rename to assets/js/5281b7a2.8795a892.js index 44e8f94be..8e7d8f2aa 100644 --- a/assets/js/5281b7a2.bc1588ba.js +++ b/assets/js/5281b7a2.8795a892.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2443],{8798:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>h});var i=n(4848),s=n(8453);const o={id:"architecture",title:"Architecture"},r=void 0,a={id:"architecture",title:"Architecture",description:"In this section, a global overview of the Jitsi infrastructure is provided. If you just started contributing to the project, we highly recommend reading this section thoroughly.",source:"@site/docs/architecture.md",sourceDirName:".",slug:"/architecture",permalink:"/handbook/docs/architecture",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/architecture.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"architecture",title:"Architecture"},sidebar:"docs",previous:{title:"Introduction",permalink:"/handbook/docs/intro"},next:{title:"Security",permalink:"/handbook/docs/security"}},c={},h=[{value:"Components",id:"components",level:2},{value:"Architecture Diagram",id:"architecture-diagram",level:2},{value:"Code Map",id:"code-map",level:2},{value:"Testing",id:"testing",level:2}];function d(e){const t={a:"a",code:"code",h2:"h2",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"In this section, a global overview of the Jitsi infrastructure is provided. If you just started contributing to the project, we highly recommend reading this section thoroughly."}),"\n",(0,i.jsx)(t.h2,{id:"components",children:"Components"}),"\n",(0,i.jsxs)(t.p,{children:["Jitsi comprises a ",(0,i.jsx)(t.a,{href:"https://jitsi.org/projects/",children:"collection of projects"}),":"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://jitsi.org/jitsi-meet",children:"Jitsi Meet"})," - WebRTC compatible JavaScript application that uses Jitsi Videobridge to provide high-quality, scalable video conferences. Build upon React and React Native."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://jitsi.org/jitsi-videobridge",children:"Jitsi Videobridge (JVB)"})," - WebRTC compatible server designed to route video streams amongst participants in a conference."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jicofo",children:"Jitsi Conference Focus (jicofo)"})," - server-side focus component used in Jitsi Meet conferences that manages media sessions and acts as a load balancer between each of the participants and the videobridge."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jigasi",children:"Jitsi Gateway to SIP (jigasi)"})," - server-side application that allows regular SIP clients to join Jitsi Meet conferences"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jibri",children:"Jitsi Broadcasting Infrastructure (jibri)"})," - set of tools for recording and/or streaming a Jitsi Meet conference that works by launching a Chrome instance rendered in a virtual framebuffer and capturing and encoding the output with ffmpeg."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"External Software used by Jitsi:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://prosody.im/",children:"Prosody"})," - XMPP server used for signalling"]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"architecture-diagram",children:"Architecture Diagram"}),"\n",(0,i.jsx)(t.p,{children:"The individual connections between the previously described components, as well as their external integrations are described in the figure below."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/ArchitectureDiagram.png",alt:""})}),"\n",(0,i.jsx)(t.p,{children:"The external connections can be categorized into two main groups. Firstly, the connections between clients that request a video or audio connection are performed through remote requests and data streams. The second category of external connections is those to external services that help store recordings, stream recordings, stream videos, or help with creating meetings."}),"\n",(0,i.jsx)(t.h2,{id:"code-map",children:"Code Map"}),"\n",(0,i.jsx)(t.p,{children:"In this section, we will look at the main parts of the codebase and see what they can be used for."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./react/features"}),"\nThis folder is where it is best to start writing your code, as it contains most of the app components that are used in the apps on Android and iOS, as well as on the web version. This source folder is split up into all the different features that Jitsi has to offer, such as authentication, chat interaction, keyboard shortcuts, screenshot capture, remote control, and virtual background. Each of these features has a folder in this map, which is then again split up to keep a hierarchy and consistency throughout the code."]}),"\n",(0,i.jsx)(t.p,{children:"Each feature folder consists of a subfolder called components, in this folder all of the React, or React Native for mobile, components are expressed. Usually, in this folder there will be a separation between native and web components, however, in some cases, the same component could be used for both Android, iOS, and web browsers, in which case there is no separation made."}),"\n",(0,i.jsx)(t.p,{children:"As stated before, the codebase mostly consists of React and React Native, which is the React version for mobile applications. Most of the features make use of the so-called class component by React [^class-comp], however, some new features start to use the new way to write functional components by using hooks[^func-comp]."}),"\n",(0,i.jsx)(t.p,{children:"The application makes use of React Redux as well, this is used as a general state store to keep track of important parameters that are used throughout the application. More on React Redux can be found here [^react-redux]."}),"\n",(0,i.jsxs)(t.p,{children:["Most features also contain a file called ",(0,i.jsx)(t.code,{children:"middleware.js"}),". This file acts as a bridge between the component and the functionality of the rest of the application."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./modules/external-api"}),"\nIn this folder, the external API can be found. This API can be used in various events like participants joining/leaving the meeting, changes in avatars or chat, as well as errors in using the microphone or camera."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./android and ./ios"}),"\nBoth of these folders contain the basics of the Android and iOS apps respectively. However, the code for the application itself and its components can be found in the ",(0,i.jsx)(t.strong,{children:"react/features"})," folder, which is explained earlier in this section."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./conference.js"}),"\nThis file can be found at the root of the project and contains the foundation of any interaction between a user and a conference room. This consists of setting up a connection to it, joining the meeting room, muting and unmuting, but also functions to gather information about the participants that are in the room."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./lang"}),"\nThis folder contains all the different translations that are present in Jitsi Meet. The translations can be found in the code with each of the keys in the translation maps that can be found in the ",(0,i.jsx)(t.code,{children:"main-[language].json"})," files."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./css"}),"\nThis folder contains all the CSS that is used in the project. The files (mostly .scss files[^scss]) are split up into features like the React features that they are used in."]}),"\n",(0,i.jsx)(t.h2,{id:"testing",children:"Testing"}),"\n",(0,i.jsx)(t.p,{children:"The main form of testing code changes is done through torture tests, next to this the code is tested manually."}),"\n",(0,i.jsxs)(t.p,{children:["The torture tests are located in a separate repository, ",(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-torture",children:"Jitsi Meet Torture"}),". The project contains end-to-end tests for several key functions such as peer-to-peer and invites. The testing can be done for iOS, Android, and the web, which are all the platforms that Jitsi Meet can be used on. The testing is done automatically for pull requests by project members, where it is used in combination with the continuous integration by a Jenkins instance running the tests, testing on the ",(0,i.jsx)(t.a,{href:"https://meet.jit.si",children:"meet.jit.si"})," instance. Other members can run the tests locally. The test results can be viewed on an automatically generated web page."]}),"\n",(0,i.jsxs)(t.p,{children:["Manual testing is performed while doing code reviews, however, there are also testing releases that can be freely downloaded and deployed or can be used on the ",(0,i.jsx)(t.a,{href:"https://beta.meet.jit.si/",children:"beta test server"}),"."]})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var i=n(6540);const s={},o=i.createContext(s);function r(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2443],{8798:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>h});var i=n(4848),s=n(8453);const o={id:"architecture",title:"Architecture"},r=void 0,a={id:"architecture",title:"Architecture",description:"In this section, a global overview of the Jitsi infrastructure is provided. If you just started contributing to the project, we highly recommend reading this section thoroughly.",source:"@site/docs/architecture.md",sourceDirName:".",slug:"/architecture",permalink:"/handbook/docs/architecture",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/architecture.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"architecture",title:"Architecture"},sidebar:"docs",previous:{title:"Introduction",permalink:"/handbook/docs/intro"},next:{title:"Security",permalink:"/handbook/docs/security"}},c={},h=[{value:"Components",id:"components",level:2},{value:"Architecture Diagram",id:"architecture-diagram",level:2},{value:"Code Map",id:"code-map",level:2},{value:"Testing",id:"testing",level:2}];function d(e){const t={a:"a",code:"code",h2:"h2",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"In this section, a global overview of the Jitsi infrastructure is provided. If you just started contributing to the project, we highly recommend reading this section thoroughly."}),"\n",(0,i.jsx)(t.h2,{id:"components",children:"Components"}),"\n",(0,i.jsxs)(t.p,{children:["Jitsi comprises a ",(0,i.jsx)(t.a,{href:"https://jitsi.org/projects/",children:"collection of projects"}),":"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://jitsi.org/jitsi-meet",children:"Jitsi Meet"})," - WebRTC compatible JavaScript application that uses Jitsi Videobridge to provide high-quality, scalable video conferences. Build upon React and React Native."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://jitsi.org/jitsi-videobridge",children:"Jitsi Videobridge (JVB)"})," - WebRTC compatible server designed to route video streams amongst participants in a conference."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jicofo",children:"Jitsi Conference Focus (jicofo)"})," - server-side focus component used in Jitsi Meet conferences that manages media sessions and acts as a load balancer between each of the participants and the videobridge."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jigasi",children:"Jitsi Gateway to SIP (jigasi)"})," - server-side application that allows regular SIP clients to join Jitsi Meet conferences"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jibri",children:"Jitsi Broadcasting Infrastructure (jibri)"})," - set of tools for recording and/or streaming a Jitsi Meet conference that works by launching a Chrome instance rendered in a virtual framebuffer and capturing and encoding the output with ffmpeg."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"External Software used by Jitsi:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://prosody.im/",children:"Prosody"})," - XMPP server used for signalling"]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"architecture-diagram",children:"Architecture Diagram"}),"\n",(0,i.jsx)(t.p,{children:"The individual connections between the previously described components, as well as their external integrations are described in the figure below."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/ArchitectureDiagram.png",alt:""})}),"\n",(0,i.jsx)(t.p,{children:"The external connections can be categorized into two main groups. Firstly, the connections between clients that request a video or audio connection are performed through remote requests and data streams. The second category of external connections is those to external services that help store recordings, stream recordings, stream videos, or help with creating meetings."}),"\n",(0,i.jsx)(t.h2,{id:"code-map",children:"Code Map"}),"\n",(0,i.jsx)(t.p,{children:"In this section, we will look at the main parts of the codebase and see what they can be used for."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./react/features"}),"\nThis folder is where it is best to start writing your code, as it contains most of the app components that are used in the apps on Android and iOS, as well as on the web version. This source folder is split up into all the different features that Jitsi has to offer, such as authentication, chat interaction, keyboard shortcuts, screenshot capture, remote control, and virtual background. Each of these features has a folder in this map, which is then again split up to keep a hierarchy and consistency throughout the code."]}),"\n",(0,i.jsx)(t.p,{children:"Each feature folder consists of a subfolder called components, in this folder all of the React, or React Native for mobile, components are expressed. Usually, in this folder there will be a separation between native and web components, however, in some cases, the same component could be used for both Android, iOS, and web browsers, in which case there is no separation made."}),"\n",(0,i.jsx)(t.p,{children:"As stated before, the codebase mostly consists of React and React Native, which is the React version for mobile applications. Most of the features make use of the so-called class component by React [^class-comp], however, some new features start to use the new way to write functional components by using hooks[^func-comp]."}),"\n",(0,i.jsx)(t.p,{children:"The application makes use of React Redux as well, this is used as a general state store to keep track of important parameters that are used throughout the application. More on React Redux can be found here [^react-redux]."}),"\n",(0,i.jsxs)(t.p,{children:["Most features also contain a file called ",(0,i.jsx)(t.code,{children:"middleware.js"}),". This file acts as a bridge between the component and the functionality of the rest of the application."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./modules/external-api"}),"\nIn this folder, the external API can be found. This API can be used in various events like participants joining/leaving the meeting, changes in avatars or chat, as well as errors in using the microphone or camera."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./android and ./ios"}),"\nBoth of these folders contain the basics of the Android and iOS apps respectively. However, the code for the application itself and its components can be found in the ",(0,i.jsx)(t.strong,{children:"react/features"})," folder, which is explained earlier in this section."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./conference.js"}),"\nThis file can be found at the root of the project and contains the foundation of any interaction between a user and a conference room. This consists of setting up a connection to it, joining the meeting room, muting and unmuting, but also functions to gather information about the participants that are in the room."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./lang"}),"\nThis folder contains all the different translations that are present in Jitsi Meet. The translations can be found in the code with each of the keys in the translation maps that can be found in the ",(0,i.jsx)(t.code,{children:"main-[language].json"})," files."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"./css"}),"\nThis folder contains all the CSS that is used in the project. The files (mostly .scss files[^scss]) are split up into features like the React features that they are used in."]}),"\n",(0,i.jsx)(t.h2,{id:"testing",children:"Testing"}),"\n",(0,i.jsx)(t.p,{children:"The main form of testing code changes is done through torture tests, next to this the code is tested manually."}),"\n",(0,i.jsxs)(t.p,{children:["The torture tests are located in a separate repository, ",(0,i.jsx)(t.a,{href:"https://github.com/jitsi/jitsi-meet-torture",children:"Jitsi Meet Torture"}),". The project contains end-to-end tests for several key functions such as peer-to-peer and invites. The testing can be done for iOS, Android, and the web, which are all the platforms that Jitsi Meet can be used on. The testing is done automatically for pull requests by project members, where it is used in combination with the continuous integration by a Jenkins instance running the tests, testing on the ",(0,i.jsx)(t.a,{href:"https://meet.jit.si",children:"meet.jit.si"})," instance. Other members can run the tests locally. The test results can be viewed on an automatically generated web page."]}),"\n",(0,i.jsxs)(t.p,{children:["Manual testing is performed while doing code reviews, however, there are also testing releases that can be freely downloaded and deployed or can be used on the ",(0,i.jsx)(t.a,{href:"https://beta.meet.jit.si/",children:"beta test server"}),"."]})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var i=n(6540);const s={},o=i.createContext(s);function r(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/53784768.e96cf7d4.js b/assets/js/53784768.fa157c13.js similarity index 98% rename from assets/js/53784768.e96cf7d4.js rename to assets/js/53784768.fa157c13.js index 1aac5885e..87a33a816 100644 --- a/assets/js/53784768.e96cf7d4.js +++ b/assets/js/53784768.fa157c13.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2703],{6356:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=s(4848),t=s(8453);const r={id:"devops-guide-requirements",title:"Requirements"},o="Jitsi Meet needs, by order of importance",a={id:"devops-guide/devops-guide-requirements",title:"Requirements",description:"Jitsi Meet is a real-time system.",source:"@site/docs/devops-guide/requirements.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-requirements",permalink:"/handbook/docs/devops-guide/devops-guide-requirements",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/requirements.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"devops-guide-requirements",title:"Requirements"},sidebar:"docs",previous:{title:"Deployment",permalink:"/handbook/docs/category/deployment"},next:{title:"Debian/Ubuntu server",permalink:"/handbook/docs/devops-guide/devops-guide-quickstart"}},d={},c=[];function l(e){const n={admonition:"admonition",code:"code",h1:"h1",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.admonition,{type:"note",children:[(0,i.jsx)(n.p,{children:"Jitsi Meet is a real-time system.\nRequirements are very different from a web server and depend on many factors.\nMiscalculations can very easily destroy basic functionality rather than cause slow performance.\nAvoid adding other functions to your Jitsi Meet setup as it can harm performance and complicate optimizations."}),(0,i.jsx)(n.p,{children:"Note that Jitsi Meet design priorizes scalability by adding servers on using a huge server. Check Jitsi-videobridge documentation on adding several bridges to a Jitsi Meet server, and OCTO to go even beyond that (federation of Jitsi Meet servers). If you feel that you are a network and server administration newbie, don't even think of going there."})]}),"\n",(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"jitsi-meet-needs-by-order-of-importance",children:"Jitsi Meet needs, by order of importance"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Network link: basic speed and reliability are essential. Check speed against the provider claims using any download tool (or ftp), and\nverify latency using a tool such as iperf3.\nExact calculation is very complex and depend on many optimisations and tricks, but you should at least remember these numbers on resolution:\n180 = 200 kbits/s\n360 = 500 kbits/s\n720 (HD) = 2500 kbits/s\n4k = 10 Mbits/s\nSo don't expect to have 20 users using 4K on a server with 100Mbits/s upload and download.\nFor a friends/small organization server, 1 Gbits/s will often be enough but for a serious server 10 Gbits/s\nis advisable. Several (or many...) bridges having each a 10 Gbits/s link are used by big deployments."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"These requirements concern the videobridge. If there are only external videobridges (as can be the case on high end Jitsi Meet servers), network performance matters much less."})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RAM:"})," it's usually suggested to get 8 GB.\nFor small meetings you can get away with 4 GB, for test servers or very small meetings you can try to use 2 GB.\nFor big meetings it's suggested to go the scalable way over getting huge amounts of memory."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CPU:"})," very low processor performance can seriously harm a real time system, especially when using a shared server (where your CPU performance can be stolen by other customers of your hoster, check on 'dedicated CPU' if you are getting a VPS, rather than a physical server). However, a consideration is that a Jitsi Meet component, Prosody, can only use ONE (1) core. So getting a lot of cores, let's say more than 32, is not always useful. For a basic server, 4 dedicated cores can be enough."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Disk:"})," unless you are doing heavy logging or have very specific needs, you can get away with 20 Gbytes of standard hard disk.\nSSD are more a nice to have than a necessity."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"If you want additional services, requirements can go up."})}),"\n",(0,i.jsx)(n.h1,{id:"recording",children:"Recording"}),"\n",(0,i.jsx)(n.p,{children:"Jibri needs ONE system per recording.\nOne Jibri instance = one meeting. For 5 meetings recorded simultaneously, you need 5 Jibris.\nThere is no workaround to that.\nIf you are knowledgeable, you can setup Jibris in containers and use a big server to save a bit on resources but that's about it."}),"\n",(0,i.jsxs)(n.p,{children:["Jibri RAM, CPU and hard disk needs are far higher than Jitsi Meet itself, as it does video encoding.\nFor ",(0,i.jsx)(n.code,{children:"1080x720"})," you currently need at least 8 GB RAM, for ",(0,i.jsx)(n.code,{children:"1280x1024"})," 12 GB (this is for recording a ",(0,i.jsx)(n.strong,{children:"single"})," meeting).\nFor cloud storage you will need at least SSD drives.\nIf memory is not sufficient, CPU can't encode fast enough or hard disk is not fast enough, recordings will fail."]}),"\n",(0,i.jsx)(n.p,{children:"While Jibri and Jitsi Meet can technically be hosted in a single server, it's not recommended because Jibri is a resource drain and it can harm Jitsi Meet performance, and can exhaust disk space and stop Jitsi Meet function altogether."})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var i=s(6540);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2703],{6356:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=s(4848),t=s(8453);const r={id:"devops-guide-requirements",title:"Requirements"},o="Jitsi Meet needs, by order of importance",a={id:"devops-guide/devops-guide-requirements",title:"Requirements",description:"Jitsi Meet is a real-time system.",source:"@site/docs/devops-guide/requirements.md",sourceDirName:"devops-guide",slug:"/devops-guide/devops-guide-requirements",permalink:"/handbook/docs/devops-guide/devops-guide-requirements",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/devops-guide/requirements.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"devops-guide-requirements",title:"Requirements"},sidebar:"docs",previous:{title:"Deployment",permalink:"/handbook/docs/category/deployment"},next:{title:"Debian/Ubuntu server",permalink:"/handbook/docs/devops-guide/devops-guide-quickstart"}},d={},c=[];function l(e){const n={admonition:"admonition",code:"code",h1:"h1",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.admonition,{type:"note",children:[(0,i.jsx)(n.p,{children:"Jitsi Meet is a real-time system.\nRequirements are very different from a web server and depend on many factors.\nMiscalculations can very easily destroy basic functionality rather than cause slow performance.\nAvoid adding other functions to your Jitsi Meet setup as it can harm performance and complicate optimizations."}),(0,i.jsx)(n.p,{children:"Note that Jitsi Meet design priorizes scalability by adding servers on using a huge server. Check Jitsi-videobridge documentation on adding several bridges to a Jitsi Meet server, and OCTO to go even beyond that (federation of Jitsi Meet servers). If you feel that you are a network and server administration newbie, don't even think of going there."})]}),"\n",(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"jitsi-meet-needs-by-order-of-importance",children:"Jitsi Meet needs, by order of importance"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Network link: basic speed and reliability are essential. Check speed against the provider claims using any download tool (or ftp), and\nverify latency using a tool such as iperf3.\nExact calculation is very complex and depend on many optimisations and tricks, but you should at least remember these numbers on resolution:\n180 = 200 kbits/s\n360 = 500 kbits/s\n720 (HD) = 2500 kbits/s\n4k = 10 Mbits/s\nSo don't expect to have 20 users using 4K on a server with 100Mbits/s upload and download.\nFor a friends/small organization server, 1 Gbits/s will often be enough but for a serious server 10 Gbits/s\nis advisable. Several (or many...) bridges having each a 10 Gbits/s link are used by big deployments."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"These requirements concern the videobridge. If there are only external videobridges (as can be the case on high end Jitsi Meet servers), network performance matters much less."})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RAM:"})," it's usually suggested to get 8 GB.\nFor small meetings you can get away with 4 GB, for test servers or very small meetings you can try to use 2 GB.\nFor big meetings it's suggested to go the scalable way over getting huge amounts of memory."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CPU:"})," very low processor performance can seriously harm a real time system, especially when using a shared server (where your CPU performance can be stolen by other customers of your hoster, check on 'dedicated CPU' if you are getting a VPS, rather than a physical server). However, a consideration is that a Jitsi Meet component, Prosody, can only use ONE (1) core. So getting a lot of cores, let's say more than 32, is not always useful. For a basic server, 4 dedicated cores can be enough."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Disk:"})," unless you are doing heavy logging or have very specific needs, you can get away with 20 Gbytes of standard hard disk.\nSSD are more a nice to have than a necessity."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"If you want additional services, requirements can go up."})}),"\n",(0,i.jsx)(n.h1,{id:"recording",children:"Recording"}),"\n",(0,i.jsx)(n.p,{children:"Jibri needs ONE system per recording.\nOne Jibri instance = one meeting. For 5 meetings recorded simultaneously, you need 5 Jibris.\nThere is no workaround to that.\nIf you are knowledgeable, you can setup Jibris in containers and use a big server to save a bit on resources but that's about it."}),"\n",(0,i.jsxs)(n.p,{children:["Jibri RAM, CPU and hard disk needs are far higher than Jitsi Meet itself, as it does video encoding.\nFor ",(0,i.jsx)(n.code,{children:"1080x720"})," you currently need at least 8 GB RAM, for ",(0,i.jsx)(n.code,{children:"1280x1024"})," 12 GB (this is for recording a ",(0,i.jsx)(n.strong,{children:"single"})," meeting).\nFor cloud storage you will need at least SSD drives.\nIf memory is not sufficient, CPU can't encode fast enough or hard disk is not fast enough, recordings will fail."]}),"\n",(0,i.jsx)(n.p,{children:"While Jibri and Jitsi Meet can technically be hosted in a single server, it's not recommended because Jibri is a resource drain and it can harm Jitsi Meet performance, and can exhaust disk space and stop Jitsi Meet function altogether."})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var i=s(6540);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/53c36cd9.d20adeb8.js b/assets/js/53c36cd9.28305e6f.js similarity index 96% rename from assets/js/53c36cd9.d20adeb8.js rename to assets/js/53c36cd9.28305e6f.js index 8c1accfb9..343932245 100644 --- a/assets/js/53c36cd9.d20adeb8.js +++ b/assets/js/53c36cd9.28305e6f.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3757],{316:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>a,contentTitle:()=>n,default:()=>c,frontMatter:()=>s,metadata:()=>d,toc:()=>u});var i=o(4848),r=o(8453);const s={id:"user-guide-jitsi-meet-for-google-calendar",title:"Jitsi Meet for Google Calendar",sidebar_label:"Jitsi Meet for Google Calendar"},n=void 0,d={id:"user-guide/user-guide-jitsi-meet-for-google-calendar",title:"Jitsi Meet for Google Calendar",description:"Welcome to the user guide!",source:"@site/docs/user-guide/jitsi-meet-for-google-calendar.md",sourceDirName:"user-guide",slug:"/user-guide/user-guide-jitsi-meet-for-google-calendar",permalink:"/handbook/docs/user-guide/user-guide-jitsi-meet-for-google-calendar",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/jitsi-meet-for-google-calendar.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"user-guide-jitsi-meet-for-google-calendar",title:"Jitsi Meet for Google Calendar",sidebar_label:"Jitsi Meet for Google Calendar"},sidebar:"docs",previous:{title:"Use Jitsi Meet on Mobile",permalink:"/handbook/docs/user-guide/user-guide-jitsi-meet-on-mobile"},next:{title:"Keyboard shortcuts",permalink:"/handbook/docs/user-guide/keyboard-shortcuts"}},a={},u=[];function l(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"Welcome to the user guide!"}),"\n",(0,i.jsx)(t.p,{children:"Check back soon!"})]})}function c(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>n,x:()=>d});var i=o(6540);const r={},s=i.createContext(r);function n(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:n(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[3757],{316:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>a,contentTitle:()=>n,default:()=>c,frontMatter:()=>s,metadata:()=>d,toc:()=>u});var i=o(4848),r=o(8453);const s={id:"user-guide-jitsi-meet-for-google-calendar",title:"Jitsi Meet for Google Calendar",sidebar_label:"Jitsi Meet for Google Calendar"},n=void 0,d={id:"user-guide/user-guide-jitsi-meet-for-google-calendar",title:"Jitsi Meet for Google Calendar",description:"Welcome to the user guide!",source:"@site/docs/user-guide/jitsi-meet-for-google-calendar.md",sourceDirName:"user-guide",slug:"/user-guide/user-guide-jitsi-meet-for-google-calendar",permalink:"/handbook/docs/user-guide/user-guide-jitsi-meet-for-google-calendar",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/jitsi-meet-for-google-calendar.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"user-guide-jitsi-meet-for-google-calendar",title:"Jitsi Meet for Google Calendar",sidebar_label:"Jitsi Meet for Google Calendar"},sidebar:"docs",previous:{title:"Use Jitsi Meet on Mobile",permalink:"/handbook/docs/user-guide/user-guide-jitsi-meet-on-mobile"},next:{title:"Keyboard shortcuts",permalink:"/handbook/docs/user-guide/keyboard-shortcuts"}},a={},u=[];function l(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"Welcome to the user guide!"}),"\n",(0,i.jsx)(t.p,{children:"Check back soon!"})]})}function c(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>n,x:()=>d});var i=o(6540);const r={},s=i.createContext(r);function n(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:n(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/53d3d234.fb6a2dc7.js b/assets/js/53d3d234.0cc9cfef.js similarity index 99% rename from assets/js/53d3d234.fb6a2dc7.js rename to assets/js/53d3d234.0cc9cfef.js index c3947f745..1eeede7ae 100644 --- a/assets/js/53d3d234.fb6a2dc7.js +++ b/assets/js/53d3d234.0cc9cfef.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[4955],{3966:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(4848),a=i(8453);const r={id:"dev-guide-iframe-events",title:"Events"},s=void 0,o={id:"dev-guide/dev-guide-iframe-events",title:"Events",description:"The JitsiMeetExternalAPI object implements the [EventEmitter] API for emitting and listening for events.",source:"@site/docs/dev-guide/iframe-events.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-iframe-events",permalink:"/handbook/docs/dev-guide/dev-guide-iframe-events",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/iframe-events.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"dev-guide-iframe-events",title:"Events"},sidebar:"docs",previous:{title:"Commands",permalink:"/handbook/docs/dev-guide/dev-guide-iframe-commands"},next:{title:"React SDK",permalink:"/handbook/docs/dev-guide/dev-guide-react-sdk"}},c={},d=[{value:"cameraError",id:"cameraerror",level:3},{value:"avatarChanged",id:"avatarchanged",level:3},{value:"audioAvailabilityChanged",id:"audioavailabilitychanged",level:3},{value:"audioMuteStatusChanged",id:"audiomutestatuschanged",level:3},{value:"breakoutRoomsUpdated",id:"breakoutroomsupdated",level:3},{value:"browserSupport",id:"browsersupport",level:3},{value:"contentSharingParticipantsChanged",id:"contentsharingparticipantschanged",level:3},{value:"dataChannelOpened",id:"datachannelopened",level:3},{value:"endpointTextMessageReceived",id:"endpointtextmessagereceived",level:3},{value:"nonParticipantMessageReceived",id:"nonparticipantmessagereceived",level:3},{value:"faceLandmarkDetected",id:"facelandmarkdetected",level:3},{value:"errorOccurred",id:"erroroccurred",level:3},{value:"knockingParticipant",id:"knockingparticipant",level:3},{value:"largeVideoChanged",id:"largevideochanged",level:3},{value:"log",id:"log",level:3},{value:"micError",id:"micerror",level:3},{value:"screenSharingStatusChanged",id:"screensharingstatuschanged",level:3},{value:"dominantSpeakerChanged",id:"dominantspeakerchanged",level:3},{value:"raiseHandUpdated",id:"raisehandupdated",level:3},{value:"tileViewChanged",id:"tileviewchanged",level:3},{value:"chatUpdated",id:"chatupdated",level:3},{value:"incomingMessage",id:"incomingmessage",level:3},{value:"mouseEnter",id:"mouseenter",level:3},{value:"mouseLeave",id:"mouseleave",level:3},{value:"mouseMove",id:"mousemove",level:3},{value:"participantMenuButtonClick",id:"participantmenubuttonclick",level:3},{value:"toolbarButtonClicked",id:"toolbarbuttonclicked",level:3},{value:"outgoingMessage",id:"outgoingmessage",level:3},{value:"displayNameChange",id:"displaynamechange",level:3},{value:"deviceListChanged",id:"devicelistchanged",level:3},{value:"emailChange",id:"emailchange",level:3},{value:"feedbackSubmitted",id:"feedbacksubmitted",level:3},{value:"filmstripDisplayChanged",id:"filmstripdisplaychanged",level:3},{value:"moderationStatusChanged",id:"moderationstatuschanged",level:3},{value:"moderationParticipantApproved",id:"moderationparticipantapproved",level:3},{value:"moderationParticipantRejected",id:"moderationparticipantrejected",level:3},{value:"notificationTriggered",id:"notificationtriggered",level:3},{value:"participantJoined",id:"participantjoined",level:3},{value:"participantKickedOut",id:"participantkickedout",level:3},{value:"participantLeft",id:"participantleft",level:3},{value:"participantRoleChanged",id:"participantrolechanged",level:3},{value:"participantsPaneToggled",id:"participantspanetoggled",level:3},{value:"passwordRequired",id:"passwordrequired",level:3},{value:"videoConferenceJoined",id:"videoconferencejoined",level:3},{value:"videoConferenceLeft",id:"videoconferenceleft",level:3},{value:"conferenceCreatedTimestamp",id:"conferencecreatedtimestamp",level:3},{value:"videoAvailabilityChanged",id:"videoavailabilitychanged",level:3},{value:"videoMuteStatusChanged",id:"videomutestatuschanged",level:3},{value:"videoQualityChanged",id:"videoqualitychanged",level:3},{value:"readyToClose",id:"readytoclose",level:3},{value:"recordingLinkAvailable",id:"recordinglinkavailable",level:3},{value:"recordingStatusChanged",id:"recordingstatuschanged",level:3},{value:"subjectChange",id:"subjectchange",level:3},{value:"suspendDetected",id:"suspenddetected",level:3},{value:"peerConnectionFailure",id:"peerconnectionfailure",level:3},{value:"transcribingStatusChanged",id:"transcribingstatuschanged",level:3},{value:"transcriptionChunkReceived",id:"transcriptionchunkreceived",level:3},{value:"whiteboardStatusChanged",id:"whiteboardstatuschanged",level:3},{value:"p2pStatusChanged",id:"p2pstatuschanged",level:3},{value:"audioOnlyChanged",id:"audioonlychanged",level:3}];function l(e){const n={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"JitsiMeetExternalAPI"})," object implements the ",(0,t.jsx)(n.a,{href:"https://nodejs.org/api/events.html",children:"EventEmitter"})," API for emitting and listening for events."]}),"\n",(0,t.jsxs)(n.p,{children:["You can add event listeners to the embedded Jitsi Meet using the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"addListener"})})," method:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"api.addListener(event, listener);\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If you want to remove a listener you can use the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"removeListener"})})," method:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"api.removeListener(event, listener);\n"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"event"})})," parameter is a string object with the name of the event."]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"listener"})})," parameter is a function object with one argument that creates a notification when the event occurs along with related event data."]}),"\n",(0,t.jsx)(n.p,{children:"The following events are currently supported:"}),"\n",(0,t.jsx)(n.h3,{id:"cameraerror",children:"cameraError"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about Jitsi Meet having failed to access the meeting camera."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n type: string, // A constant representing the overall type of the error.\n message: string // Additional information about the error.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"avatarchanged",children:"avatarChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to a participant's avatar."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant that changed his avatar.\n avatarURL: string // the new avatar URL.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"audioavailabilitychanged",children:"audioAvailabilityChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to audio availability status."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n available: boolean // new available status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"audiomutestatuschanged",children:"audioMuteStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to audio mute status."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n muted: boolean // new muted status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"breakoutroomsupdated",children:"breakoutRoomsUpdated"}),"\n",(0,t.jsx)(n.p,{children:"Provides notifications about breakout rooms changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n [roomId]: {\n id: string,\n jid: string,\n name: string,\n isMainRoom: true | undefined,\n participants: {\n [participantJid]: {\n displayName: string,\n jid: string,\n role: string\n }\n }\n },\n ...\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"browsersupport",children:"browserSupport"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about the current browser support."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n supported: boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"contentsharingparticipantschanged",children:"contentSharingParticipantsChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides real-time list of currently screen sharing participant ID's."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:'{\n data: ["particId1", "particId2", ...]\n}\n'})}),"\n",(0,t.jsx)(n.h3,{id:"datachannelopened",children:"dataChannelOpened"}),"\n",(0,t.jsx)(n.p,{children:"Indicates the data channel is open and thus messages can be sent over it."}),"\n",(0,t.jsx)(n.h3,{id:"endpointtextmessagereceived",children:"endpointTextMessageReceived"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a text messages received through data channels."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n senderInfo: {\n jid: string, // the jid of the sender\n id: string // the participant id of the sender\n },\n eventData: {\n name: string, // the name of the datachannel event: `endpoint-text-message`\n text: string // the received text from the sender\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"nonparticipantmessagereceived",children:"nonParticipantMessageReceived"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a messages sent by a non-participant, e.g. a custom prosody message."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the message, may be null\n message: string // the message received\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"facelandmarkdetected",children:"faceLandmarkDetected"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications when a face landmark is detected"}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n faceBox: {\n left: number, // face bounding box distance as percentage from the left video edge\n right: number // face bounding box distance as percentage from the right video edge\n width: number // face bounding box width as percentage of the total video width\n }, // this might be undefined if config.faceLandmarks.faceCenteringThreshold is not passed\n faceExpression: string // check https://github.com/jitsi/jitsi-meet/blob/master/react/features/face-landmarks/constants.js#L3 for available values\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"erroroccurred",children:"errorOccurred"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about an error which has occurred."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n details: Object?, // additional error details\n message: string?, // the error message\n name: string, // the coded name of the error\n type: string, // error type/source, one of : 'CONFIG', 'CONNECTION', 'CONFERENCE'\n isFatal: boolean // whether this is a fatal error which triggered a reconnect overlay or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"knockingparticipant",children:"knockingParticipant"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a knocking participant in the lobby."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n participant: {\n // the id and name of the participant that is currently knocking in the lobby\n id: string,\n name: string\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"largevideochanged",children:"largeVideoChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes in the large video display."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string // id of the participant that is now on large video in the stage view.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"log",children:"log"}),"\n",(0,t.jsxs)(n.p,{children:["Provides log event notifications with the log level being one of the values specified in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/config.js",children:"config.js"})," file in the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"apiLogLevels"})})," property (if not specified the event does not fire)."]}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n logLevel: string, // A constant representing the log type (info, error, debug, warn).\n args: string // Additional log information.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"micerror",children:"micError"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about Jitsi Meet issues with mic access."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n type: string, // A constant representing the overall type of the error.\n message: string // Additional information about the error.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"screensharingstatuschanged",children:"screenSharingStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about either turning on or off local user screen sharing."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n on: boolean, //whether screen sharing is on\n details: {\n\n // From where the screen sharing is capturing, if known. Values which are\n // passed include 'window', 'screen', 'proxy', 'device'. The value undefined\n // will be passed if the source type is unknown or screen share is off.\n sourceType: string|undefined\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"dominantspeakerchanged",children:"dominantSpeakerChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about dominant speaker changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string //participantId of the new dominant speaker\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"raisehandupdated",children:"raiseHandUpdated"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about the participant raising/lowering the hand."}),"\n",(0,t.jsx)(n.p,{children:"The listener will receive an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // participantId of the user who raises/lowers the hand\n handRaised: number // 0 when hand is lowered and the hand raised timestamp when raised.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"tileviewchanged",children:"tileViewChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about entrance or exit from the tile view layout mode."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n enabled: boolean, // whether tile view is not displayed or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"chatupdated",children:"chatUpdated"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about chat state being updated."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n isOpen: boolean, // Whether the chat panel is open or not\n unreadCount: number // The unread messages counter\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"incomingmessage",children:"incomingMessage"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about incoming chat messages."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n from: string, // the id of the user that sent the message\n nick: string, // the nickname of the user that sent the message\n privateMessage: boolean, // whether this is a private or group message\n message: string // the text of the message\n stamp: string // the message timestamp as string (ISO-8601)\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"mouseenter",children:"mouseEnter"}),"\n",(0,t.jsxs)(n.p,{children:["Provides event notifications when mouse enters the iframe.\nThe listener receives an object with the following structure based on ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent",children:"MouseEvent"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n event: {\n clientX,\n clientY,\n movementX,\n movementY,\n offsetX,\n offsetY,\n pageX,\n pageY,\n x,\n y,\n screenX,\n screenY\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"mouseleave",children:"mouseLeave"}),"\n",(0,t.jsxs)(n.p,{children:["Provides event notifications when mouse leaves the iframe.\nThe listener receives an object with the following structure based on ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent",children:"MouseEvent"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n event: {\n clientX,\n clientY,\n movementX,\n movementY,\n offsetX,\n offsetY,\n pageX,\n pageY,\n x,\n y,\n screenX,\n screenY\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"mousemove",children:"mouseMove"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications when mouse moves inside the iframe.\nTis event is triggered on an interval which can be configured by overriding the config.js mouseMoveCallbackInterval property."}),"\n",(0,t.jsxs)(n.p,{children:["The listener receives an object with the following structure based on ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent",children:"MouseEvent"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n event: {\n clientX,\n clientY,\n movementX,\n movementY,\n offsetX,\n offsetY,\n pageX,\n pageY,\n x,\n y,\n screenX,\n screenY\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantmenubuttonclick",children:"participantMenuButtonClick"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a participant context menu button being clicked."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n key: string, // the pressed button's key. The key is as defined in `toolbarButtons` config,\n participantId: string, // the id of the participant for which the button was clicked,\n preventExecution: boolean // whether the execution of the button click was prevented or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"toolbarbuttonclicked",children:"toolbarButtonClicked"}),"\n",(0,t.jsxs)(n.p,{children:["Provides event notifications about a toolbar button being clicked and whether the click routine was executed or not.\nFor overriding a button's click, please use the following config overwrite:\n",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/042a2cb447bd9ff39ab3904e493952787bd30924/config.js#L547",children:"https://github.com/jitsi/jitsi-meet/blob/042a2cb447bd9ff39ab3904e493952787bd30924/config.js#L547"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n key: string, // the pressed button's key. The key is as defined in `toolbarButtons` config,\n preventExecution: boolean // whether the click routine execution was prevented or not.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"outgoingmessage",children:"outgoingMessage"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about outgoing chat messages."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n message: string, // the text of the message\n privateMessage: boolean // whether this is a private or group message\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"displaynamechange",children:"displayNameChange"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about display name changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant that changed their display name\n displayname: string // the new display name\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"devicelistchanged",children:"deviceListChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about device list changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n devices: Object // the new list of available devices.\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"NOTE:"})," The ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"device"})})," object has the same format as the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"getAvailableDevices"})})," result format."]}),"\n",(0,t.jsx)(n.h3,{id:"emailchange",children:"emailChange"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about email changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant that changed his email\n email: string // the new email\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"feedbacksubmitted",children:"feedbackSubmitted"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about conference feedback submissions:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n error: string // The error which occurred during submission, if any.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"filmstripdisplaychanged",children:"filmstripDisplayChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event visibility notifications for the filmstrip that is being updated:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n visible: boolean // Whether or not the filmstrip is displayed or hidden.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"moderationstatuschanged",children:"moderationStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to moderation status."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n mediaType: string, // The media type for which moderation changed.\n enabled: boolean // Whether or not moderation changed to enabled.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"moderationparticipantapproved",children:"moderationParticipantApproved"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants approvals for moderation."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // The ID of the participant that got approved.\n mediaType: string // The media type for which the participant was approved.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"moderationparticipantrejected",children:"moderationParticipantRejected"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants rejections for moderation."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // The ID of the participant that got rejected.\n mediaType: string // The media type for which the participant was rejected.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"notificationtriggered",children:"notificationTriggered"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications when an application notification occurs."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n title: string, // The notification title.\n description: string // The notification description.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantjoined",children:"participantJoined"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about new participants who join the room."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant\n displayName: string // the display name of the participant\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantkickedout",children:"participantKickedOut"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants being removed from the room."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n kicked: {\n id: string, // the id of the participant removed from the room\n local: boolean // whether or not the participant is the local particiapnt\n },\n kicker: {\n id: string // the id of the participant who kicked out the other participant\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantleft",children:"participantLeft"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants that leave the meeting room."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string // the id of the participant\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantrolechanged",children:"participantRoleChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the local user role has changed (e.g., none, moderator, participant)."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string // the id of the participant\n role: string // the new role of the participant\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantspanetoggled",children:"participantsPaneToggled"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the participants pane status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n open: boolean // whether the pane is open or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"passwordrequired",children:"passwordRequired"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when participants fail to join a password protected room."}),"\n",(0,t.jsx)(n.h3,{id:"videoconferencejoined",children:"videoConferenceJoined"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the local user has joined the video conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n roomName: string, // the room name of the conference\n id: string, // the id of the local participant\n displayName: string, // the display name of the local participant\n avatarURL: string, // the avatar URL of the local participant\n breakoutRoom: boolean, // whether the current room is a breakout room\n visitor: boolean // whether the current user is a visitor\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videoconferenceleft",children:"videoConferenceLeft"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the local user has left the video conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n roomName: string // the room name of the conference\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"conferencecreatedtimestamp",children:"conferenceCreatedTimestamp"}),"\n",(0,t.jsx)(n.p,{children:"Provides notification of the start time of the video conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n timestamp: timestamp // time the conference started\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videoavailabilitychanged",children:"videoAvailabilityChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about video availability status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n available: boolean // new available status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videomutestatuschanged",children:"videoMuteStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about video mute status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n muted: boolean // new muted status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videoqualitychanged",children:"videoQualityChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to video quality settings."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n videoQuality: number // the height of the resolution related to the new video quality setting.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"readytoclose",children:"readyToClose"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when Jitsi Meet is ready to be closed (i.e., hangup operations are completed)."}),"\n",(0,t.jsx)(n.h3,{id:"recordinglinkavailable",children:"recordingLinkAvailable"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about recording link becoming available."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n link: string, // the recording link\n ttl: number // the time to live of the recording link\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"recordingstatuschanged",children:"recordingStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about recording status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n on: boolean // new recording status - boolean,\n mode: string // recording mode, `local`, `stream` or `file`,\n error: string | undefined // error type if recording fails, undefined otherwise\n transcription: boolean // whether a transcription is active or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"subjectchange",children:"subjectChange"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications regarding the change of subject for a conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n subject: string // the new subject\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"suspenddetected",children:"suspendDetected"}),"\n",(0,t.jsx)(n.p,{children:"Provides notifications about detecting suspended events in the host computer."}),"\n",(0,t.jsx)(n.h3,{id:"peerconnectionfailure",children:"peerConnectionFailure"}),"\n",(0,t.jsxs)(n.p,{children:["Notify the external application that a PeerConnection lost connectivity. This event is fired only if\na PC ",(0,t.jsx)(n.code,{children:"failed"})," but connectivity to the rtcstats server is still maintained signaling that there is a\nproblem establishing a link between the app and the JVB server or the remote peer in case of P2P.\nWill only fire if rtcstats is enabled."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n // Type of PC, Peer2Peer or JVB connection.\n isP2P: boolean,\n\n // Was this connection previously connected. If it was it could mean\n // that connectivity was disrupted, if not it most likely means that the app could not reach\n // the JVB server, or the other peer in case of P2P.\n wasConnected: boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"transcribingstatuschanged",children:"transcribingStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about status changes in the transcribing process."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n on: boolean,\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"transcriptionchunkreceived",children:"transcriptionChunkReceived"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about new transcription chunks being available."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n // Transcription language\n language: string,\n\n // ID for this chunk.\n messageID: string,\n\n // participant info\n participant: {\n avatarUrl: string,\n id: string\n name: string,\n },\n\n // If the transcription is final, the text will be here.\n final: string,\n\n // If the transcription is not final but has high accuracy the text will be here.\n stable: string,\n\n // If the transcription is not final but has low accuracy the text will be here.\n unstable: string,\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"whiteboardstatuschanged",children:"whiteboardStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to the whiteboard."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n status: string // new whiteboard status\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"p2pstatuschanged",children:"p2pStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to the connection type."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n isP2p: boolean|null // whether the new connection type is P2P\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"audioonlychanged",children:"audioOnlyChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to the audio only mode status."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n audioOnlyChanged: boolean // whether the audio only is enabled or disabled.\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var t=i(6540);const a={},r=t.createContext(a);function s(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[4955],{3966:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(4848),a=i(8453);const r={id:"dev-guide-iframe-events",title:"Events"},s=void 0,o={id:"dev-guide/dev-guide-iframe-events",title:"Events",description:"The JitsiMeetExternalAPI object implements the [EventEmitter] API for emitting and listening for events.",source:"@site/docs/dev-guide/iframe-events.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-iframe-events",permalink:"/handbook/docs/dev-guide/dev-guide-iframe-events",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/iframe-events.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"dev-guide-iframe-events",title:"Events"},sidebar:"docs",previous:{title:"Commands",permalink:"/handbook/docs/dev-guide/dev-guide-iframe-commands"},next:{title:"React SDK",permalink:"/handbook/docs/dev-guide/dev-guide-react-sdk"}},c={},d=[{value:"cameraError",id:"cameraerror",level:3},{value:"avatarChanged",id:"avatarchanged",level:3},{value:"audioAvailabilityChanged",id:"audioavailabilitychanged",level:3},{value:"audioMuteStatusChanged",id:"audiomutestatuschanged",level:3},{value:"breakoutRoomsUpdated",id:"breakoutroomsupdated",level:3},{value:"browserSupport",id:"browsersupport",level:3},{value:"contentSharingParticipantsChanged",id:"contentsharingparticipantschanged",level:3},{value:"dataChannelOpened",id:"datachannelopened",level:3},{value:"endpointTextMessageReceived",id:"endpointtextmessagereceived",level:3},{value:"nonParticipantMessageReceived",id:"nonparticipantmessagereceived",level:3},{value:"faceLandmarkDetected",id:"facelandmarkdetected",level:3},{value:"errorOccurred",id:"erroroccurred",level:3},{value:"knockingParticipant",id:"knockingparticipant",level:3},{value:"largeVideoChanged",id:"largevideochanged",level:3},{value:"log",id:"log",level:3},{value:"micError",id:"micerror",level:3},{value:"screenSharingStatusChanged",id:"screensharingstatuschanged",level:3},{value:"dominantSpeakerChanged",id:"dominantspeakerchanged",level:3},{value:"raiseHandUpdated",id:"raisehandupdated",level:3},{value:"tileViewChanged",id:"tileviewchanged",level:3},{value:"chatUpdated",id:"chatupdated",level:3},{value:"incomingMessage",id:"incomingmessage",level:3},{value:"mouseEnter",id:"mouseenter",level:3},{value:"mouseLeave",id:"mouseleave",level:3},{value:"mouseMove",id:"mousemove",level:3},{value:"participantMenuButtonClick",id:"participantmenubuttonclick",level:3},{value:"toolbarButtonClicked",id:"toolbarbuttonclicked",level:3},{value:"outgoingMessage",id:"outgoingmessage",level:3},{value:"displayNameChange",id:"displaynamechange",level:3},{value:"deviceListChanged",id:"devicelistchanged",level:3},{value:"emailChange",id:"emailchange",level:3},{value:"feedbackSubmitted",id:"feedbacksubmitted",level:3},{value:"filmstripDisplayChanged",id:"filmstripdisplaychanged",level:3},{value:"moderationStatusChanged",id:"moderationstatuschanged",level:3},{value:"moderationParticipantApproved",id:"moderationparticipantapproved",level:3},{value:"moderationParticipantRejected",id:"moderationparticipantrejected",level:3},{value:"notificationTriggered",id:"notificationtriggered",level:3},{value:"participantJoined",id:"participantjoined",level:3},{value:"participantKickedOut",id:"participantkickedout",level:3},{value:"participantLeft",id:"participantleft",level:3},{value:"participantRoleChanged",id:"participantrolechanged",level:3},{value:"participantsPaneToggled",id:"participantspanetoggled",level:3},{value:"passwordRequired",id:"passwordrequired",level:3},{value:"videoConferenceJoined",id:"videoconferencejoined",level:3},{value:"videoConferenceLeft",id:"videoconferenceleft",level:3},{value:"conferenceCreatedTimestamp",id:"conferencecreatedtimestamp",level:3},{value:"videoAvailabilityChanged",id:"videoavailabilitychanged",level:3},{value:"videoMuteStatusChanged",id:"videomutestatuschanged",level:3},{value:"videoQualityChanged",id:"videoqualitychanged",level:3},{value:"readyToClose",id:"readytoclose",level:3},{value:"recordingLinkAvailable",id:"recordinglinkavailable",level:3},{value:"recordingStatusChanged",id:"recordingstatuschanged",level:3},{value:"subjectChange",id:"subjectchange",level:3},{value:"suspendDetected",id:"suspenddetected",level:3},{value:"peerConnectionFailure",id:"peerconnectionfailure",level:3},{value:"transcribingStatusChanged",id:"transcribingstatuschanged",level:3},{value:"transcriptionChunkReceived",id:"transcriptionchunkreceived",level:3},{value:"whiteboardStatusChanged",id:"whiteboardstatuschanged",level:3},{value:"p2pStatusChanged",id:"p2pstatuschanged",level:3},{value:"audioOnlyChanged",id:"audioonlychanged",level:3}];function l(e){const n={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"JitsiMeetExternalAPI"})," object implements the ",(0,t.jsx)(n.a,{href:"https://nodejs.org/api/events.html",children:"EventEmitter"})," API for emitting and listening for events."]}),"\n",(0,t.jsxs)(n.p,{children:["You can add event listeners to the embedded Jitsi Meet using the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"addListener"})})," method:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"api.addListener(event, listener);\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If you want to remove a listener you can use the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"removeListener"})})," method:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"api.removeListener(event, listener);\n"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"event"})})," parameter is a string object with the name of the event."]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"listener"})})," parameter is a function object with one argument that creates a notification when the event occurs along with related event data."]}),"\n",(0,t.jsx)(n.p,{children:"The following events are currently supported:"}),"\n",(0,t.jsx)(n.h3,{id:"cameraerror",children:"cameraError"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about Jitsi Meet having failed to access the meeting camera."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n type: string, // A constant representing the overall type of the error.\n message: string // Additional information about the error.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"avatarchanged",children:"avatarChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to a participant's avatar."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant that changed his avatar.\n avatarURL: string // the new avatar URL.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"audioavailabilitychanged",children:"audioAvailabilityChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to audio availability status."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n available: boolean // new available status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"audiomutestatuschanged",children:"audioMuteStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to audio mute status."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n muted: boolean // new muted status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"breakoutroomsupdated",children:"breakoutRoomsUpdated"}),"\n",(0,t.jsx)(n.p,{children:"Provides notifications about breakout rooms changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n [roomId]: {\n id: string,\n jid: string,\n name: string,\n isMainRoom: true | undefined,\n participants: {\n [participantJid]: {\n displayName: string,\n jid: string,\n role: string\n }\n }\n },\n ...\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"browsersupport",children:"browserSupport"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about the current browser support."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n supported: boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"contentsharingparticipantschanged",children:"contentSharingParticipantsChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides real-time list of currently screen sharing participant ID's."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:'{\n data: ["particId1", "particId2", ...]\n}\n'})}),"\n",(0,t.jsx)(n.h3,{id:"datachannelopened",children:"dataChannelOpened"}),"\n",(0,t.jsx)(n.p,{children:"Indicates the data channel is open and thus messages can be sent over it."}),"\n",(0,t.jsx)(n.h3,{id:"endpointtextmessagereceived",children:"endpointTextMessageReceived"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a text messages received through data channels."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n senderInfo: {\n jid: string, // the jid of the sender\n id: string // the participant id of the sender\n },\n eventData: {\n name: string, // the name of the datachannel event: `endpoint-text-message`\n text: string // the received text from the sender\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"nonparticipantmessagereceived",children:"nonParticipantMessageReceived"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a messages sent by a non-participant, e.g. a custom prosody message."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the message, may be null\n message: string // the message received\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"facelandmarkdetected",children:"faceLandmarkDetected"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications when a face landmark is detected"}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n faceBox: {\n left: number, // face bounding box distance as percentage from the left video edge\n right: number // face bounding box distance as percentage from the right video edge\n width: number // face bounding box width as percentage of the total video width\n }, // this might be undefined if config.faceLandmarks.faceCenteringThreshold is not passed\n faceExpression: string // check https://github.com/jitsi/jitsi-meet/blob/master/react/features/face-landmarks/constants.js#L3 for available values\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"erroroccurred",children:"errorOccurred"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about an error which has occurred."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n details: Object?, // additional error details\n message: string?, // the error message\n name: string, // the coded name of the error\n type: string, // error type/source, one of : 'CONFIG', 'CONNECTION', 'CONFERENCE'\n isFatal: boolean // whether this is a fatal error which triggered a reconnect overlay or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"knockingparticipant",children:"knockingParticipant"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a knocking participant in the lobby."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n participant: {\n // the id and name of the participant that is currently knocking in the lobby\n id: string,\n name: string\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"largevideochanged",children:"largeVideoChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes in the large video display."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string // id of the participant that is now on large video in the stage view.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"log",children:"log"}),"\n",(0,t.jsxs)(n.p,{children:["Provides log event notifications with the log level being one of the values specified in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/config.js",children:"config.js"})," file in the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"apiLogLevels"})})," property (if not specified the event does not fire)."]}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n logLevel: string, // A constant representing the log type (info, error, debug, warn).\n args: string // Additional log information.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"micerror",children:"micError"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about Jitsi Meet issues with mic access."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n type: string, // A constant representing the overall type of the error.\n message: string // Additional information about the error.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"screensharingstatuschanged",children:"screenSharingStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about either turning on or off local user screen sharing."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n on: boolean, //whether screen sharing is on\n details: {\n\n // From where the screen sharing is capturing, if known. Values which are\n // passed include 'window', 'screen', 'proxy', 'device'. The value undefined\n // will be passed if the source type is unknown or screen share is off.\n sourceType: string|undefined\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"dominantspeakerchanged",children:"dominantSpeakerChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about dominant speaker changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string //participantId of the new dominant speaker\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"raisehandupdated",children:"raiseHandUpdated"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about the participant raising/lowering the hand."}),"\n",(0,t.jsx)(n.p,{children:"The listener will receive an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // participantId of the user who raises/lowers the hand\n handRaised: number // 0 when hand is lowered and the hand raised timestamp when raised.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"tileviewchanged",children:"tileViewChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about entrance or exit from the tile view layout mode."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n enabled: boolean, // whether tile view is not displayed or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"chatupdated",children:"chatUpdated"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about chat state being updated."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n isOpen: boolean, // Whether the chat panel is open or not\n unreadCount: number // The unread messages counter\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"incomingmessage",children:"incomingMessage"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about incoming chat messages."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n from: string, // the id of the user that sent the message\n nick: string, // the nickname of the user that sent the message\n privateMessage: boolean, // whether this is a private or group message\n message: string // the text of the message\n stamp: string // the message timestamp as string (ISO-8601)\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"mouseenter",children:"mouseEnter"}),"\n",(0,t.jsxs)(n.p,{children:["Provides event notifications when mouse enters the iframe.\nThe listener receives an object with the following structure based on ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent",children:"MouseEvent"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n event: {\n clientX,\n clientY,\n movementX,\n movementY,\n offsetX,\n offsetY,\n pageX,\n pageY,\n x,\n y,\n screenX,\n screenY\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"mouseleave",children:"mouseLeave"}),"\n",(0,t.jsxs)(n.p,{children:["Provides event notifications when mouse leaves the iframe.\nThe listener receives an object with the following structure based on ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent",children:"MouseEvent"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n event: {\n clientX,\n clientY,\n movementX,\n movementY,\n offsetX,\n offsetY,\n pageX,\n pageY,\n x,\n y,\n screenX,\n screenY\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"mousemove",children:"mouseMove"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications when mouse moves inside the iframe.\nTis event is triggered on an interval which can be configured by overriding the config.js mouseMoveCallbackInterval property."}),"\n",(0,t.jsxs)(n.p,{children:["The listener receives an object with the following structure based on ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent",children:"MouseEvent"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n event: {\n clientX,\n clientY,\n movementX,\n movementY,\n offsetX,\n offsetY,\n pageX,\n pageY,\n x,\n y,\n screenX,\n screenY\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantmenubuttonclick",children:"participantMenuButtonClick"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about a participant context menu button being clicked."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n key: string, // the pressed button's key. The key is as defined in `toolbarButtons` config,\n participantId: string, // the id of the participant for which the button was clicked,\n preventExecution: boolean // whether the execution of the button click was prevented or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"toolbarbuttonclicked",children:"toolbarButtonClicked"}),"\n",(0,t.jsxs)(n.p,{children:["Provides event notifications about a toolbar button being clicked and whether the click routine was executed or not.\nFor overriding a button's click, please use the following config overwrite:\n",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/042a2cb447bd9ff39ab3904e493952787bd30924/config.js#L547",children:"https://github.com/jitsi/jitsi-meet/blob/042a2cb447bd9ff39ab3904e493952787bd30924/config.js#L547"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n key: string, // the pressed button's key. The key is as defined in `toolbarButtons` config,\n preventExecution: boolean // whether the click routine execution was prevented or not.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"outgoingmessage",children:"outgoingMessage"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about outgoing chat messages."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n message: string, // the text of the message\n privateMessage: boolean // whether this is a private or group message\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"displaynamechange",children:"displayNameChange"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about display name changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant that changed their display name\n displayname: string // the new display name\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"devicelistchanged",children:"deviceListChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about device list changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n devices: Object // the new list of available devices.\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"NOTE:"})," The ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"device"})})," object has the same format as the ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"getAvailableDevices"})})," result format."]}),"\n",(0,t.jsx)(n.h3,{id:"emailchange",children:"emailChange"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about email changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant that changed his email\n email: string // the new email\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"feedbacksubmitted",children:"feedbackSubmitted"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about conference feedback submissions:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n error: string // The error which occurred during submission, if any.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"filmstripdisplaychanged",children:"filmstripDisplayChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event visibility notifications for the filmstrip that is being updated:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n visible: boolean // Whether or not the filmstrip is displayed or hidden.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"moderationstatuschanged",children:"moderationStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to moderation status."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n mediaType: string, // The media type for which moderation changed.\n enabled: boolean // Whether or not moderation changed to enabled.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"moderationparticipantapproved",children:"moderationParticipantApproved"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants approvals for moderation."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // The ID of the participant that got approved.\n mediaType: string // The media type for which the participant was approved.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"moderationparticipantrejected",children:"moderationParticipantRejected"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants rejections for moderation."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // The ID of the participant that got rejected.\n mediaType: string // The media type for which the participant was rejected.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"notificationtriggered",children:"notificationTriggered"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications when an application notification occurs."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n title: string, // The notification title.\n description: string // The notification description.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantjoined",children:"participantJoined"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about new participants who join the room."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string, // the id of the participant\n displayName: string // the display name of the participant\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantkickedout",children:"participantKickedOut"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants being removed from the room."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n kicked: {\n id: string, // the id of the participant removed from the room\n local: boolean // whether or not the participant is the local particiapnt\n },\n kicker: {\n id: string // the id of the participant who kicked out the other participant\n }\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantleft",children:"participantLeft"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about participants that leave the meeting room."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string // the id of the participant\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantrolechanged",children:"participantRoleChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the local user role has changed (e.g., none, moderator, participant)."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n id: string // the id of the participant\n role: string // the new role of the participant\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"participantspanetoggled",children:"participantsPaneToggled"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the participants pane status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n open: boolean // whether the pane is open or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"passwordrequired",children:"passwordRequired"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when participants fail to join a password protected room."}),"\n",(0,t.jsx)(n.h3,{id:"videoconferencejoined",children:"videoConferenceJoined"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the local user has joined the video conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n roomName: string, // the room name of the conference\n id: string, // the id of the local participant\n displayName: string, // the display name of the local participant\n avatarURL: string, // the avatar URL of the local participant\n breakoutRoom: boolean, // whether the current room is a breakout room\n visitor: boolean // whether the current user is a visitor\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videoconferenceleft",children:"videoConferenceLeft"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when the local user has left the video conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n roomName: string // the room name of the conference\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"conferencecreatedtimestamp",children:"conferenceCreatedTimestamp"}),"\n",(0,t.jsx)(n.p,{children:"Provides notification of the start time of the video conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n timestamp: timestamp // time the conference started\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videoavailabilitychanged",children:"videoAvailabilityChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about video availability status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n available: boolean // new available status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videomutestatuschanged",children:"videoMuteStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about video mute status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n muted: boolean // new muted status - boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"videoqualitychanged",children:"videoQualityChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to video quality settings."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n videoQuality: number // the height of the resolution related to the new video quality setting.\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"readytoclose",children:"readyToClose"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications that fire when Jitsi Meet is ready to be closed (i.e., hangup operations are completed)."}),"\n",(0,t.jsx)(n.h3,{id:"recordinglinkavailable",children:"recordingLinkAvailable"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about recording link becoming available."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n link: string, // the recording link\n ttl: number // the time to live of the recording link\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"recordingstatuschanged",children:"recordingStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about recording status changes."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n on: boolean // new recording status - boolean,\n mode: string // recording mode, `local`, `stream` or `file`,\n error: string | undefined // error type if recording fails, undefined otherwise\n transcription: boolean // whether a transcription is active or not\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"subjectchange",children:"subjectChange"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications regarding the change of subject for a conference."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n subject: string // the new subject\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"suspenddetected",children:"suspendDetected"}),"\n",(0,t.jsx)(n.p,{children:"Provides notifications about detecting suspended events in the host computer."}),"\n",(0,t.jsx)(n.h3,{id:"peerconnectionfailure",children:"peerConnectionFailure"}),"\n",(0,t.jsxs)(n.p,{children:["Notify the external application that a PeerConnection lost connectivity. This event is fired only if\na PC ",(0,t.jsx)(n.code,{children:"failed"})," but connectivity to the rtcstats server is still maintained signaling that there is a\nproblem establishing a link between the app and the JVB server or the remote peer in case of P2P.\nWill only fire if rtcstats is enabled."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n // Type of PC, Peer2Peer or JVB connection.\n isP2P: boolean,\n\n // Was this connection previously connected. If it was it could mean\n // that connectivity was disrupted, if not it most likely means that the app could not reach\n // the JVB server, or the other peer in case of P2P.\n wasConnected: boolean\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"transcribingstatuschanged",children:"transcribingStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about status changes in the transcribing process."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n on: boolean,\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"transcriptionchunkreceived",children:"transcriptionChunkReceived"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about new transcription chunks being available."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n // Transcription language\n language: string,\n\n // ID for this chunk.\n messageID: string,\n\n // participant info\n participant: {\n avatarUrl: string,\n id: string\n name: string,\n },\n\n // If the transcription is final, the text will be here.\n final: string,\n\n // If the transcription is not final but has high accuracy the text will be here.\n stable: string,\n\n // If the transcription is not final but has low accuracy the text will be here.\n unstable: string,\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"whiteboardstatuschanged",children:"whiteboardStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to the whiteboard."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n status: string // new whiteboard status\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"p2pstatuschanged",children:"p2pStatusChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to the connection type."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n isP2p: boolean|null // whether the new connection type is P2P\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"audioonlychanged",children:"audioOnlyChanged"}),"\n",(0,t.jsx)(n.p,{children:"Provides event notifications about changes to the audio only mode status."}),"\n",(0,t.jsx)(n.p,{children:"The listener receives an object with the following structure:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"{\n audioOnlyChanged: boolean // whether the audio only is enabled or disabled.\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var t=i(6540);const a={},r=t.createContext(a);function s(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/58508fec.fc61e6e7.js b/assets/js/58508fec.e23950c0.js similarity index 99% rename from assets/js/58508fec.fc61e6e7.js rename to assets/js/58508fec.e23950c0.js index 8fc6059c0..169569170 100644 --- a/assets/js/58508fec.fc61e6e7.js +++ b/assets/js/58508fec.e23950c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[601],{1163:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=s(4848),n=s(8453);const i={id:"supported-browsers",title:"Supported Browsers"},d=void 0,o={id:"user-guide/supported-browsers",title:"Supported Browsers",description:"Desktop browsers",source:"@site/docs/user-guide/browsers.md",sourceDirName:"user-guide",slug:"/user-guide/supported-browsers",permalink:"/handbook/docs/user-guide/supported-browsers",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/browsers.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"supported-browsers",title:"Supported Browsers"},sidebar:"docs",previous:{title:"User Guide",permalink:"/handbook/docs/category/user-guide"},next:{title:"Join a Jitsi Meeting",permalink:"/handbook/docs/user-guide/user-guide-join-jitsi-meeting"}},l={},c=[{value:"Desktop browsers",id:"desktop-browsers",level:2},{value:"Mobile browsers",id:"mobile-browsers",level:2},{value:"Android",id:"android",level:3},{value:"iOS",id:"ios",level:3}];function a(e){const t={a:"a",admonition:"admonition",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",section:"section",sup:"sup",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"desktop-browsers",children:"Desktop browsers"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Browser"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Support"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Versions"}),(0,r.jsx)(t.th,{children:"Notes"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:["Chrome ",(0,r.jsx)(t.sup,{children:(0,r.jsx)(t.a,{href:"#user-content-fn-1",id:"user-content-fnref-1","data-footnote-ref":!0,"aria-describedby":"footnote-label",children:"1"})})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 72"}),(0,r.jsx)(t.td,{children:"Best results with >= 96"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Firefox"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 68"}),(0,r.jsx)(t.td,{children:"Best results with >= 101"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Safari"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 14"}),(0,r.jsx)(t.td,{children:"Best results with >= 15, output device selection unsupported"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Edge"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 79"}),(0,r.jsx)(t.td,{children:"Edge Legacy is unsupported"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Internet Explorer"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u274c"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"mobile-browsers",children:"Mobile browsers"}),"\n",(0,r.jsx)(t.h3,{id:"android",children:"Android"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Browser"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Support"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Versions"}),(0,r.jsx)(t.th,{children:"Notes"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:["Chrome ",(0,r.jsx)(t.sup,{children:(0,r.jsx)(t.a,{href:"#user-content-fn-1",id:"user-content-fnref-1-2","data-footnote-ref":!0,"aria-describedby":"footnote-label",children:"1"})})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as the desktop version"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Firefox"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as the desktop version"})]})]})]}),"\n",(0,r.jsx)(t.admonition,{type:"note",children:(0,r.jsxs)(t.p,{children:["For a better mobile experience (background support, Bluetooth support, etc.) we recommend using a\nnative app instead. We provide a ",(0,r.jsx)(t.a,{href:"/handbook/docs/dev-guide/dev-guide-android-sdk",children:"native Android SDK"}),"."]})}),"\n",(0,r.jsx)(t.h3,{id:"ios",children:"iOS"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Browser"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Support"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Versions"}),(0,r.jsx)(t.th,{children:"Notes"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Chrome"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as Safari as they share the engine"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Firefox"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as Safari as they share the engine"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Safari"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 14.3"}),(0,r.jsx)(t.td,{children:"Best results with 15.4"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Edge"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as Safari as they share the engine"})]})]})]}),"\n",(0,r.jsxs)(t.admonition,{type:"note",children:[(0,r.jsx)(t.p,{children:"On iOS all browsers share the same engine, Safari. As such all features and limitations on all iOS\nbrowsers are those of Safari."}),(0,r.jsxs)(t.p,{children:["For a better mobile experience (background support, CallKit integration, etc.) we recommend using a\nnative app instead. We provide a ",(0,r.jsx)(t.a,{href:"/handbook/docs/dev-guide/dev-guide-ios-sdk",children:"native iOS SDK"}),"."]})]}),"\n","\n",(0,r.jsxs)(t.section,{"data-footnotes":!0,className:"footnotes",children:[(0,r.jsx)(t.h2,{className:"sr-only",id:"footnote-label",children:"Footnotes"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{id:"user-content-fn-1",children:["\n",(0,r.jsxs)(t.p,{children:["This also applies to all Chromium based browsers such as Brave, (current) Edge, Opera, Vivaldi and others. ",(0,r.jsx)(t.a,{href:"#user-content-fnref-1","data-footnote-backref":"","aria-label":"Back to reference 1",className:"data-footnote-backref",children:"\u21a9"})," ",(0,r.jsxs)(t.a,{href:"#user-content-fnref-1-2","data-footnote-backref":"","aria-label":"Back to reference 1-2",className:"data-footnote-backref",children:["\u21a9",(0,r.jsx)(t.sup,{children:"2"})]})]}),"\n"]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>d,x:()=>o});var r=s(6540);const n={},i=r.createContext(n);function d(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:d(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[601],{1163:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=s(4848),n=s(8453);const i={id:"supported-browsers",title:"Supported Browsers"},d=void 0,o={id:"user-guide/supported-browsers",title:"Supported Browsers",description:"Desktop browsers",source:"@site/docs/user-guide/browsers.md",sourceDirName:"user-guide",slug:"/user-guide/supported-browsers",permalink:"/handbook/docs/user-guide/supported-browsers",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/browsers.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"supported-browsers",title:"Supported Browsers"},sidebar:"docs",previous:{title:"User Guide",permalink:"/handbook/docs/category/user-guide"},next:{title:"Join a Jitsi Meeting",permalink:"/handbook/docs/user-guide/user-guide-join-jitsi-meeting"}},l={},c=[{value:"Desktop browsers",id:"desktop-browsers",level:2},{value:"Mobile browsers",id:"mobile-browsers",level:2},{value:"Android",id:"android",level:3},{value:"iOS",id:"ios",level:3}];function a(e){const t={a:"a",admonition:"admonition",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",section:"section",sup:"sup",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"desktop-browsers",children:"Desktop browsers"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Browser"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Support"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Versions"}),(0,r.jsx)(t.th,{children:"Notes"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:["Chrome ",(0,r.jsx)(t.sup,{children:(0,r.jsx)(t.a,{href:"#user-content-fn-1",id:"user-content-fnref-1","data-footnote-ref":!0,"aria-describedby":"footnote-label",children:"1"})})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 72"}),(0,r.jsx)(t.td,{children:"Best results with >= 96"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Firefox"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 68"}),(0,r.jsx)(t.td,{children:"Best results with >= 101"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Safari"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 14"}),(0,r.jsx)(t.td,{children:"Best results with >= 15, output device selection unsupported"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Edge"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 79"}),(0,r.jsx)(t.td,{children:"Edge Legacy is unsupported"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Internet Explorer"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u274c"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"mobile-browsers",children:"Mobile browsers"}),"\n",(0,r.jsx)(t.h3,{id:"android",children:"Android"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Browser"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Support"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Versions"}),(0,r.jsx)(t.th,{children:"Notes"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:["Chrome ",(0,r.jsx)(t.sup,{children:(0,r.jsx)(t.a,{href:"#user-content-fn-1",id:"user-content-fnref-1-2","data-footnote-ref":!0,"aria-describedby":"footnote-label",children:"1"})})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as the desktop version"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Firefox"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as the desktop version"})]})]})]}),"\n",(0,r.jsx)(t.admonition,{type:"note",children:(0,r.jsxs)(t.p,{children:["For a better mobile experience (background support, Bluetooth support, etc.) we recommend using a\nnative app instead. We provide a ",(0,r.jsx)(t.a,{href:"/handbook/docs/dev-guide/dev-guide-android-sdk",children:"native Android SDK"}),"."]})}),"\n",(0,r.jsx)(t.h3,{id:"ios",children:"iOS"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Browser"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Support"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Versions"}),(0,r.jsx)(t.th,{children:"Notes"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Chrome"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as Safari as they share the engine"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Firefox"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as Safari as they share the engine"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Safari"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:">= 14.3"}),(0,r.jsx)(t.td,{children:"Best results with 15.4"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Edge"}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(t.td,{style:{textAlign:"center"}}),(0,r.jsx)(t.td,{children:"Same support as Safari as they share the engine"})]})]})]}),"\n",(0,r.jsxs)(t.admonition,{type:"note",children:[(0,r.jsx)(t.p,{children:"On iOS all browsers share the same engine, Safari. As such all features and limitations on all iOS\nbrowsers are those of Safari."}),(0,r.jsxs)(t.p,{children:["For a better mobile experience (background support, CallKit integration, etc.) we recommend using a\nnative app instead. We provide a ",(0,r.jsx)(t.a,{href:"/handbook/docs/dev-guide/dev-guide-ios-sdk",children:"native iOS SDK"}),"."]})]}),"\n","\n",(0,r.jsxs)(t.section,{"data-footnotes":!0,className:"footnotes",children:[(0,r.jsx)(t.h2,{className:"sr-only",id:"footnote-label",children:"Footnotes"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{id:"user-content-fn-1",children:["\n",(0,r.jsxs)(t.p,{children:["This also applies to all Chromium based browsers such as Brave, (current) Edge, Opera, Vivaldi and others. ",(0,r.jsx)(t.a,{href:"#user-content-fnref-1","data-footnote-backref":"","aria-label":"Back to reference 1",className:"data-footnote-backref",children:"\u21a9"})," ",(0,r.jsxs)(t.a,{href:"#user-content-fnref-1-2","data-footnote-backref":"","aria-label":"Back to reference 1-2",className:"data-footnote-backref",children:["\u21a9",(0,r.jsx)(t.sup,{children:"2"})]})]}),"\n"]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>d,x:()=>o});var r=s(6540);const n={},i=r.createContext(n);function d(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:d(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5ca9a3fa.0f4da8da.js b/assets/js/5ca9a3fa.307180f1.js similarity index 98% rename from assets/js/5ca9a3fa.0f4da8da.js rename to assets/js/5ca9a3fa.307180f1.js index c8315a036..48400a851 100644 --- a/assets/js/5ca9a3fa.0f4da8da.js +++ b/assets/js/5ca9a3fa.307180f1.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[9418],{9204:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>c,frontMatter:()=>d,metadata:()=>o,toc:()=>h});var i=n(4848),s=n(8453);const d={id:"client connection status indicators",title:"Client Connection Status Indicators"},r=void 0,o={id:"user-guide/client connection status indicators",title:"Client Connection Status Indicators",description:"This document explains what the different connection quality indicators on the video thumbnails actually mean.",source:"@site/docs/user-guide/client-connection-status-indicators.md",sourceDirName:"user-guide",slug:"/user-guide/client connection status indicators",permalink:"/handbook/docs/user-guide/client connection status indicators",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/client-connection-status-indicators.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"client connection status indicators",title:"Client Connection Status Indicators"}},a={},h=[{value:"GOOD",id:"good",level:2},{value:"NON-OPTIMAL",id:"non-optimal",level:2},{value:"POOR",id:"poor",level:2},{value:"LOST",id:"lost",level:2},{value:"GHOST/NINJA",id:"ghostninja",level:2},{value:"Target bitrates expected for the video streams",id:"target-bitrates-expected-for-the-video-streams",level:2}];function l(e){const t={h2:"h2",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"This document explains what the different connection quality indicators on the video thumbnails actually mean."}),"\n",(0,i.jsx)(t.h2,{id:"good",children:"GOOD"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"With video enabled, when the send bitrate for the video stream is at least 50% of the target bitrate expected for the stream. Please refer to the target bitrates table below."}),"\n",(0,i.jsx)(t.li,{children:"With video disabled or screen sharing is in progress, when the downstream packet loss is less than 6%."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"non-optimal",children:"NON-OPTIMAL"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"With video enabled, when the send bitrate for the video stream is at least 30% of the target bitrate expected for the stream. Please refer to the target bitrates table below."}),"\n",(0,i.jsx)(t.li,{children:"With video disabled or screen sharing is in progress, when the downstream packet loss is between 6% and 8%."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"poor",children:"POOR"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"With video enabled, when the send bitrate for the video stream is at least 10% of the target bitrate expected for the stream. Please refer to the target bitrates table below."}),"\n",(0,i.jsx)(t.li,{children:"With video disabled or screen sharing is in progress, when the downstream packet loss is between 8% and 12%."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"lost",children:"LOST"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"When the user stops receiving video for the remote endpoint even when the endpoint is not video muted and it is in LastN as indicated by the bridge\u2019s LastNEndpointChangeEvent."}),"\n",(0,i.jsx)(t.li,{children:"When the bridge sends an EndpointConnectivityStatusChangeEvent indicating that the remote endpoint is no longer active, i.e., when the bridge has not received media from the remote endpoint for more than 3 secs."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"ghostninja",children:"GHOST/NINJA"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"When the user stops receiving video for the remote endpoint even when the endpoint is not video muted and it is not in LastN as indicated by the bridge\u2019s LastNEndpointChangeEvent. This means that the bridge decided to suspend the video for this user. Bridge takes into consideration the available downlink bandwidth for the receiving endpoint and the number of video streams requested using the channelLast setting."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"target-bitrates-expected-for-the-video-streams",children:"Target bitrates expected for the video streams"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"CodecType"}),(0,i.jsx)(t.th,{children:"180p (in Kbps)"}),(0,i.jsx)(t.th,{children:"360p (in Kbps)"}),(0,i.jsx)(t.th,{children:"720p (in Kbps)"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"VP8"}),(0,i.jsx)(t.td,{children:"200"}),(0,i.jsx)(t.td,{children:"500"}),(0,i.jsx)(t.td,{children:"1500"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"VP9"}),(0,i.jsx)(t.td,{children:"100"}),(0,i.jsx)(t.td,{children:"300"}),(0,i.jsx)(t.td,{children:"1200"})]})]})]})]})}function c(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var i=n(6540);const s={},d=i.createContext(s);function r(e){const t=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(d.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[9418],{9204:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>c,frontMatter:()=>d,metadata:()=>o,toc:()=>h});var i=n(4848),s=n(8453);const d={id:"client connection status indicators",title:"Client Connection Status Indicators"},r=void 0,o={id:"user-guide/client connection status indicators",title:"Client Connection Status Indicators",description:"This document explains what the different connection quality indicators on the video thumbnails actually mean.",source:"@site/docs/user-guide/client-connection-status-indicators.md",sourceDirName:"user-guide",slug:"/user-guide/client connection status indicators",permalink:"/handbook/docs/user-guide/client connection status indicators",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/user-guide/client-connection-status-indicators.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"client connection status indicators",title:"Client Connection Status Indicators"}},a={},h=[{value:"GOOD",id:"good",level:2},{value:"NON-OPTIMAL",id:"non-optimal",level:2},{value:"POOR",id:"poor",level:2},{value:"LOST",id:"lost",level:2},{value:"GHOST/NINJA",id:"ghostninja",level:2},{value:"Target bitrates expected for the video streams",id:"target-bitrates-expected-for-the-video-streams",level:2}];function l(e){const t={h2:"h2",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"This document explains what the different connection quality indicators on the video thumbnails actually mean."}),"\n",(0,i.jsx)(t.h2,{id:"good",children:"GOOD"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"With video enabled, when the send bitrate for the video stream is at least 50% of the target bitrate expected for the stream. Please refer to the target bitrates table below."}),"\n",(0,i.jsx)(t.li,{children:"With video disabled or screen sharing is in progress, when the downstream packet loss is less than 6%."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"non-optimal",children:"NON-OPTIMAL"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"With video enabled, when the send bitrate for the video stream is at least 30% of the target bitrate expected for the stream. Please refer to the target bitrates table below."}),"\n",(0,i.jsx)(t.li,{children:"With video disabled or screen sharing is in progress, when the downstream packet loss is between 6% and 8%."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"poor",children:"POOR"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"With video enabled, when the send bitrate for the video stream is at least 10% of the target bitrate expected for the stream. Please refer to the target bitrates table below."}),"\n",(0,i.jsx)(t.li,{children:"With video disabled or screen sharing is in progress, when the downstream packet loss is between 8% and 12%."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"lost",children:"LOST"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"When the user stops receiving video for the remote endpoint even when the endpoint is not video muted and it is in LastN as indicated by the bridge\u2019s LastNEndpointChangeEvent."}),"\n",(0,i.jsx)(t.li,{children:"When the bridge sends an EndpointConnectivityStatusChangeEvent indicating that the remote endpoint is no longer active, i.e., when the bridge has not received media from the remote endpoint for more than 3 secs."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"ghostninja",children:"GHOST/NINJA"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"When the user stops receiving video for the remote endpoint even when the endpoint is not video muted and it is not in LastN as indicated by the bridge\u2019s LastNEndpointChangeEvent. This means that the bridge decided to suspend the video for this user. Bridge takes into consideration the available downlink bandwidth for the receiving endpoint and the number of video streams requested using the channelLast setting."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"target-bitrates-expected-for-the-video-streams",children:"Target bitrates expected for the video streams"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"CodecType"}),(0,i.jsx)(t.th,{children:"180p (in Kbps)"}),(0,i.jsx)(t.th,{children:"360p (in Kbps)"}),(0,i.jsx)(t.th,{children:"720p (in Kbps)"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"VP8"}),(0,i.jsx)(t.td,{children:"200"}),(0,i.jsx)(t.td,{children:"500"}),(0,i.jsx)(t.td,{children:"1500"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"VP9"}),(0,i.jsx)(t.td,{children:"100"}),(0,i.jsx)(t.td,{children:"300"}),(0,i.jsx)(t.td,{children:"1200"})]})]})]})]})}function c(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var i=n(6540);const s={},d=i.createContext(s);function r(e){const t=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(d.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5f85ed72.1a0bb28e.js b/assets/js/5f85ed72.6479f47b.js similarity index 99% rename from assets/js/5f85ed72.1a0bb28e.js rename to assets/js/5f85ed72.6479f47b.js index ac7d37103..317a98995 100644 --- a/assets/js/5f85ed72.1a0bb28e.js +++ b/assets/js/5f85ed72.6479f47b.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2215],{2622:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>c});var s=i(4848),l=i(8453);const t={id:"dev-guide-configuration",title:"Configuration"},a=void 0,r={id:"dev-guide/dev-guide-configuration",title:"Configuration",description:"This page describes available configuration options for Jitsi Meet. These are either set in config.js on the server",source:"@site/docs/dev-guide/configuration.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-configuration",permalink:"/handbook/docs/dev-guide/dev-guide-configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/configuration.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"dev-guide-configuration",title:"Configuration"},sidebar:"docs",previous:{title:"Flutter SDK",permalink:"/handbook/docs/dev-guide/dev-guide-flutter-sdk"},next:{title:"Overview",permalink:"/handbook/docs/devops-guide/"}},d={},c=[{value:"API",id:"api",level:2},{value:"apiLogLevels",id:"apiloglevels",level:3},{value:"buttonsWithNotifyClick",id:"buttonswithnotifyclick",level:3},{value:"customParticipantMenuButtons",id:"customparticipantmenubuttons",level:3},{value:"customToolbarButtons",id:"customtoolbarbuttons",level:3},{value:"mouseMoveCallbackInterval",id:"mousemovecallbackinterval",level:3},{value:"participantMenuButtonsWithNotifyClick",id:"participantmenubuttonswithnotifyclick",level:3},{value:"useHostPageLocalStorage",id:"usehostpagelocalstorage",level:3},{value:"Audio",id:"audio",level:2},{value:"audioLevelsInterval",id:"audiolevelsinterval",level:3},{value:"audioQuality",id:"audioquality",level:3},{value:"disableAudioLevels",id:"disableaudiolevels",level:3},{value:"disableSpeakerStatsSearch",id:"disablespeakerstatssearch",level:3},{value:"disabledSounds",id:"disabledsounds",level:3},{value:"enableNoAudioDetection",id:"enablenoaudiodetection",level:3},{value:"enableNoisyMicDetection",id:"enablenoisymicdetection",level:3},{value:"speakerStats",id:"speakerstats",level:3},{value:"speakerStatsOrder",id:"speakerstatsorder",level:3},{value:"startAudioMuted",id:"startaudiomuted",level:3},{value:"startAudioOnly",id:"startaudioonly",level:3},{value:"startSilent",id:"startsilent",level:3},{value:"startWithAudioMuted",id:"startwithaudiomuted",level:3},{value:"Breakout rooms",id:"breakout-rooms",level:2},{value:"breakoutRooms",id:"breakoutrooms",level:3},{value:"hideAddRoomButton",id:"hideaddroombutton",level:3},{value:"Callstats",id:"callstats",level:2},{value:"callStatsConfigParams",id:"callstatsconfigparams",level:3},{value:"callStatsID",id:"callstatsid",level:3},{value:"callStatsSecret",id:"callstatssecret",level:3},{value:"enableDisplayNameInStats",id:"enabledisplaynameinstats",level:3},{value:"enableEmailInStats",id:"enableemailinstats",level:3},{value:"feedbackPercentage",id:"feedbackpercentage",level:3},{value:"Transcriptions",id:"transcriptions",level:2},{value:"autoCaptionOnRecord",id:"autocaptiononrecord",level:3},{value:"preferredTranscribingLanguage",id:"preferredtranscribinglanguage",level:3},{value:"transcribeWithAppLanguage",id:"transcribewithapplanguage",level:3},{value:"transcribingEnabled",id:"transcribingenabled",level:3},{value:"transcription",id:"transcription",level:3},{value:"Connection",id:"connection",level:2},{value:"bosh*",id:"bosh",level:3},{value:"disableRtx",id:"disablertx",level:3},{value:"disableSimulcast",id:"disablesimulcast",level:3},{value:"e2ee",id:"e2ee",level:3},{value:"e2eping",id:"e2eping",level:3},{value:"enableEncodedTransformSupport",id:"enableencodedtransformsupport",level:3},{value:"enableForcedReload \ud83d\udeab",id:"enableforcedreload-",level:3},{value:"gatherStats",id:"gatherstats",level:3},{value:"hosts",id:"hosts",level:3},{value:"p2p",id:"p2p",level:3},{value:"pcStatsInterval",id:"pcstatsinterval",level:3},{value:"peopleSearchQueryTypes",id:"peoplesearchquerytypes",level:3},{value:"peopleSearchUrl",id:"peoplesearchurl",level:3},{value:"inviteServiceUrl",id:"inviteserviceurl",level:3},{value:"peopleSearchTokenLocation",id:"peoplesearchtokenlocation",level:3},{value:"useTurnUdp",id:"useturnudp",level:3},{value:"webrtcIceTcpDisable",id:"webrtcicetcpdisable",level:3},{value:"webrtcIceUdpDisable",id:"webrtciceudpdisable",level:3},{value:"websocket \ud83d\udeab",id:"websocket-",level:3},{value:"Etherpad",id:"etherpad",level:2},{value:"etherpad_base",id:"etherpad_base",level:3},{value:"openSharedDocumentOnJoin",id:"openshareddocumentonjoin",level:3},{value:"Filmstrip",id:"filmstrip",level:2},{value:"disableFilmstripAutohiding",id:"disablefilmstripautohiding",level:3},{value:"filmstrip",id:"filmstrip-1",level:3},{value:"Face Landmarks",id:"face-landmarks",level:2},{value:"faceLandmarks",id:"facelandmarks",level:3},{value:"Giphy",id:"giphy",level:2},{value:"giphy",id:"giphy-1",level:3},{value:"Gravatar",id:"gravatar",level:2},{value:"gravatar",id:"gravatar-1",level:3},{value:"gravatarBaseURL \ud83d\udeab",id:"gravatarbaseurl-",level:3},{value:"LastN",id:"lastn",level:2},{value:"channelLastN",id:"channellastn",level:3},{value:"lastNLimits \ud83d\udeab",id:"lastnlimits-",level:3},{value:"startLastN",id:"startlastn",level:3},{value:"Lobby",id:"lobby",level:2},{value:"autoKnockLobby",id:"autoknocklobby",level:3},{value:"enableLobbyChat",id:"enablelobbychat",level:3},{value:"hideLobbyButton",id:"hidelobbybutton",level:3},{value:"lobby",id:"lobby-1",level:3},{value:"Moderator",id:"moderator",level:2},{value:"disableModeratorIndicator",id:"disablemoderatorindicator",level:3},{value:"disableReactionsModeration",id:"disablereactionsmoderation",level:3},{value:"disableRemoteMute",id:"disableremotemute",level:3},{value:"Notifications",id:"notifications",level:2},{value:"notifications",id:"notifications-1",level:3},{value:"disabledNotifications",id:"disablednotifications",level:3},{value:"Participants Pane",id:"participants-pane",level:2},{value:"participantsPane",id:"participantspane",level:3},{value:"Recording",id:"recording",level:2},{value:"dropbox",id:"dropbox",level:3},{value:"fileRecordingsEnabled",id:"filerecordingsenabled",level:3},{value:"fileRecordingsServiceEnabled \ud83d\udeab",id:"filerecordingsserviceenabled-",level:3},{value:"fileRecordingsServiceSharingEnabled \ud83d\udeab",id:"filerecordingsservicesharingenabled-",level:3},{value:"hideRecordingLabel",id:"hiderecordinglabel",level:3},{value:"localRecording",id:"localrecording",level:3},{value:"recordingLimit \ud83d\udeab",id:"recordinglimit-",level:3},{value:"recordings",id:"recordings",level:3},{value:"Screen Sharing",id:"screen-sharing",level:2},{value:"desktopSharingFrameRate",id:"desktopsharingframerate",level:3},{value:"disableScreensharingVirtualBackground",id:"disablescreensharingvirtualbackground",level:3},{value:"screenshotCapture",id:"screenshotcapture",level:3},{value:"Security UI",id:"security-ui",level:2},{value:"securityUi",id:"securityui",level:3},{value:"Testing",id:"testing",level:2},{value:"testing",id:"testing-1",level:3},{value:"Video",id:"video",level:2},{value:"constraints",id:"constraints",level:3},{value:"disableAddingBackgroundImages",id:"disableaddingbackgroundimages",level:3},{value:"disableH264",id:"disableh264",level:3},{value:"disableLocalVideoFlip",id:"disablelocalvideoflip",level:3},{value:"disableSelfView",id:"disableselfview",level:3},{value:"doNotFlipLocalVideo",id:"donotfliplocalvideo",level:3},{value:"maxFullResolutionParticipants",id:"maxfullresolutionparticipants",level:3},{value:"preferH264",id:"preferh264",level:3},{value:"resolution",id:"resolution",level:3},{value:"startVideoMuted",id:"startvideomuted",level:3},{value:"startWithVideoMuted",id:"startwithvideomuted",level:3},{value:"videoQuality",id:"videoquality",level:3},{value:"Whiteboard",id:"whiteboard",level:2},{value:"whiteboard",id:"whiteboard-1",level:3}];function o(e){const n={a:"a",admonition:"admonition",code:"code",del:"del",em:"em",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["This page describes available configuration options for Jitsi Meet. These are either set in ",(0,s.jsx)(n.code,{children:"config.js"})," on the server\nside or overridden in the app."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["Options marked with \ud83d\udeab are not overwritable through ",(0,s.jsx)(n.code,{children:"configOverwrite"})]})}),"\n",(0,s.jsx)(n.admonition,{type:"warning",children:(0,s.jsx)(n.p,{children:"This page is a work in progress. Not all options are described here yet."})}),"\n",(0,s.jsx)(n.h2,{id:"api",children:"API"}),"\n",(0,s.jsx)(n.h3,{id:"apiloglevels",children:"apiLogLevels"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"Logs that should go be passed through the 'log' event if a handler is defined for it"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"apiLogLevels: ['warn', 'log', 'error', 'info', 'debug']\n"})}),"\n",(0,s.jsx)(n.h3,{id:"buttonswithnotifyclick",children:"buttonsWithNotifyClick"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsxs)(n.p,{children:["Toolbar buttons which have their click/tap event exposed through the API on ",(0,s.jsx)(n.code,{children:"toolbarButtonClicked"}),". Passing a string for the button key will prevent execution of the click/tap routine; passing an object with ",(0,s.jsx)(n.code,{children:"key"})," and ",(0,s.jsx)(n.code,{children:"preventExecution"})," flag on false will not prevent execution of the click/tap routine. Below array with mixed mode for passing the buttons."]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"buttonsWithNotifyClick: [\n 'camera',\n {\n key: 'chat',\n preventExecution: false\n },\n {\n key: 'closedcaptions',\n preventExecution: true\n },\n 'desktop',\n 'download',\n 'embedmeeting',\n 'etherpad',\n 'feedback',\n 'filmstrip',\n 'fullscreen',\n 'hangup',\n 'help',\n {\n key: 'invite',\n preventExecution: false\n },\n 'livestreaming',\n 'microphone',\n 'mute-everyone',\n 'mute-video-everyone',\n 'participants-pane',\n 'profile',\n {\n key: 'raisehand',\n preventExecution: true\n },\n 'recording',\n 'security',\n 'select-background',\n 'settings',\n 'shareaudio',\n 'sharedvideo',\n 'shortcuts',\n 'stats',\n 'tileview',\n 'toggle-camera',\n 'videoquality',\n // The add passcode button from the security dialog.\n {\n key: 'add-passcode',\n preventExecution: false\n },\n '__end'\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"customparticipantmenubuttons",children:"customParticipantMenuButtons"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array<{ icon: string; id: string; text: string; }>"})]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsxs)(n.p,{children:["A list of custom buttons that can be added to the Participant Context Menu. Each will have an icon, that can be either a base64 encoded image or the path to an image, a unique id, and a text that will be displayed alongside the icon in the menu. This custom button will trigger the ",(0,s.jsx)(n.code,{children:"participantMenuButtonClick"})," event that will have the id set to the button as the ",(0,s.jsx)(n.code,{children:"key"})," and the ",(0,s.jsx)(n.code,{children:"participantId"}),", representing the id of the participant for which the button was clicked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"customParticipantMenuButtons: [\n {\n icon: 'data:image/svg+xml;base64,...',\n id: 'custom-button',\n text: 'Custom Button'\n }\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"customtoolbarbuttons",children:"customToolbarButtons"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array<{ icon: string; id: string; text: string; }>"})]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsxs)(n.p,{children:["A list of custom buttons that can be added to the Toolbar. Each will have an icon, that can be either a base64 encoded image or the path to an image, a unique id, and a text that will be displayed alongside the icon in the menu. This custom button will trigger the ",(0,s.jsx)(n.code,{children:"toolbarButtonClicked"})," event that will the id set to the button as the ",(0,s.jsx)(n.code,{children:"key"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"customToolbarButtons: [\n {\n icon: 'data:image/svg+xml;base64,...',\n id: 'custom-toolbar-button',\n text: 'Custom Toolbar Button'\n }\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"mousemovecallbackinterval",children:"mouseMoveCallbackInterval"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsxs)(n.p,{children:["Default interval (milliseconds) for triggering ",(0,s.jsx)(n.code,{children:"mouseMoved"})," iframe API event."]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"1000"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"mouseMoveCallbackInterval: 1000\n"})}),"\n",(0,s.jsx)(n.h3,{id:"participantmenubuttonswithnotifyclick",children:"participantMenuButtonsWithNotifyClick"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsxs)(n.p,{children:["Participant context menu buttons which have their click/tap event exposed through the API on ",(0,s.jsx)(n.code,{children:"participantMenuButtonClick"}),". Passing a string for the button key will prevent execution of the click/tap routine; passing an object with ",(0,s.jsx)(n.code,{children:"key"})," and ",(0,s.jsx)(n.code,{children:"preventExecution"})," flag on false will not prevent execution of the click/tap routine. Below array with mixed mode for passing the buttons."]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"participantMenuButtonsWithNotifyClick: [\n 'allow-video',\n {\n key: 'ask-unmute',\n preventExecution: false\n },\n 'conn-status',\n 'flip-local-video',\n 'grant-moderator',\n {\n key: 'kick',\n preventExecution: true\n },\n {\n key: 'hide-self-view',\n preventExecution: false\n },\n 'mute',\n 'mute-others',\n 'mute-others-video',\n 'mute-video',\n 'pinToStage',\n 'privateMessage',\n {\n key: 'remote-control',\n preventExecution: false\n },\n 'send-participant-to-room',\n 'verify',\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"usehostpagelocalstorage",children:"useHostPageLocalStorage"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"This property is related to the use case when Jitsi Meet is used via the IFrame API. When the property is true\nJitsi Meet will use the local storage of the host page instead of its own. This option is useful if the browser\nis not persisting the local storage inside the iframe."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"useHostPageLocalStorage: true\n"})}),"\n",(0,s.jsx)(n.h2,{id:"audio",children:"Audio"}),"\n",(0,s.jsx)(n.h3,{id:"audiolevelsinterval",children:"audioLevelsInterval"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"The interval (milliseconds) at which the audio levels are calculated."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"200"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"audioLevelsInterval: 200\n"})}),"\n",(0,s.jsx)(n.h3,{id:"audioquality",children:"audioQuality"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Specify audio quality stereo and opusMaxAverageBitrate values in order to enable HD audio.\nBeware, by doing so, you are disabling echo cancellation, noise suppression and AGC."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"audioQuality: {\n stereo: false,\n opusMaxAverageBitrate: null // Value to fit the 6000 to 510000 range.\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableaudiolevels",children:"disableAudioLevels"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disable measuring of audio levels."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableAudioLevels: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablespeakerstatssearch",children:(0,s.jsx)(n.del,{children:"disableSpeakerStatsSearch"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Specifies whether there will be a search field in speaker stats or not."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"speakerStats.disableSearch"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableSpeakerStatsSearch: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disabledsounds",children:"disabledSounds"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"The sounds passed in this array will be disabled."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disabledSounds: [\n // 'ASKED_TO_UNMUTE_SOUND'\n // 'E2EE_OFF_SOUND'\n // 'E2EE_ON_SOUND'\n // 'INCOMING_MSG_SOUND'\n // 'KNOCKING_PARTICIPANT_SOUND'\n // 'LIVE_STREAMING_OFF_SOUND'\n // 'LIVE_STREAMING_ON_SOUND'\n // 'NO_AUDIO_SIGNAL_SOUND'\n // 'NOISY_AUDIO_INPUT_SOUND'\n // 'OUTGOING_CALL_EXPIRED_SOUND'\n // 'OUTGOING_CALL_REJECTED_SOUND'\n // 'OUTGOING_CALL_RINGING_SOUND'\n // 'OUTGOING_CALL_START_SOUND'\n // 'PARTICIPANT_JOINED_SOUND'\n // 'PARTICIPANT_LEFT_SOUND'\n // 'RAISE_HAND_SOUND'\n // 'REACTION_SOUND'\n // 'RECORDING_OFF_SOUND'\n // '_ON_SOUND'\n // 'TALK_WHILE_MUTED_SOUND'\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enablenoaudiodetection",children:"enableNoAudioDetection"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enabling this will run the lib-jitsi-meet no audio detection module which\nwill notify the user if the current selected microphone has no audio\ninput and will suggest another valid device if one is present."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"true"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableNoAudioDetection: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enablenoisymicdetection",children:"enableNoisyMicDetection"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enabling this will run the lib-jitsi-meet noise detection module which will\nnotify the user if there is noise, other than voice, coming from the current\nselected microphone. The purpose it to let the user know that the input could\nbe potentially unpleasant for other meeting participants."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"true"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableNoisyMicDetection: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"speakerstats",children:"speakerStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the speaker stats feature."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disabled"})," - Specifies whether the speaker stats is enable or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableSearch"})," - Specifies whether there will be a search field in speaker stats or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"order"})," - Specifies whether participants in speaker stats should be ordered or not, and with what priority."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"speakerStats: {\n disabled: false,\n disableSearch: false,\n order: [\n 'role', // Moderators on top.\n 'name', // Alphabetically by name.\n 'hasLeft', // The ones that have left in the bottom.\n ], // the order of the array elements determines priority.\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"speakerstatsorder",children:(0,s.jsx)(n.del,{children:"speakerStatsOrder"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"Specifies whether participants in speaker stats should be ordered or not, and with what priority."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"speakerStats.order"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Default:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:" speakerStatsOrder: [\n 'role', // Moderators on top.\n 'name', // Alphabetically by name.\n 'hasLeft', // The ones that have left in the bottom.\n ], // the order of the array elements determines priority.\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startaudiomuted",children:"startAudioMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Every participant after the Nth will start audio muted."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startAudioMuted: 10\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startaudioonly",children:"startAudioOnly"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Start the conference in audio only mode (no video is being received nor sent)."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startAudioOnly: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startsilent",children:"startSilent"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enabling it (with #params) will disable local audio output of remote\nparticipants and to enable it back a reload is needed."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startSilent: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startwithaudiomuted",children:"startWithAudioMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Start calls with audio muted. This option is only applied locally."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startWithAudioMuted: false\n"})}),"\n",(0,s.jsx)(n.h2,{id:"breakout-rooms",children:"Breakout rooms"}),"\n",(0,s.jsx)(n.h3,{id:"breakoutrooms",children:"breakoutRooms"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the breakout rooms feature."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideAddRoomButton"})," - Hides the add breakout room button. This replaces ",(0,s.jsx)(n.code,{children:"hideAddRoomButton"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideAutoAssignButton"})," - Hides the auto assign participants button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideJoinRoomButton"})," - Hides the join breakout room button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideModeratorSettingsTab"})," - Hides the button to open the moderator settings tab."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMoreActionsButton"})," - Hides the more actions button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMuteAllButton"})," - Hides the mute all button."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"breakoutRooms: {\n hideAddRoomButton: false,\n hideAutoAssignButton: false,\n hideJoinRoomButton: false\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hideaddroombutton",children:(0,s.jsx)(n.del,{children:"hideAddRoomButton"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"breakoutRooms.hideAddRoomButton"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Hides add breakout room button."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hideAddRoomButton: false\n"})}),"\n",(0,s.jsx)(n.h2,{id:"callstats",children:"Callstats"}),"\n",(0,s.jsx)(n.h3,{id:"callstatsconfigparams",children:"callStatsConfigParams"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsxs)(n.p,{children:["The callstats initialize config params as described in the API ",(0,s.jsx)(n.a,{href:"https://docs.callstats.io/docs/javascript#callstatsinitialize-with-app-secret",children:"here"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'callStatsConfigParams: {\n disableBeforeUnloadHandler: true, // disables callstats.js\'s window.onbeforeunload parameter.\n applicationVersion: "app_version", // Application version specified by the developer.\n disablePrecalltest: true, // disables the pre-call test, it is enabled by default.\n siteID: "siteID", // The name/ID of the site/campus from where the call/pre-call test is made.\n additionalIDs: { // additionalIDs object, contains application related IDs.\n customerID: "Customer Identifier. Example, walmart.",\n tenantID: "Tenant Identifier. Example, monster.",\n productName: "Product Name. Example, Jitsi.",\n meetingsName: "Meeting Name. Example, Jitsi loves callstats.",\n serverName: "Server/MiddleBox Name. Example, jvb-prod-us-east-mlkncws12.",\n pbxID: "PBX Identifier. Example, walmart.",\n pbxExtensionID: "PBX Extension Identifier. Example, 5625.",\n fqExtensionID: "Fully qualified Extension Identifier. Example, +71 (US) +5625.",\n sessionID: "Session Identifier. Example, session-12-34"\n },\n collectLegacyStats: true, //enables the collection of legacy stats in chrome browser\n collectIP: true //enables the collection localIP address\n}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"callstatsid",children:"callStatsID"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"You must provide the Application ID to enable sending statistics to callstats.io"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"callStatsID: 'my-callstats-app-id'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"callstatssecret",children:"callStatsSecret"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"You must provide the Secret to enable sending statistics to callstats.io"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"callStatsSecret: 'my-callstats-secret'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enabledisplaynameinstats",children:"enableDisplayNameInStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enables sending participants' display names to callstats."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableDisplayNameInStats: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enableemailinstats",children:"enableEmailInStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enables sending participants' emails (if available) to callstats and other analytics"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableEmailInStats: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"feedbackpercentage",children:"feedbackPercentage"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Controls the percentage of automatic feedback shown to participants when callstats is enabled.\nThe default value is 100%. If set to 0, no automatic feedback will be requested"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"feedbackPercentage: 100\n"})}),"\n",(0,s.jsx)(n.h2,{id:"transcriptions",children:"Transcriptions"}),"\n",(0,s.jsx)(n.h3,{id:"autocaptiononrecord",children:"autoCaptionOnRecord"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.autoTranscribeOnRecord"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"preferredtranscribinglanguage",children:"preferredTranscribingLanguage"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.preferredLanguage"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"transcribewithapplanguage",children:"transcribeWithAppLanguage"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.useAppLanguage"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"transcribingenabled",children:"transcribingEnabled"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.enabled"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"transcription",children:"transcription"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Transcription related options."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Enable transcription (in interface_config, subtitles and buttons can be configured). Default ",(0,s.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"translationLanguages"})," - Translation languages. Available languages can be found in ./lang/translation-languages.json."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"useAppLanguage"})," - If ",(0,s.jsx)(n.code,{children:"true"})," the transcriber will use the application language. The application language is either explicitly set by participants in their settings or automatically detected based on the environment, e.g. if the app is opened in a Chrome instance which is using French as its default language then transcriptions for that participant will be in french. Default: ",(0,s.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"preferredLanguage"})," - Transcriber language. This settings will only work if ",(0,s.jsx)(n.code,{children:"useAppLanguage"})," is explicitly set to ",(0,s.jsx)(n.code,{children:"false"}),". Available languages can be found ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/react/features/transcribing/transcriber-langs.json",children:"here"}),". Default: ",(0,s.jsx)(n.code,{children:"'en-US'"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"autoTranscribeOnRecord"})," - Enables automatic turning on transcribing when recording is started. Default: ",(0,s.jsx)(n.code,{children:"true"}),"."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"transcription: {\n enabled: true,\n translationLanguages: ['en-US', 'es'],\n useAppLanguage: false,\n preferredLanguage: 'en-US',\n autoTranscribeOnRecord: true\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"connection",children:"Connection"}),"\n",(0,s.jsx)(n.h3,{id:"bosh",children:"bosh*"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"The BOSH URL."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"bosh: '//jitsi-meet.example.com/http-bind'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablertx",children:"disableRtx"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables or enables RTX (RFC 4588)."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableRtx: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablesimulcast",children:"disableSimulcast"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enable / disable simulcast support."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableSimulcast: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"e2ee",children:"e2ee"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Configure End-to-End Encryption."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"e2ee: {\n labels: {\n labelTooltip: 'Tooltip',\n description: 'Description',\n label: 'E2EE',\n warning: 'Warning'\n },\n externallyManagedKey: false\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"e2eping",children:"e2eping"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to end-to-end (participant to participant) ping."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Whether end-to-end pings should be enabled."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"numRequests"})," - The number of responses to wait for."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"maxConferenceSize"})," - The max conference size in which e2e pings will be sent."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"maxMessagesPerSecond"})," - The maximum number of e2e ping messages per second for the whole conference to aim for.\nThis is used to contol the pacing of messages in order to reduce the load on the backend."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"e2eping: {\n enabled: false,\n numRequests: 5,\n maxConferenceSize: 200,\n maxMessagesPerSecond: 250\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enableencodedtransformsupport",children:"enableEncodedTransformSupport"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["Enable support for encoded transform in supported browsers. This allows\nE2EE to work in Safari if the corresponding flag is enabled in the browser.\n",(0,s.jsx)(n.strong,{children:"Experimental"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableEncodedTransformSupport: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enableforcedreload-",children:"enableForcedReload \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enables forced reload of the client when the call is migrated as a result of\nthe bridge going down."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableForcedReload: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"gatherstats",children:"gatherStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to enable stats collection or not in the ",(0,s.jsx)(n.code,{children:"TraceablePeerConnection"}),".\nThis can be useful for debugging purposes (post-processing/analysis of\nthe WebRTC stats) as it is done in the jitsi-meet-torture bandwidth\nestimation tests."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"gatherStats: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hosts",children:"hosts"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"URLs for the app connection."}),"\n",(0,s.jsx)(n.p,{children:"Properties"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"domain"})," - XMPP domain"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"anonymousdomain"})," - When using authentication, domain for guest users."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"authdomain"})," - Domain for authenticated users. Defaults to ",(0,s.jsx)(n.code,{children:"domain"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"focus"})," - Focus component domain. Defaults to ",(0,s.jsxs)(n.strong,{children:["focus.",(0,s.jsx)(n.code,{children:"domain"})]}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"muc"})," - XMPP MUC domain."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hosts: {\n domain: 'jitsi-meet.example.com',\n anonymousdomain: 'guest.example.com',\n authdomain: 'jitsi-meet.example.com',\n focus: 'focus.jitsi-meet.example.com',\n muc: 'conference.jitsi-meet.example.com'\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"p2p",children:"p2p"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Peer-To-Peer mode: used (if enabled) when there are just 2 participants."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Enables peer to peer mode. When enabled the system will try to\nestablish a direct connection when there are exactly 2 participants\nin the room. If that succeeds the conference will stop sending data\nthrough the JVB and use the peer to peer connection instead. When a\n3rd participant joins the conference will be moved back to the JVB\nconnection."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"iceTransportPolicy"})," - Sets the ICE transport policy for the p2p connection. At the time\nof this writing the list of possible values are ",(0,s.jsx)(n.code,{children:"all"})," and ",(0,s.jsx)(n.code,{children:"relay"}),",\nbut that is subject to change in the future. The enum is defined in\nthe ",(0,s.jsx)(n.a,{href:"https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum",children:"WebRTC standard"}),".\nIf not set, the effective value is ",(0,s.jsx)(n.code,{children:"all"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," - Provides a way to set the codec preference on desktop based endpoints."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," - Provides a way to set the codec preference on mobile devices, both on RN and mobile browser based endpoints."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"preferredCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disabledCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"backToP2PDelay"})," - How long we're going to wait, before going back to P2P after the 3rd\nparticipant has left the conference (to filter out page reload)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"stunServers"})," - The STUN servers that will be used in the peer to peer connections."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"p2p: {\n enabled: true,\n enableUnifiedOnChrome: false,\n iceTransportPolicy: 'all',\n backToP2PDelay: 5,\n stunServers: [\n { urls: 'stun:jitsi-meet.example.com:3478' },\n { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' }\n ]\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"pcstatsinterval",children:"pcStatsInterval"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"The interval at which PeerConnection.getStats() is called."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"10000"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"pcStatsInterval: 50000\n"})}),"\n",(0,s.jsx)(n.h3,{id:"peoplesearchquerytypes",children:"peopleSearchQueryTypes"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:'The entity types which are queriable when inviting people in a room. Valid values are "phone", "room", "sip", "user", "videosipgw" and "email". Authentication for Jitsi entity types is done by passing a jwt, authentication for external entity types (e. g. email) is done by passing an alternative token (e. g. peopleSearchTokenLocation).'}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"[]"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'peopleSearchQueryTypes: ["user", "email"]\n'})}),"\n",(0,s.jsx)(n.h3,{id:"peoplesearchurl",children:"peopleSearchUrl"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Directory endpoint which is called for invite dialog autocomplete. Expected response format is an array of objects. Each object should be formatted as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"{\n id: int,\n type: string, # the entity type (phone, room, user, email etc.),\n name: string, # the entity display name\n avatar?: string, # full URL to the entity picture, not mandatory\n number?: string, # required for phone numbers\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:'""'})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'peopleSearchUrl: "https://myservice.com/api/people"\n'})}),"\n",(0,s.jsx)(n.h3,{id:"inviteserviceurl",children:"inviteServiceUrl"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Endpoint which is called to send invitation requests. The request is made in POST and contains as a POST body an array of objects formatted the same as the peopleSearchUrl response body."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:'""'})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'inviteServiceUrl: "https://myservice.com/api/invite"\n'})}),"\n",(0,s.jsx)(n.h3,{id:"peoplesearchtokenlocation",children:"peopleSearchTokenLocation"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Useful for authentication against directories holding entities which don't exist in Prosody (e. g. email). This indicates the localStorage key where the alternate authentication token value is to be found. This alternate token will be used if the JWT value is not set. It will be sent in the Authorization: Bearer header, as the JWT would have been."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:'""'})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'peopleSearchTokenLocation: "service_token"\n'})}),"\n",(0,s.jsx)(n.h3,{id:"useturnudp",children:"useTurnUdp"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Use TURN/UDP servers for the jitsi-videobridge connection (by default\nwe filter out TURN/UDP because it is usually not needed since the\nbridge itself is reachable via UDP)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"useTurnUdp: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"webrtcicetcpdisable",children:"webrtcIceTcpDisable"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables ICE/TCP by filtering out local and remote TCP candidates in signalling."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"webrtcIceTcpDisable: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"webrtciceudpdisable",children:"webrtcIceUdpDisable"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables ICE/UDP by filtering out local and remote UDP candidates in signalling."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"webrtcIceUdpDisable: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"websocket-",children:"websocket \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Websocket URL"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"websocket: 'wss://jitsi-meet.example.com/xmpp-websocket'\n"})}),"\n",(0,s.jsx)(n.h2,{id:"etherpad",children:"Etherpad"}),"\n",(0,s.jsx)(n.h3,{id:"etherpad_base",children:"etherpad_base"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:'If set, it adds a "Open shared document" link to the bottom right menu that\nwill open an etherpad document.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"etherpad_base: 'https://your-etherpad-installati.on/p/'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"openshareddocumentonjoin",children:"openSharedDocumentOnJoin"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["If etherpad integration is enabled, setting this to ",(0,s.jsx)(n.code,{children:"true"})," will\nautomatically open the etherpad when a participant joins. This\ndoes not affect the mobile app since opening an etherpad\nobscures the conference controls -- it's better to let users\nchoose to open the pad on their own in that case."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"openSharedDocumentOnJoin: false\n"})}),"\n",(0,s.jsx)(n.h2,{id:"filmstrip",children:"Filmstrip"}),"\n",(0,s.jsx)(n.h3,{id:"disablefilmstripautohiding",children:"disableFilmstripAutohiding"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Prevents the filmstrip from autohiding when screen width is under a certain threshold"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableFilmstripAutohiding: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filmstrip-1",children:"filmstrip"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the filmstrip."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableResizable"})," - Disables user resizable filmstrip. This also allows configuration of the filmstrip\n(width, tiles aspect ratios) through the interfaceConfig options."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableStageFilmstrip"})," - Disables the stage filmstrip (displaying multiple\nparticipants on stage besides the vertical filmstrip)"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"filmstrip: {\n disableResizable: true,\n disableStageFilmstrip: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"face-landmarks",children:"Face Landmarks"}),"\n",(0,s.jsx)(n.h3,{id:"facelandmarks",children:"faceLandmarks"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the face landmarks features."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableFaceCentering"})," - Enables centering faces within a video by sharing face coordinates."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableFaceExpressionsDetection"})," - Enables detecting face expressions from video."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableDisplayFaceExpressions"})," - Enables displaying face expressions in speaker stats."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableRTCStats"})," - Enables anonymized stats collection for face landmarks."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"faceCenteringThreshold"})," - Minimum required face movement percentage threshold for sending new face centering coordinates data."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"captureInterval"})," - Milliseconds for processing a new image capture in order to detect face landmarks."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"faceLandmarks: {\n enableFaceCentering: false,\n enableFaceExpressionsDetection: false,\n enableDisplayFaceExpressions: false,\n enableRTCStats: false,\n faceCenteringThreshold: 20,\n captureInterval: 1000\n},\n"})}),"\n",(0,s.jsx)(n.h2,{id:"giphy",children:"Giphy"}),"\n",(0,s.jsx)(n.h3,{id:"giphy-1",children:"giphy"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Setup for the Giphy integration."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Whether the feature is enabled or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"sdkKey"})," - SDK API Key from Giphy."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"displayMode"})," - Display mode can be one of:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tile"})," - show the GIF on the tile of the participant that sent it."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"chat"})," - show the GIF as a message in chat."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"all"})," - all of the above. This is the default option."]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tileTime"})," - How long the GIF should be displayed on the tile (in milliseconds)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"rating"})," - Limit results by audience rating:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"g"})," - broadly accepted as appropriate in a public environment. This is the default option."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pg"})," - commonly witnessed in a public environment, but not as broadly accepted as appropriate."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pg-13"})," - typically not seen unless sought out, but still commonly witnessed."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"r"})," - typically not seen unless sought out, and could be considered alarming if witnessed."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"giphy: {\n enabled: true,\n sdkKey: 'example-key',\n displayMode: 'tile',\n tileTime: 7000,\n rating: 'pg'\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"gravatar",children:"Gravatar"}),"\n",(0,s.jsx)(n.h3,{id:"gravatar-1",children:"gravatar"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Setup for Gravatar-compatible services."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"baseUrl"})," \ud83d\udeab - Base URL for a Gravatar-compatible service. Defaults to Gravatar."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disabled"})," - True if Gravatar should be disabled."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"gravatar: {\n baseUrl: 'https://www.gravatar.com/avatar/',\n disabled: false\n}\n"})}),"\n",(0,s.jsxs)(n.h3,{id:"gravatarbaseurl-",children:[(0,s.jsx)(n.del,{children:"gravatarBaseURL"})," \ud83d\udeab"]}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"gravatar.baseUrl"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Base URL for a Gravatar-compatible service."}),"\n",(0,s.jsxs)(n.p,{children:["Default: '",(0,s.jsx)(n.a,{href:"https://www.gravatar.com/avatar/",children:"https://www.gravatar.com/avatar/"}),"'"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"gravatarBaseURL: 'https://www.gravatar.com/avatar/'\n"})}),"\n",(0,s.jsx)(n.h2,{id:"lastn",children:"LastN"}),"\n",(0,s.jsx)(n.h3,{id:"channellastn",children:"channelLastN"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:'Default value for the channel "last N" attribute. -1 for unlimited.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"channelLastN: -1\n"})}),"\n",(0,s.jsx)(n.h3,{id:"lastnlimits-",children:"lastNLimits \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:'Provides a way to use different "last N" values based on the number of participants in the conference.\nThe keys in an Object represent number of participants and the values are "last N" to be used when number of\nparticipants gets to or above the number.'}),"\n",(0,s.jsx)(n.p,{children:"For the given example mapping, \"last N\" will be set to 20 as long as there are at least 5, but less than\n29 participants in the call and it will be lowered to 15 when the 30th participant joins. The 'channelLastN'\nwill be used as default until the first threshold is reached."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"lastNLimits: {\n 5: 20,\n 30: 15,\n 50: 10,\n 70: 5,\n 90: 2\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startlastn",children:"startLastN"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:'Provides a way for the lastN value to be controlled through the UI.\nWhen startLastN is present, conference starts with a last-n value of startLastN and channelLastN\nvalue will be used when the quality level is selected using "Manage Video Quality" slider.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startLastN: 1\n"})}),"\n",(0,s.jsx)(n.h2,{id:"lobby",children:"Lobby"}),"\n",(0,s.jsx)(n.h3,{id:"autoknocklobby",children:(0,s.jsx)(n.del,{children:"autoKnockLobby"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"lobby.autoKnock"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"If Lobby is enabled starts knocking automatically."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"autoKnockLobby: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enablelobbychat",children:(0,s.jsx)(n.del,{children:"enableLobbyChat"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"lobby.enableChat"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Enable lobby chat."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableLobbyChat: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hidelobbybutton",children:(0,s.jsx)(n.del,{children:"hideLobbyButton"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"securityUi.hideLobbyButton"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Hide the lobby button."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hideLobbyButton: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"lobby-1",children:"lobby"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the lobby screen."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"autoKnock"})," - If the lobby is enabled, it starts knocking automatically. Replaces ",(0,s.jsx)(n.code,{children:"autoKnockLobby"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableChat"})," - Enables the lobby chat. Replaces ",(0,s.jsx)(n.code,{children:"enableLobbyChat"}),"."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"lobby: {\n autoKnock: true,\n enableChat: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"moderator",children:"Moderator"}),"\n",(0,s.jsx)(n.h3,{id:"disablemoderatorindicator",children:"disableModeratorIndicator"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Hides the moderator indicators."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableModeratorIndicator: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablereactionsmoderation",children:"disableReactionsModeration"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables the moderation of reactions feature."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableReactionsModeration: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableremotemute",children:"disableRemoteMute"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables muting operations of remote participants."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableRemoteMute: true\n"})}),"\n",(0,s.jsx)(n.h2,{id:"notifications",children:"Notifications"}),"\n",(0,s.jsx)(n.h3,{id:"notifications-1",children:"notifications"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"Use this array to configure which notifications will be shown to the user.\nThe items correspond to the title or description key of that notification.\nSome of these notifications also depend on some other internal logic to be displayed or not,\nso adding them here will not ensure they will always be displayed."}),"\n",(0,s.jsx)(n.p,{children:"A falsy value for this prop will result in having all notifications enabled (e.g null, undefined, false)."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"notifications: []\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablednotifications",children:"disabledNotifications"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"List of notifications to be disabled. Works in tandem with the above setting."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disabledNotifications: [\n 'notify.chatMessages', // shown when receiving chat messages while the chat window is closed\n 'notify.grantedTo', // shown when moderator rights were granted to a participant\n]\n"})}),"\n",(0,s.jsx)(n.h2,{id:"participants-pane",children:"Participants Pane"}),"\n",(0,s.jsx)(n.h3,{id:"participantspane",children:"participantsPane"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the participants pane."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideModeratorSettingsTab"})," - Hides the button to open the moderator settings tab."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMoreActionsButton"})," - Hides the more actions button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMuteAllButton"})," - Hides the mute all button."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"participantsPane: {\n hideModeratorSettingsTab: false,\n hideMoreActionsButton: false,\n hideMuteAllButton: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"recording",children:"Recording"}),"\n",(0,s.jsx)(n.h3,{id:"dropbox",children:"dropbox"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Enable the dropbox integration."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"appKey"})," - Your APP Key."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"redirectURI"})," - A URL to redirect the user to, after authenticating by default uses"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"dropbox: {\n appKey: 'DROPBOX_APP_KEY',\n redirectURI: 'https://jitsi-meet.example.com/subfolder/static/oauth.html'\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filerecordingsenabled",children:"fileRecordingsEnabled"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether to enable file recording or not."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"fileRecordingsEnabled: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filerecordingsserviceenabled-",children:"fileRecordingsServiceEnabled \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"When integrations like dropbox are enabled only that will be shown,\nby enabling fileRecordingsServiceEnabled, we show both the integrations\nand the generic recording service (its configuration and storage type\ndepends on jibri configuration)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"fileRecordingsServiceEnabled: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filerecordingsservicesharingenabled-",children:"fileRecordingsServiceSharingEnabled \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether to show the possibility to share file recording with other people\n(e.g. meeting participants), based on the actual implementation\non the backend."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"fileRecordingsServiceSharingEnabled: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hiderecordinglabel",children:"hideRecordingLabel"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Set recording label to auto hide instead of staying always on screen."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hideRecordingLabel: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"localrecording",children:"localRecording"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Set local recording configuration."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disable"})," - Whether to disable the feature or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"notifyAllParticipants"})," - Whether to notify all the participants when a local recording is started."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"localRecording: {\n disable: false,\n notifyAllParticipants: true\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"recordinglimit-",children:"recordingLimit \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for the recording limit notification."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"limit"})," - The recording limit in minutes. Note: This number appears in the notification text\nbut doesn't enforce the actual recording time limit. This should be configured in jibri!"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"appName"})," = The name of the app with unlimited recordings."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"appURL"})," - The URL of the app with unlimited recordings."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"recordingLimit: {\n limit: 60,\n appName: 'Unlimited recordings APP',\n appURL: 'https://unlimited.recordings.app.com/'\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"recordings",children:"recordings"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for the recordings features."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"recordAudioAndVideo"})," - If true (default) recording audio and video is selected by default in the recording dialog."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"suggestRecording"})," - If true, shows a notification at the start of the meeting with a call to action button to start recording (for users who can do so)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"showPrejoinWarning"})," - If true, shows a warning label in the prejoin screen to point out the possibility that the call you're joining might be recorded."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"showRecordingLink"})," - If true, the notification for recording start will display a link to download the cloud recording."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"recordings: {\n recordAudioAndVideo: true,\n suggestRecording: false,\n showPrejoinWarning: true,\n showRecordingLink: true\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"screen-sharing",children:"Screen Sharing"}),"\n",(0,s.jsx)(n.h3,{id:"desktopsharingframerate",children:"desktopSharingFrameRate"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Optional desktop sharing frame rate options"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"{ min: 5, max: 5 }"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"desktopSharingFrameRate: {\n min: 3,\n max: 10\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablescreensharingvirtualbackground",children:"disableScreensharingVirtualBackground"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables using screensharing as virtual background."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableScreensharingVirtualBackground: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"screenshotcapture",children:"screenshotCapture"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for the screenshot capture feature."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Enables the feature"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mode"})," - The mode for the screenshot capture feature. Can be either 'recording' - screensharing screenshots\nare taken only when the recording is also on, or 'always' - screensharing screenshots are always taken."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"screenshotCapture: {\n enabled: true,\n mode: 'recording'\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"security-ui",children:"Security UI"}),"\n",(0,s.jsx)(n.h3,{id:"securityui",children:"securityUi"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options regarding the security-related UI elements."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideLobbyButton"})," - Hides the lobby button. Replaces ",(0,s.jsx)(n.code,{children:"hideLobbyButton"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableLobbyPassword"})," - Hides the possibility to set and enter a lobby password."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"securityUi: {\n hideLobbyButton: true,\n disableLobbyPassword: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"testing",children:"Testing"}),"\n",(0,s.jsx)(n.h3,{id:"testing-1",children:"testing"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Experimental features."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"assumeBandwidth"})," - Allows the setting of a custom bandwidth value from the UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableE2EE"})," - Disables the End to End Encryption feature. Useful for debugging issues related to insertable streams."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mobileXmppWsThreshold"})," - Enables XMPP WebSocket (as opposed to BOSH) for the given amount of users."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"p2pTestMode"})," - P2P test mode disables automatic switching to P2P when there are 2 participants in the conference."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"testMode"})," - Enables the test specific features consumed by jitsi-meet-torture."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"noAutoPlayVideo"})," - Disables the auto-play behavior of ",(0,s.jsx)(n.em,{children:"all"})," newly created video element. This is useful when the client runs on a host with limited resources."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"testing: {\n assumeBandwidth: true,\n disableE2EE: false,\n mobileXmppWsThreshold: 10, // enable XMPP WebSockets on mobile for 10% of the users\n p2pTestMode: false,\n testMode: false,\n noAutoPlayVideo: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"video",children:"Video"}),"\n",(0,s.jsx)(n.h3,{id:"constraints",children:"constraints"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsxs)(n.p,{children:["W3C spec-compliant video constraints to use for video capture. Currently\nused by browsers that return true from lib-jitsi-meet's\n",(0,s.jsx)(n.code,{children:"util#browser#usesNewGumFlow"}),". The constraints are independent of\nthis config's resolution value. Defaults to requesting an ideal\nresolution of 720p."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"constraints: {\n video: {\n height: {\n ideal: 720,\n max: 720,\n min: 240\n }\n }\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableaddingbackgroundimages",children:"disableAddingBackgroundImages"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"When true the user cannot add more images to be used as a virtual background.\nOnly the default ones will be available."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableAddingBackgroundImages: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableh264",children:"disableH264"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"If set to true, disable the H.264 video codec by stripping it out of the SDP."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableH264: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablelocalvideoflip",children:"disableLocalVideoFlip"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disable the Flip video option from the context menu for local video."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableLocalVideoFlip: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableselfview",children:"disableSelfView"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables self-view tile. (hides it from tile view and filmstrip)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableSelfView: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"donotfliplocalvideo",children:"doNotFlipLocalVideo"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["A property used to unset the default flip state of the local video.\nWhen it is set to ",(0,s.jsx)(n.code,{children:"true"}),", the local(self) video will not be mirrored anymore."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"doNotFlipLocalVideo: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"maxfullresolutionparticipants",children:"maxFullResolutionParticipants"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["How many participants while in the tile view mode, before the receiving video quality is reduced from HD to SD?\nUse ",(0,s.jsx)(n.code,{children:"-1"})," to disable."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"maxFullResolutionParticipants: 5\n"})}),"\n",(0,s.jsx)(n.h3,{id:"preferh264",children:(0,s.jsx)(n.del,{children:"preferH264"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"preferredCodec"})," under the ",(0,s.jsx)(n.code,{children:"videoQuality"})," section instead."]}),"\n",(0,s.jsx)(n.p,{children:"Prefer to use the H.264 video codec (if supported).\nNote that it's not recommended to do this because simulcast is not\nsupported when using H.264. For 1-to-1 calls this setting is enabled by\ndefault and can be toggled in the p2p section."}),"\n",(0,s.jsx)(n.h3,{id:"resolution",children:"resolution"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Sets the preferred resolution (height) for local video"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"720"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"resolution: 1080\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startvideomuted",children:"startVideoMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Every participant after the Nth will start the video muted."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startVideoMuted: 5\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startwithvideomuted",children:"startWithVideoMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Start calls with video muted. Only applied locally."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startWithVideoMuted: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"videoquality",children:"videoQuality"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Specify the settings for video quality optimizations on the client."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," - Provides a way to set the codec preference on desktop-based endpoints."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"codecPreferenceOrder: [ 'AV1', 'VP9', 'VP8', 'H264' ],\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," - Provides a way to set the codec preference on mobile devices, both on RN and mobile browser-based endpoints."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"codecPreferenceOrder: [ 'VP8', 'H264', 'VP9' ],\n"})}),"\n",(0,s.jsx)(n.p,{children:"Codec specific settings for scalability modes and max bitrates."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"av1: {\n maxBitratesVideo: {\n low: 100000,\n standard: 300000,\n high: 1000000,\n fullHd: 2000000,\n ultraHd: 4000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: true,\n useSimulcast: false,\n useKSVC: true\n},\nh264: {\n maxBitratesVideo: {\n low: 200000,\n standard: 500000,\n high: 1500000,\n fullHd: 3000000,\n ultraHd: 6000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: true\n},\nvp8: {\n maxBitratesVideo: {\n low: 200000,\n standard: 500000,\n high: 1500000,\n fullHd: 3000000,\n ultraHd: 6000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: false\n},\nvp9: {\n maxBitratesVideo: {\n low: 100000,\n standard: 300000,\n high: 1200000,\n fullHd: 2500000,\n ultraHd: 5000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: true,\n useSimulcast: false,\n useKSVC: true\n},\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"disabledCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"preferredCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"minHeightForQualityLvl"})," - The options can be used to override default thresholds of video thumbnail heights corresponding to\nthe video quality levels used in the application. At the time of this writing, the allowed levels are:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"low"})," - for the low-quality level (180p at the time of this writing)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"standard"})," - for the medium quality level (360p)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"high"})," - for the high-quality level (720p)"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The keys should be positive numbers which represent the minimal thumbnail height for the quality level.\nWith the default config value below the application will use 'low' quality until the thumbnails are\nat least 360 pixels tall. If the thumbnail height reaches 720 pixels then the application will switch to\nthe high quality."}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"whiteboard",children:"Whiteboard"}),"\n",(0,s.jsx)(n.h3,{id:"whiteboard-1",children:"whiteboard"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the Excalidraw whiteboard integration."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Whether the feature is enabled or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"collabServerBaseUrl"})," - The ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/excalidraw-backend",children:"server"})," used to support whiteboard collaboration."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"userLimit"})," - The user access limit to the whiteboard, introduced as a means to control the performance."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"limitUrl"})," - The url for more info about the whiteboard and its usage limitations."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"whiteboard: {\n enabled: true,\n collabServerBaseUrl: 'https://excalidraw-backend.example.com',\n userLimit: 25,\n limitUrl: 'https://example.com/blog/whiteboard-limits'\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(6540);const l={},t=s.createContext(l);function a(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[2215],{2622:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>c});var s=i(4848),l=i(8453);const t={id:"dev-guide-configuration",title:"Configuration"},a=void 0,r={id:"dev-guide/dev-guide-configuration",title:"Configuration",description:"This page describes available configuration options for Jitsi Meet. These are either set in config.js on the server",source:"@site/docs/dev-guide/configuration.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-configuration",permalink:"/handbook/docs/dev-guide/dev-guide-configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/configuration.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"dev-guide-configuration",title:"Configuration"},sidebar:"docs",previous:{title:"Flutter SDK",permalink:"/handbook/docs/dev-guide/dev-guide-flutter-sdk"},next:{title:"Overview",permalink:"/handbook/docs/devops-guide/"}},d={},c=[{value:"API",id:"api",level:2},{value:"apiLogLevels",id:"apiloglevels",level:3},{value:"buttonsWithNotifyClick",id:"buttonswithnotifyclick",level:3},{value:"customParticipantMenuButtons",id:"customparticipantmenubuttons",level:3},{value:"customToolbarButtons",id:"customtoolbarbuttons",level:3},{value:"mouseMoveCallbackInterval",id:"mousemovecallbackinterval",level:3},{value:"participantMenuButtonsWithNotifyClick",id:"participantmenubuttonswithnotifyclick",level:3},{value:"useHostPageLocalStorage",id:"usehostpagelocalstorage",level:3},{value:"Audio",id:"audio",level:2},{value:"audioLevelsInterval",id:"audiolevelsinterval",level:3},{value:"audioQuality",id:"audioquality",level:3},{value:"disableAudioLevels",id:"disableaudiolevels",level:3},{value:"disableSpeakerStatsSearch",id:"disablespeakerstatssearch",level:3},{value:"disabledSounds",id:"disabledsounds",level:3},{value:"enableNoAudioDetection",id:"enablenoaudiodetection",level:3},{value:"enableNoisyMicDetection",id:"enablenoisymicdetection",level:3},{value:"speakerStats",id:"speakerstats",level:3},{value:"speakerStatsOrder",id:"speakerstatsorder",level:3},{value:"startAudioMuted",id:"startaudiomuted",level:3},{value:"startAudioOnly",id:"startaudioonly",level:3},{value:"startSilent",id:"startsilent",level:3},{value:"startWithAudioMuted",id:"startwithaudiomuted",level:3},{value:"Breakout rooms",id:"breakout-rooms",level:2},{value:"breakoutRooms",id:"breakoutrooms",level:3},{value:"hideAddRoomButton",id:"hideaddroombutton",level:3},{value:"Callstats",id:"callstats",level:2},{value:"callStatsConfigParams",id:"callstatsconfigparams",level:3},{value:"callStatsID",id:"callstatsid",level:3},{value:"callStatsSecret",id:"callstatssecret",level:3},{value:"enableDisplayNameInStats",id:"enabledisplaynameinstats",level:3},{value:"enableEmailInStats",id:"enableemailinstats",level:3},{value:"feedbackPercentage",id:"feedbackpercentage",level:3},{value:"Transcriptions",id:"transcriptions",level:2},{value:"autoCaptionOnRecord",id:"autocaptiononrecord",level:3},{value:"preferredTranscribingLanguage",id:"preferredtranscribinglanguage",level:3},{value:"transcribeWithAppLanguage",id:"transcribewithapplanguage",level:3},{value:"transcribingEnabled",id:"transcribingenabled",level:3},{value:"transcription",id:"transcription",level:3},{value:"Connection",id:"connection",level:2},{value:"bosh*",id:"bosh",level:3},{value:"disableRtx",id:"disablertx",level:3},{value:"disableSimulcast",id:"disablesimulcast",level:3},{value:"e2ee",id:"e2ee",level:3},{value:"e2eping",id:"e2eping",level:3},{value:"enableEncodedTransformSupport",id:"enableencodedtransformsupport",level:3},{value:"enableForcedReload \ud83d\udeab",id:"enableforcedreload-",level:3},{value:"gatherStats",id:"gatherstats",level:3},{value:"hosts",id:"hosts",level:3},{value:"p2p",id:"p2p",level:3},{value:"pcStatsInterval",id:"pcstatsinterval",level:3},{value:"peopleSearchQueryTypes",id:"peoplesearchquerytypes",level:3},{value:"peopleSearchUrl",id:"peoplesearchurl",level:3},{value:"inviteServiceUrl",id:"inviteserviceurl",level:3},{value:"peopleSearchTokenLocation",id:"peoplesearchtokenlocation",level:3},{value:"useTurnUdp",id:"useturnudp",level:3},{value:"webrtcIceTcpDisable",id:"webrtcicetcpdisable",level:3},{value:"webrtcIceUdpDisable",id:"webrtciceudpdisable",level:3},{value:"websocket \ud83d\udeab",id:"websocket-",level:3},{value:"Etherpad",id:"etherpad",level:2},{value:"etherpad_base",id:"etherpad_base",level:3},{value:"openSharedDocumentOnJoin",id:"openshareddocumentonjoin",level:3},{value:"Filmstrip",id:"filmstrip",level:2},{value:"disableFilmstripAutohiding",id:"disablefilmstripautohiding",level:3},{value:"filmstrip",id:"filmstrip-1",level:3},{value:"Face Landmarks",id:"face-landmarks",level:2},{value:"faceLandmarks",id:"facelandmarks",level:3},{value:"Giphy",id:"giphy",level:2},{value:"giphy",id:"giphy-1",level:3},{value:"Gravatar",id:"gravatar",level:2},{value:"gravatar",id:"gravatar-1",level:3},{value:"gravatarBaseURL \ud83d\udeab",id:"gravatarbaseurl-",level:3},{value:"LastN",id:"lastn",level:2},{value:"channelLastN",id:"channellastn",level:3},{value:"lastNLimits \ud83d\udeab",id:"lastnlimits-",level:3},{value:"startLastN",id:"startlastn",level:3},{value:"Lobby",id:"lobby",level:2},{value:"autoKnockLobby",id:"autoknocklobby",level:3},{value:"enableLobbyChat",id:"enablelobbychat",level:3},{value:"hideLobbyButton",id:"hidelobbybutton",level:3},{value:"lobby",id:"lobby-1",level:3},{value:"Moderator",id:"moderator",level:2},{value:"disableModeratorIndicator",id:"disablemoderatorindicator",level:3},{value:"disableReactionsModeration",id:"disablereactionsmoderation",level:3},{value:"disableRemoteMute",id:"disableremotemute",level:3},{value:"Notifications",id:"notifications",level:2},{value:"notifications",id:"notifications-1",level:3},{value:"disabledNotifications",id:"disablednotifications",level:3},{value:"Participants Pane",id:"participants-pane",level:2},{value:"participantsPane",id:"participantspane",level:3},{value:"Recording",id:"recording",level:2},{value:"dropbox",id:"dropbox",level:3},{value:"fileRecordingsEnabled",id:"filerecordingsenabled",level:3},{value:"fileRecordingsServiceEnabled \ud83d\udeab",id:"filerecordingsserviceenabled-",level:3},{value:"fileRecordingsServiceSharingEnabled \ud83d\udeab",id:"filerecordingsservicesharingenabled-",level:3},{value:"hideRecordingLabel",id:"hiderecordinglabel",level:3},{value:"localRecording",id:"localrecording",level:3},{value:"recordingLimit \ud83d\udeab",id:"recordinglimit-",level:3},{value:"recordings",id:"recordings",level:3},{value:"Screen Sharing",id:"screen-sharing",level:2},{value:"desktopSharingFrameRate",id:"desktopsharingframerate",level:3},{value:"disableScreensharingVirtualBackground",id:"disablescreensharingvirtualbackground",level:3},{value:"screenshotCapture",id:"screenshotcapture",level:3},{value:"Security UI",id:"security-ui",level:2},{value:"securityUi",id:"securityui",level:3},{value:"Testing",id:"testing",level:2},{value:"testing",id:"testing-1",level:3},{value:"Video",id:"video",level:2},{value:"constraints",id:"constraints",level:3},{value:"disableAddingBackgroundImages",id:"disableaddingbackgroundimages",level:3},{value:"disableH264",id:"disableh264",level:3},{value:"disableLocalVideoFlip",id:"disablelocalvideoflip",level:3},{value:"disableSelfView",id:"disableselfview",level:3},{value:"doNotFlipLocalVideo",id:"donotfliplocalvideo",level:3},{value:"maxFullResolutionParticipants",id:"maxfullresolutionparticipants",level:3},{value:"preferH264",id:"preferh264",level:3},{value:"resolution",id:"resolution",level:3},{value:"startVideoMuted",id:"startvideomuted",level:3},{value:"startWithVideoMuted",id:"startwithvideomuted",level:3},{value:"videoQuality",id:"videoquality",level:3},{value:"Whiteboard",id:"whiteboard",level:2},{value:"whiteboard",id:"whiteboard-1",level:3}];function o(e){const n={a:"a",admonition:"admonition",code:"code",del:"del",em:"em",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["This page describes available configuration options for Jitsi Meet. These are either set in ",(0,s.jsx)(n.code,{children:"config.js"})," on the server\nside or overridden in the app."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["Options marked with \ud83d\udeab are not overwritable through ",(0,s.jsx)(n.code,{children:"configOverwrite"})]})}),"\n",(0,s.jsx)(n.admonition,{type:"warning",children:(0,s.jsx)(n.p,{children:"This page is a work in progress. Not all options are described here yet."})}),"\n",(0,s.jsx)(n.h2,{id:"api",children:"API"}),"\n",(0,s.jsx)(n.h3,{id:"apiloglevels",children:"apiLogLevels"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"Logs that should go be passed through the 'log' event if a handler is defined for it"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"apiLogLevels: ['warn', 'log', 'error', 'info', 'debug']\n"})}),"\n",(0,s.jsx)(n.h3,{id:"buttonswithnotifyclick",children:"buttonsWithNotifyClick"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsxs)(n.p,{children:["Toolbar buttons which have their click/tap event exposed through the API on ",(0,s.jsx)(n.code,{children:"toolbarButtonClicked"}),". Passing a string for the button key will prevent execution of the click/tap routine; passing an object with ",(0,s.jsx)(n.code,{children:"key"})," and ",(0,s.jsx)(n.code,{children:"preventExecution"})," flag on false will not prevent execution of the click/tap routine. Below array with mixed mode for passing the buttons."]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"buttonsWithNotifyClick: [\n 'camera',\n {\n key: 'chat',\n preventExecution: false\n },\n {\n key: 'closedcaptions',\n preventExecution: true\n },\n 'desktop',\n 'download',\n 'embedmeeting',\n 'etherpad',\n 'feedback',\n 'filmstrip',\n 'fullscreen',\n 'hangup',\n 'help',\n {\n key: 'invite',\n preventExecution: false\n },\n 'livestreaming',\n 'microphone',\n 'mute-everyone',\n 'mute-video-everyone',\n 'participants-pane',\n 'profile',\n {\n key: 'raisehand',\n preventExecution: true\n },\n 'recording',\n 'security',\n 'select-background',\n 'settings',\n 'shareaudio',\n 'sharedvideo',\n 'shortcuts',\n 'stats',\n 'tileview',\n 'toggle-camera',\n 'videoquality',\n // The add passcode button from the security dialog.\n {\n key: 'add-passcode',\n preventExecution: false\n },\n '__end'\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"customparticipantmenubuttons",children:"customParticipantMenuButtons"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array<{ icon: string; id: string; text: string; }>"})]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsxs)(n.p,{children:["A list of custom buttons that can be added to the Participant Context Menu. Each will have an icon, that can be either a base64 encoded image or the path to an image, a unique id, and a text that will be displayed alongside the icon in the menu. This custom button will trigger the ",(0,s.jsx)(n.code,{children:"participantMenuButtonClick"})," event that will have the id set to the button as the ",(0,s.jsx)(n.code,{children:"key"})," and the ",(0,s.jsx)(n.code,{children:"participantId"}),", representing the id of the participant for which the button was clicked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"customParticipantMenuButtons: [\n {\n icon: 'data:image/svg+xml;base64,...',\n id: 'custom-button',\n text: 'Custom Button'\n }\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"customtoolbarbuttons",children:"customToolbarButtons"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array<{ icon: string; id: string; text: string; }>"})]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsxs)(n.p,{children:["A list of custom buttons that can be added to the Toolbar. Each will have an icon, that can be either a base64 encoded image or the path to an image, a unique id, and a text that will be displayed alongside the icon in the menu. This custom button will trigger the ",(0,s.jsx)(n.code,{children:"toolbarButtonClicked"})," event that will the id set to the button as the ",(0,s.jsx)(n.code,{children:"key"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"customToolbarButtons: [\n {\n icon: 'data:image/svg+xml;base64,...',\n id: 'custom-toolbar-button',\n text: 'Custom Toolbar Button'\n }\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"mousemovecallbackinterval",children:"mouseMoveCallbackInterval"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsxs)(n.p,{children:["Default interval (milliseconds) for triggering ",(0,s.jsx)(n.code,{children:"mouseMoved"})," iframe API event."]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"1000"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"mouseMoveCallbackInterval: 1000\n"})}),"\n",(0,s.jsx)(n.h3,{id:"participantmenubuttonswithnotifyclick",children:"participantMenuButtonsWithNotifyClick"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsxs)(n.p,{children:["Participant context menu buttons which have their click/tap event exposed through the API on ",(0,s.jsx)(n.code,{children:"participantMenuButtonClick"}),". Passing a string for the button key will prevent execution of the click/tap routine; passing an object with ",(0,s.jsx)(n.code,{children:"key"})," and ",(0,s.jsx)(n.code,{children:"preventExecution"})," flag on false will not prevent execution of the click/tap routine. Below array with mixed mode for passing the buttons."]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"participantMenuButtonsWithNotifyClick: [\n 'allow-video',\n {\n key: 'ask-unmute',\n preventExecution: false\n },\n 'conn-status',\n 'flip-local-video',\n 'grant-moderator',\n {\n key: 'kick',\n preventExecution: true\n },\n {\n key: 'hide-self-view',\n preventExecution: false\n },\n 'mute',\n 'mute-others',\n 'mute-others-video',\n 'mute-video',\n 'pinToStage',\n 'privateMessage',\n {\n key: 'remote-control',\n preventExecution: false\n },\n 'send-participant-to-room',\n 'verify',\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"usehostpagelocalstorage",children:"useHostPageLocalStorage"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"This property is related to the use case when Jitsi Meet is used via the IFrame API. When the property is true\nJitsi Meet will use the local storage of the host page instead of its own. This option is useful if the browser\nis not persisting the local storage inside the iframe."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"useHostPageLocalStorage: true\n"})}),"\n",(0,s.jsx)(n.h2,{id:"audio",children:"Audio"}),"\n",(0,s.jsx)(n.h3,{id:"audiolevelsinterval",children:"audioLevelsInterval"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"The interval (milliseconds) at which the audio levels are calculated."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"200"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"audioLevelsInterval: 200\n"})}),"\n",(0,s.jsx)(n.h3,{id:"audioquality",children:"audioQuality"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Specify audio quality stereo and opusMaxAverageBitrate values in order to enable HD audio.\nBeware, by doing so, you are disabling echo cancellation, noise suppression and AGC."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"audioQuality: {\n stereo: false,\n opusMaxAverageBitrate: null // Value to fit the 6000 to 510000 range.\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableaudiolevels",children:"disableAudioLevels"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disable measuring of audio levels."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableAudioLevels: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablespeakerstatssearch",children:(0,s.jsx)(n.del,{children:"disableSpeakerStatsSearch"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Specifies whether there will be a search field in speaker stats or not."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"speakerStats.disableSearch"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableSpeakerStatsSearch: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disabledsounds",children:"disabledSounds"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"The sounds passed in this array will be disabled."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disabledSounds: [\n // 'ASKED_TO_UNMUTE_SOUND'\n // 'E2EE_OFF_SOUND'\n // 'E2EE_ON_SOUND'\n // 'INCOMING_MSG_SOUND'\n // 'KNOCKING_PARTICIPANT_SOUND'\n // 'LIVE_STREAMING_OFF_SOUND'\n // 'LIVE_STREAMING_ON_SOUND'\n // 'NO_AUDIO_SIGNAL_SOUND'\n // 'NOISY_AUDIO_INPUT_SOUND'\n // 'OUTGOING_CALL_EXPIRED_SOUND'\n // 'OUTGOING_CALL_REJECTED_SOUND'\n // 'OUTGOING_CALL_RINGING_SOUND'\n // 'OUTGOING_CALL_START_SOUND'\n // 'PARTICIPANT_JOINED_SOUND'\n // 'PARTICIPANT_LEFT_SOUND'\n // 'RAISE_HAND_SOUND'\n // 'REACTION_SOUND'\n // 'RECORDING_OFF_SOUND'\n // '_ON_SOUND'\n // 'TALK_WHILE_MUTED_SOUND'\n]\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enablenoaudiodetection",children:"enableNoAudioDetection"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enabling this will run the lib-jitsi-meet no audio detection module which\nwill notify the user if the current selected microphone has no audio\ninput and will suggest another valid device if one is present."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"true"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableNoAudioDetection: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enablenoisymicdetection",children:"enableNoisyMicDetection"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enabling this will run the lib-jitsi-meet noise detection module which will\nnotify the user if there is noise, other than voice, coming from the current\nselected microphone. The purpose it to let the user know that the input could\nbe potentially unpleasant for other meeting participants."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"true"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableNoisyMicDetection: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"speakerstats",children:"speakerStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the speaker stats feature."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disabled"})," - Specifies whether the speaker stats is enable or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableSearch"})," - Specifies whether there will be a search field in speaker stats or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"order"})," - Specifies whether participants in speaker stats should be ordered or not, and with what priority."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"speakerStats: {\n disabled: false,\n disableSearch: false,\n order: [\n 'role', // Moderators on top.\n 'name', // Alphabetically by name.\n 'hasLeft', // The ones that have left in the bottom.\n ], // the order of the array elements determines priority.\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"speakerstatsorder",children:(0,s.jsx)(n.del,{children:"speakerStatsOrder"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"Specifies whether participants in speaker stats should be ordered or not, and with what priority."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"speakerStats.order"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Default:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:" speakerStatsOrder: [\n 'role', // Moderators on top.\n 'name', // Alphabetically by name.\n 'hasLeft', // The ones that have left in the bottom.\n ], // the order of the array elements determines priority.\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startaudiomuted",children:"startAudioMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Every participant after the Nth will start audio muted."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startAudioMuted: 10\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startaudioonly",children:"startAudioOnly"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Start the conference in audio only mode (no video is being received nor sent)."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startAudioOnly: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startsilent",children:"startSilent"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enabling it (with #params) will disable local audio output of remote\nparticipants and to enable it back a reload is needed."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startSilent: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startwithaudiomuted",children:"startWithAudioMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Start calls with audio muted. This option is only applied locally."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startWithAudioMuted: false\n"})}),"\n",(0,s.jsx)(n.h2,{id:"breakout-rooms",children:"Breakout rooms"}),"\n",(0,s.jsx)(n.h3,{id:"breakoutrooms",children:"breakoutRooms"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the breakout rooms feature."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideAddRoomButton"})," - Hides the add breakout room button. This replaces ",(0,s.jsx)(n.code,{children:"hideAddRoomButton"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideAutoAssignButton"})," - Hides the auto assign participants button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideJoinRoomButton"})," - Hides the join breakout room button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideModeratorSettingsTab"})," - Hides the button to open the moderator settings tab."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMoreActionsButton"})," - Hides the more actions button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMuteAllButton"})," - Hides the mute all button."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"breakoutRooms: {\n hideAddRoomButton: false,\n hideAutoAssignButton: false,\n hideJoinRoomButton: false\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hideaddroombutton",children:(0,s.jsx)(n.del,{children:"hideAddRoomButton"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"breakoutRooms.hideAddRoomButton"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Hides add breakout room button."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hideAddRoomButton: false\n"})}),"\n",(0,s.jsx)(n.h2,{id:"callstats",children:"Callstats"}),"\n",(0,s.jsx)(n.h3,{id:"callstatsconfigparams",children:"callStatsConfigParams"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsxs)(n.p,{children:["The callstats initialize config params as described in the API ",(0,s.jsx)(n.a,{href:"https://docs.callstats.io/docs/javascript#callstatsinitialize-with-app-secret",children:"here"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'callStatsConfigParams: {\n disableBeforeUnloadHandler: true, // disables callstats.js\'s window.onbeforeunload parameter.\n applicationVersion: "app_version", // Application version specified by the developer.\n disablePrecalltest: true, // disables the pre-call test, it is enabled by default.\n siteID: "siteID", // The name/ID of the site/campus from where the call/pre-call test is made.\n additionalIDs: { // additionalIDs object, contains application related IDs.\n customerID: "Customer Identifier. Example, walmart.",\n tenantID: "Tenant Identifier. Example, monster.",\n productName: "Product Name. Example, Jitsi.",\n meetingsName: "Meeting Name. Example, Jitsi loves callstats.",\n serverName: "Server/MiddleBox Name. Example, jvb-prod-us-east-mlkncws12.",\n pbxID: "PBX Identifier. Example, walmart.",\n pbxExtensionID: "PBX Extension Identifier. Example, 5625.",\n fqExtensionID: "Fully qualified Extension Identifier. Example, +71 (US) +5625.",\n sessionID: "Session Identifier. Example, session-12-34"\n },\n collectLegacyStats: true, //enables the collection of legacy stats in chrome browser\n collectIP: true //enables the collection localIP address\n}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"callstatsid",children:"callStatsID"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"You must provide the Application ID to enable sending statistics to callstats.io"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"callStatsID: 'my-callstats-app-id'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"callstatssecret",children:"callStatsSecret"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"You must provide the Secret to enable sending statistics to callstats.io"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"callStatsSecret: 'my-callstats-secret'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enabledisplaynameinstats",children:"enableDisplayNameInStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enables sending participants' display names to callstats."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableDisplayNameInStats: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enableemailinstats",children:"enableEmailInStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enables sending participants' emails (if available) to callstats and other analytics"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableEmailInStats: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"feedbackpercentage",children:"feedbackPercentage"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Controls the percentage of automatic feedback shown to participants when callstats is enabled.\nThe default value is 100%. If set to 0, no automatic feedback will be requested"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"feedbackPercentage: 100\n"})}),"\n",(0,s.jsx)(n.h2,{id:"transcriptions",children:"Transcriptions"}),"\n",(0,s.jsx)(n.h3,{id:"autocaptiononrecord",children:"autoCaptionOnRecord"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.autoTranscribeOnRecord"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"preferredtranscribinglanguage",children:"preferredTranscribingLanguage"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.preferredLanguage"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"transcribewithapplanguage",children:"transcribeWithAppLanguage"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.useAppLanguage"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"transcribingenabled",children:"transcribingEnabled"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"transcription.enabled"})," instead."]}),"\n",(0,s.jsx)(n.h3,{id:"transcription",children:"transcription"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Transcription related options."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Enable transcription (in interface_config, subtitles and buttons can be configured). Default ",(0,s.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"translationLanguages"})," - Translation languages. Available languages can be found in ./lang/translation-languages.json."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"useAppLanguage"})," - If ",(0,s.jsx)(n.code,{children:"true"})," the transcriber will use the application language. The application language is either explicitly set by participants in their settings or automatically detected based on the environment, e.g. if the app is opened in a Chrome instance which is using French as its default language then transcriptions for that participant will be in french. Default: ",(0,s.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"preferredLanguage"})," - Transcriber language. This settings will only work if ",(0,s.jsx)(n.code,{children:"useAppLanguage"})," is explicitly set to ",(0,s.jsx)(n.code,{children:"false"}),". Available languages can be found ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/react/features/transcribing/transcriber-langs.json",children:"here"}),". Default: ",(0,s.jsx)(n.code,{children:"'en-US'"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"autoTranscribeOnRecord"})," - Enables automatic turning on transcribing when recording is started. Default: ",(0,s.jsx)(n.code,{children:"true"}),"."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"transcription: {\n enabled: true,\n translationLanguages: ['en-US', 'es'],\n useAppLanguage: false,\n preferredLanguage: 'en-US',\n autoTranscribeOnRecord: true\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"connection",children:"Connection"}),"\n",(0,s.jsx)(n.h3,{id:"bosh",children:"bosh*"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"The BOSH URL."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"bosh: '//jitsi-meet.example.com/http-bind'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablertx",children:"disableRtx"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables or enables RTX (RFC 4588)."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableRtx: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablesimulcast",children:"disableSimulcast"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enable / disable simulcast support."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableSimulcast: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"e2ee",children:"e2ee"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Configure End-to-End Encryption."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"e2ee: {\n labels: {\n labelTooltip: 'Tooltip',\n description: 'Description',\n label: 'E2EE',\n warning: 'Warning'\n },\n externallyManagedKey: false\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"e2eping",children:"e2eping"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to end-to-end (participant to participant) ping."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Whether end-to-end pings should be enabled."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"numRequests"})," - The number of responses to wait for."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"maxConferenceSize"})," - The max conference size in which e2e pings will be sent."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"maxMessagesPerSecond"})," - The maximum number of e2e ping messages per second for the whole conference to aim for.\nThis is used to contol the pacing of messages in order to reduce the load on the backend."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"e2eping: {\n enabled: false,\n numRequests: 5,\n maxConferenceSize: 200,\n maxMessagesPerSecond: 250\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enableencodedtransformsupport",children:"enableEncodedTransformSupport"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["Enable support for encoded transform in supported browsers. This allows\nE2EE to work in Safari if the corresponding flag is enabled in the browser.\n",(0,s.jsx)(n.strong,{children:"Experimental"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableEncodedTransformSupport: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enableforcedreload-",children:"enableForcedReload \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Enables forced reload of the client when the call is migrated as a result of\nthe bridge going down."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableForcedReload: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"gatherstats",children:"gatherStats"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to enable stats collection or not in the ",(0,s.jsx)(n.code,{children:"TraceablePeerConnection"}),".\nThis can be useful for debugging purposes (post-processing/analysis of\nthe WebRTC stats) as it is done in the jitsi-meet-torture bandwidth\nestimation tests."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"gatherStats: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hosts",children:"hosts"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"URLs for the app connection."}),"\n",(0,s.jsx)(n.p,{children:"Properties"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"domain"})," - XMPP domain"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"anonymousdomain"})," - When using authentication, domain for guest users."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"authdomain"})," - Domain for authenticated users. Defaults to ",(0,s.jsx)(n.code,{children:"domain"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"focus"})," - Focus component domain. Defaults to ",(0,s.jsxs)(n.strong,{children:["focus.",(0,s.jsx)(n.code,{children:"domain"})]}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"muc"})," - XMPP MUC domain."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hosts: {\n domain: 'jitsi-meet.example.com',\n anonymousdomain: 'guest.example.com',\n authdomain: 'jitsi-meet.example.com',\n focus: 'focus.jitsi-meet.example.com',\n muc: 'conference.jitsi-meet.example.com'\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"p2p",children:"p2p"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Peer-To-Peer mode: used (if enabled) when there are just 2 participants."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Enables peer to peer mode. When enabled the system will try to\nestablish a direct connection when there are exactly 2 participants\nin the room. If that succeeds the conference will stop sending data\nthrough the JVB and use the peer to peer connection instead. When a\n3rd participant joins the conference will be moved back to the JVB\nconnection."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"iceTransportPolicy"})," - Sets the ICE transport policy for the p2p connection. At the time\nof this writing the list of possible values are ",(0,s.jsx)(n.code,{children:"all"})," and ",(0,s.jsx)(n.code,{children:"relay"}),",\nbut that is subject to change in the future. The enum is defined in\nthe ",(0,s.jsx)(n.a,{href:"https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum",children:"WebRTC standard"}),".\nIf not set, the effective value is ",(0,s.jsx)(n.code,{children:"all"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," - Provides a way to set the codec preference on desktop based endpoints."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," - Provides a way to set the codec preference on mobile devices, both on RN and mobile browser based endpoints."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"preferredCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disabledCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"backToP2PDelay"})," - How long we're going to wait, before going back to P2P after the 3rd\nparticipant has left the conference (to filter out page reload)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"stunServers"})," - The STUN servers that will be used in the peer to peer connections."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"p2p: {\n enabled: true,\n enableUnifiedOnChrome: false,\n iceTransportPolicy: 'all',\n backToP2PDelay: 5,\n stunServers: [\n { urls: 'stun:jitsi-meet.example.com:3478' },\n { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' }\n ]\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"pcstatsinterval",children:"pcStatsInterval"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"The interval at which PeerConnection.getStats() is called."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"10000"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"pcStatsInterval: 50000\n"})}),"\n",(0,s.jsx)(n.h3,{id:"peoplesearchquerytypes",children:"peopleSearchQueryTypes"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:'The entity types which are queriable when inviting people in a room. Valid values are "phone", "room", "sip", "user", "videosipgw" and "email". Authentication for Jitsi entity types is done by passing a jwt, authentication for external entity types (e. g. email) is done by passing an alternative token (e. g. peopleSearchTokenLocation).'}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"[]"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'peopleSearchQueryTypes: ["user", "email"]\n'})}),"\n",(0,s.jsx)(n.h3,{id:"peoplesearchurl",children:"peopleSearchUrl"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Directory endpoint which is called for invite dialog autocomplete. Expected response format is an array of objects. Each object should be formatted as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"{\n id: int,\n type: string, # the entity type (phone, room, user, email etc.),\n name: string, # the entity display name\n avatar?: string, # full URL to the entity picture, not mandatory\n number?: string, # required for phone numbers\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:'""'})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'peopleSearchUrl: "https://myservice.com/api/people"\n'})}),"\n",(0,s.jsx)(n.h3,{id:"inviteserviceurl",children:"inviteServiceUrl"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Endpoint which is called to send invitation requests. The request is made in POST and contains as a POST body an array of objects formatted the same as the peopleSearchUrl response body."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:'""'})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'inviteServiceUrl: "https://myservice.com/api/invite"\n'})}),"\n",(0,s.jsx)(n.h3,{id:"peoplesearchtokenlocation",children:"peopleSearchTokenLocation"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Useful for authentication against directories holding entities which don't exist in Prosody (e. g. email). This indicates the localStorage key where the alternate authentication token value is to be found. This alternate token will be used if the JWT value is not set. It will be sent in the Authorization: Bearer header, as the JWT would have been."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:'""'})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'peopleSearchTokenLocation: "service_token"\n'})}),"\n",(0,s.jsx)(n.h3,{id:"useturnudp",children:"useTurnUdp"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Use TURN/UDP servers for the jitsi-videobridge connection (by default\nwe filter out TURN/UDP because it is usually not needed since the\nbridge itself is reachable via UDP)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"useTurnUdp: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"webrtcicetcpdisable",children:"webrtcIceTcpDisable"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables ICE/TCP by filtering out local and remote TCP candidates in signalling."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"webrtcIceTcpDisable: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"webrtciceudpdisable",children:"webrtcIceUdpDisable"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables ICE/UDP by filtering out local and remote UDP candidates in signalling."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"webrtcIceUdpDisable: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"websocket-",children:"websocket \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:"Websocket URL"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"websocket: 'wss://jitsi-meet.example.com/xmpp-websocket'\n"})}),"\n",(0,s.jsx)(n.h2,{id:"etherpad",children:"Etherpad"}),"\n",(0,s.jsx)(n.h3,{id:"etherpad_base",children:"etherpad_base"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsx)(n.p,{children:'If set, it adds a "Open shared document" link to the bottom right menu that\nwill open an etherpad document.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"etherpad_base: 'https://your-etherpad-installati.on/p/'\n"})}),"\n",(0,s.jsx)(n.h3,{id:"openshareddocumentonjoin",children:"openSharedDocumentOnJoin"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["If etherpad integration is enabled, setting this to ",(0,s.jsx)(n.code,{children:"true"})," will\nautomatically open the etherpad when a participant joins. This\ndoes not affect the mobile app since opening an etherpad\nobscures the conference controls -- it's better to let users\nchoose to open the pad on their own in that case."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"openSharedDocumentOnJoin: false\n"})}),"\n",(0,s.jsx)(n.h2,{id:"filmstrip",children:"Filmstrip"}),"\n",(0,s.jsx)(n.h3,{id:"disablefilmstripautohiding",children:"disableFilmstripAutohiding"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Prevents the filmstrip from autohiding when screen width is under a certain threshold"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableFilmstripAutohiding: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filmstrip-1",children:"filmstrip"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the filmstrip."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableResizable"})," - Disables user resizable filmstrip. This also allows configuration of the filmstrip\n(width, tiles aspect ratios) through the interfaceConfig options."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableStageFilmstrip"})," - Disables the stage filmstrip (displaying multiple\nparticipants on stage besides the vertical filmstrip)"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"filmstrip: {\n disableResizable: true,\n disableStageFilmstrip: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"face-landmarks",children:"Face Landmarks"}),"\n",(0,s.jsx)(n.h3,{id:"facelandmarks",children:"faceLandmarks"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the face landmarks features."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableFaceCentering"})," - Enables centering faces within a video by sharing face coordinates."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableFaceExpressionsDetection"})," - Enables detecting face expressions from video."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableDisplayFaceExpressions"})," - Enables displaying face expressions in speaker stats."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableRTCStats"})," - Enables anonymized stats collection for face landmarks."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"faceCenteringThreshold"})," - Minimum required face movement percentage threshold for sending new face centering coordinates data."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"captureInterval"})," - Milliseconds for processing a new image capture in order to detect face landmarks."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"faceLandmarks: {\n enableFaceCentering: false,\n enableFaceExpressionsDetection: false,\n enableDisplayFaceExpressions: false,\n enableRTCStats: false,\n faceCenteringThreshold: 20,\n captureInterval: 1000\n},\n"})}),"\n",(0,s.jsx)(n.h2,{id:"giphy",children:"Giphy"}),"\n",(0,s.jsx)(n.h3,{id:"giphy-1",children:"giphy"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Setup for the Giphy integration."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Whether the feature is enabled or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"sdkKey"})," - SDK API Key from Giphy."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"displayMode"})," - Display mode can be one of:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tile"})," - show the GIF on the tile of the participant that sent it."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"chat"})," - show the GIF as a message in chat."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"all"})," - all of the above. This is the default option."]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tileTime"})," - How long the GIF should be displayed on the tile (in milliseconds)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"rating"})," - Limit results by audience rating:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"g"})," - broadly accepted as appropriate in a public environment. This is the default option."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pg"})," - commonly witnessed in a public environment, but not as broadly accepted as appropriate."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pg-13"})," - typically not seen unless sought out, but still commonly witnessed."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"r"})," - typically not seen unless sought out, and could be considered alarming if witnessed."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"giphy: {\n enabled: true,\n sdkKey: 'example-key',\n displayMode: 'tile',\n tileTime: 7000,\n rating: 'pg'\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"gravatar",children:"Gravatar"}),"\n",(0,s.jsx)(n.h3,{id:"gravatar-1",children:"gravatar"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Setup for Gravatar-compatible services."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"baseUrl"})," \ud83d\udeab - Base URL for a Gravatar-compatible service. Defaults to Gravatar."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disabled"})," - True if Gravatar should be disabled."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"gravatar: {\n baseUrl: 'https://www.gravatar.com/avatar/',\n disabled: false\n}\n"})}),"\n",(0,s.jsxs)(n.h3,{id:"gravatarbaseurl-",children:[(0,s.jsx)(n.del,{children:"gravatarBaseURL"})," \ud83d\udeab"]}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"String"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"gravatar.baseUrl"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Base URL for a Gravatar-compatible service."}),"\n",(0,s.jsxs)(n.p,{children:["Default: '",(0,s.jsx)(n.a,{href:"https://www.gravatar.com/avatar/",children:"https://www.gravatar.com/avatar/"}),"'"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"gravatarBaseURL: 'https://www.gravatar.com/avatar/'\n"})}),"\n",(0,s.jsx)(n.h2,{id:"lastn",children:"LastN"}),"\n",(0,s.jsx)(n.h3,{id:"channellastn",children:"channelLastN"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:'Default value for the channel "last N" attribute. -1 for unlimited.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"channelLastN: -1\n"})}),"\n",(0,s.jsx)(n.h3,{id:"lastnlimits-",children:"lastNLimits \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:'Provides a way to use different "last N" values based on the number of participants in the conference.\nThe keys in an Object represent number of participants and the values are "last N" to be used when number of\nparticipants gets to or above the number.'}),"\n",(0,s.jsx)(n.p,{children:"For the given example mapping, \"last N\" will be set to 20 as long as there are at least 5, but less than\n29 participants in the call and it will be lowered to 15 when the 30th participant joins. The 'channelLastN'\nwill be used as default until the first threshold is reached."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"lastNLimits: {\n 5: 20,\n 30: 15,\n 50: 10,\n 70: 5,\n 90: 2\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startlastn",children:"startLastN"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:'Provides a way for the lastN value to be controlled through the UI.\nWhen startLastN is present, conference starts with a last-n value of startLastN and channelLastN\nvalue will be used when the quality level is selected using "Manage Video Quality" slider.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startLastN: 1\n"})}),"\n",(0,s.jsx)(n.h2,{id:"lobby",children:"Lobby"}),"\n",(0,s.jsx)(n.h3,{id:"autoknocklobby",children:(0,s.jsx)(n.del,{children:"autoKnockLobby"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"lobby.autoKnock"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"If Lobby is enabled starts knocking automatically."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"autoKnockLobby: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"enablelobbychat",children:(0,s.jsx)(n.del,{children:"enableLobbyChat"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"lobby.enableChat"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Enable lobby chat."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"enableLobbyChat: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hidelobbybutton",children:(0,s.jsx)(n.del,{children:"hideLobbyButton"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"securityUi.hideLobbyButton"})," instead."]}),"\n",(0,s.jsx)(n.p,{children:"Hide the lobby button."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hideLobbyButton: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"lobby-1",children:"lobby"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the lobby screen."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"autoKnock"})," - If the lobby is enabled, it starts knocking automatically. Replaces ",(0,s.jsx)(n.code,{children:"autoKnockLobby"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableChat"})," - Enables the lobby chat. Replaces ",(0,s.jsx)(n.code,{children:"enableLobbyChat"}),"."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"lobby: {\n autoKnock: true,\n enableChat: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"moderator",children:"Moderator"}),"\n",(0,s.jsx)(n.h3,{id:"disablemoderatorindicator",children:"disableModeratorIndicator"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Hides the moderator indicators."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableModeratorIndicator: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablereactionsmoderation",children:"disableReactionsModeration"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables the moderation of reactions feature."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableReactionsModeration: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableremotemute",children:"disableRemoteMute"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables muting operations of remote participants."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableRemoteMute: true\n"})}),"\n",(0,s.jsx)(n.h2,{id:"notifications",children:"Notifications"}),"\n",(0,s.jsx)(n.h3,{id:"notifications-1",children:"notifications"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"Use this array to configure which notifications will be shown to the user.\nThe items correspond to the title or description key of that notification.\nSome of these notifications also depend on some other internal logic to be displayed or not,\nso adding them here will not ensure they will always be displayed."}),"\n",(0,s.jsx)(n.p,{children:"A falsy value for this prop will result in having all notifications enabled (e.g null, undefined, false)."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"notifications: []\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablednotifications",children:"disabledNotifications"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Array"})]}),"\n",(0,s.jsx)(n.p,{children:"List of notifications to be disabled. Works in tandem with the above setting."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disabledNotifications: [\n 'notify.chatMessages', // shown when receiving chat messages while the chat window is closed\n 'notify.grantedTo', // shown when moderator rights were granted to a participant\n]\n"})}),"\n",(0,s.jsx)(n.h2,{id:"participants-pane",children:"Participants Pane"}),"\n",(0,s.jsx)(n.h3,{id:"participantspane",children:"participantsPane"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the participants pane."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideModeratorSettingsTab"})," - Hides the button to open the moderator settings tab."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMoreActionsButton"})," - Hides the more actions button."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideMuteAllButton"})," - Hides the mute all button."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"participantsPane: {\n hideModeratorSettingsTab: false,\n hideMoreActionsButton: false,\n hideMuteAllButton: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"recording",children:"Recording"}),"\n",(0,s.jsx)(n.h3,{id:"dropbox",children:"dropbox"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Enable the dropbox integration."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"appKey"})," - Your APP Key."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"redirectURI"})," - A URL to redirect the user to, after authenticating by default uses"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"dropbox: {\n appKey: 'DROPBOX_APP_KEY',\n redirectURI: 'https://jitsi-meet.example.com/subfolder/static/oauth.html'\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filerecordingsenabled",children:"fileRecordingsEnabled"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether to enable file recording or not."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"fileRecordingsEnabled: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filerecordingsserviceenabled-",children:"fileRecordingsServiceEnabled \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"When integrations like dropbox are enabled only that will be shown,\nby enabling fileRecordingsServiceEnabled, we show both the integrations\nand the generic recording service (its configuration and storage type\ndepends on jibri configuration)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"fileRecordingsServiceEnabled: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"filerecordingsservicesharingenabled-",children:"fileRecordingsServiceSharingEnabled \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether to show the possibility to share file recording with other people\n(e.g. meeting participants), based on the actual implementation\non the backend."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"fileRecordingsServiceSharingEnabled: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"hiderecordinglabel",children:"hideRecordingLabel"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Set recording label to auto hide instead of staying always on screen."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"hideRecordingLabel: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"localrecording",children:"localRecording"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Set local recording configuration."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disable"})," - Whether to disable the feature or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"notifyAllParticipants"})," - Whether to notify all the participants when a local recording is started."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"localRecording: {\n disable: false,\n notifyAllParticipants: true\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"recordinglimit-",children:"recordingLimit \ud83d\udeab"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for the recording limit notification."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"limit"})," - The recording limit in minutes. Note: This number appears in the notification text\nbut doesn't enforce the actual recording time limit. This should be configured in jibri!"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"appName"})," = The name of the app with unlimited recordings."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"appURL"})," - The URL of the app with unlimited recordings."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"recordingLimit: {\n limit: 60,\n appName: 'Unlimited recordings APP',\n appURL: 'https://unlimited.recordings.app.com/'\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"recordings",children:"recordings"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for the recordings features."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"recordAudioAndVideo"})," - If true (default) recording audio and video is selected by default in the recording dialog."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"suggestRecording"})," - If true, shows a notification at the start of the meeting with a call to action button to start recording (for users who can do so)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"showPrejoinWarning"})," - If true, shows a warning label in the prejoin screen to point out the possibility that the call you're joining might be recorded."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"showRecordingLink"})," - If true, the notification for recording start will display a link to download the cloud recording."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"recordings: {\n recordAudioAndVideo: true,\n suggestRecording: false,\n showPrejoinWarning: true,\n showRecordingLink: true\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"screen-sharing",children:"Screen Sharing"}),"\n",(0,s.jsx)(n.h3,{id:"desktopsharingframerate",children:"desktopSharingFrameRate"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Optional desktop sharing frame rate options"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"{ min: 5, max: 5 }"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"desktopSharingFrameRate: {\n min: 3,\n max: 10\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablescreensharingvirtualbackground",children:"disableScreensharingVirtualBackground"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables using screensharing as virtual background."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableScreensharingVirtualBackground: false\n"})}),"\n",(0,s.jsx)(n.h3,{id:"screenshotcapture",children:"screenshotCapture"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for the screenshot capture feature."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Enables the feature"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mode"})," - The mode for the screenshot capture feature. Can be either 'recording' - screensharing screenshots\nare taken only when the recording is also on, or 'always' - screensharing screenshots are always taken."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"screenshotCapture: {\n enabled: true,\n mode: 'recording'\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"security-ui",children:"Security UI"}),"\n",(0,s.jsx)(n.h3,{id:"securityui",children:"securityUi"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options regarding the security-related UI elements."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"hideLobbyButton"})," - Hides the lobby button. Replaces ",(0,s.jsx)(n.code,{children:"hideLobbyButton"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableLobbyPassword"})," - Hides the possibility to set and enter a lobby password."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"securityUi: {\n hideLobbyButton: true,\n disableLobbyPassword: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"testing",children:"Testing"}),"\n",(0,s.jsx)(n.h3,{id:"testing-1",children:"testing"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Experimental features."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"assumeBandwidth"})," - Allows the setting of a custom bandwidth value from the UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"disableE2EE"})," - Disables the End to End Encryption feature. Useful for debugging issues related to insertable streams."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mobileXmppWsThreshold"})," - Enables XMPP WebSocket (as opposed to BOSH) for the given amount of users."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"p2pTestMode"})," - P2P test mode disables automatic switching to P2P when there are 2 participants in the conference."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"testMode"})," - Enables the test specific features consumed by jitsi-meet-torture."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"noAutoPlayVideo"})," - Disables the auto-play behavior of ",(0,s.jsx)(n.em,{children:"all"})," newly created video element. This is useful when the client runs on a host with limited resources."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"testing: {\n assumeBandwidth: true,\n disableE2EE: false,\n mobileXmppWsThreshold: 10, // enable XMPP WebSockets on mobile for 10% of the users\n p2pTestMode: false,\n testMode: false,\n noAutoPlayVideo: false\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"video",children:"Video"}),"\n",(0,s.jsx)(n.h3,{id:"constraints",children:"constraints"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsxs)(n.p,{children:["W3C spec-compliant video constraints to use for video capture. Currently\nused by browsers that return true from lib-jitsi-meet's\n",(0,s.jsx)(n.code,{children:"util#browser#usesNewGumFlow"}),". The constraints are independent of\nthis config's resolution value. Defaults to requesting an ideal\nresolution of 720p."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"constraints: {\n video: {\n height: {\n ideal: 720,\n max: 720,\n min: 240\n }\n }\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableaddingbackgroundimages",children:"disableAddingBackgroundImages"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"When true the user cannot add more images to be used as a virtual background.\nOnly the default ones will be available."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableAddingBackgroundImages: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableh264",children:"disableH264"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"If set to true, disable the H.264 video codec by stripping it out of the SDP."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableH264: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disablelocalvideoflip",children:"disableLocalVideoFlip"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disable the Flip video option from the context menu for local video."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableLocalVideoFlip: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"disableselfview",children:"disableSelfView"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Disables self-view tile. (hides it from tile view and filmstrip)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"disableSelfView: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"donotfliplocalvideo",children:"doNotFlipLocalVideo"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["A property used to unset the default flip state of the local video.\nWhen it is set to ",(0,s.jsx)(n.code,{children:"true"}),", the local(self) video will not be mirrored anymore."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"doNotFlipLocalVideo: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"maxfullresolutionparticipants",children:"maxFullResolutionParticipants"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["How many participants while in the tile view mode, before the receiving video quality is reduced from HD to SD?\nUse ",(0,s.jsx)(n.code,{children:"-1"})," to disable."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"maxFullResolutionParticipants: 5\n"})}),"\n",(0,s.jsx)(n.h3,{id:"preferh264",children:(0,s.jsx)(n.del,{children:"preferH264"})}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"preferredCodec"})," under the ",(0,s.jsx)(n.code,{children:"videoQuality"})," section instead."]}),"\n",(0,s.jsx)(n.p,{children:"Prefer to use the H.264 video codec (if supported).\nNote that it's not recommended to do this because simulcast is not\nsupported when using H.264. For 1-to-1 calls this setting is enabled by\ndefault and can be toggled in the p2p section."}),"\n",(0,s.jsx)(n.h3,{id:"resolution",children:"resolution"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Sets the preferred resolution (height) for local video"}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"720"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"resolution: 1080\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startvideomuted",children:"startVideoMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Number"})]}),"\n",(0,s.jsx)(n.p,{children:"Every participant after the Nth will start the video muted."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startVideoMuted: 5\n"})}),"\n",(0,s.jsx)(n.h3,{id:"startwithvideomuted",children:"startWithVideoMuted"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Start calls with video muted. Only applied locally."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"startWithVideoMuted: true\n"})}),"\n",(0,s.jsx)(n.h3,{id:"videoquality",children:"videoQuality"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Specify the settings for video quality optimizations on the client."}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," - Provides a way to set the codec preference on desktop-based endpoints."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"codecPreferenceOrder: [ 'AV1', 'VP9', 'VP8', 'H264' ],\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," - Provides a way to set the codec preference on mobile devices, both on RN and mobile browser-based endpoints."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"codecPreferenceOrder: [ 'VP8', 'H264', 'VP9' ],\n"})}),"\n",(0,s.jsx)(n.p,{children:"Codec specific settings for scalability modes and max bitrates."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"av1: {\n maxBitratesVideo: {\n low: 100000,\n standard: 300000,\n high: 1000000,\n fullHd: 2000000,\n ultraHd: 4000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: true,\n useSimulcast: false,\n useKSVC: true\n},\nh264: {\n maxBitratesVideo: {\n low: 200000,\n standard: 500000,\n high: 1500000,\n fullHd: 3000000,\n ultraHd: 6000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: true\n},\nvp8: {\n maxBitratesVideo: {\n low: 200000,\n standard: 500000,\n high: 1500000,\n fullHd: 3000000,\n ultraHd: 6000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: false\n},\nvp9: {\n maxBitratesVideo: {\n low: 100000,\n standard: 300000,\n high: 1200000,\n fullHd: 2500000,\n ultraHd: 5000000,\n ssHigh: 2500000\n },\n scalabilityModeEnabled: true,\n useSimulcast: false,\n useKSVC: true\n},\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"disabledCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"preferredCodec"})," - ",(0,s.jsx)(n.strong,{children:"DEPRECATED"})," Use ",(0,s.jsx)(n.code,{children:"codecPreferenceOrder"})," or ",(0,s.jsx)(n.code,{children:"mobileCodecPreferenceOrder"})," instead."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"minHeightForQualityLvl"})," - The options can be used to override default thresholds of video thumbnail heights corresponding to\nthe video quality levels used in the application. At the time of this writing, the allowed levels are:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"low"})," - for the low-quality level (180p at the time of this writing)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"standard"})," - for the medium quality level (360p)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"high"})," - for the high-quality level (720p)"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The keys should be positive numbers which represent the minimal thumbnail height for the quality level.\nWith the default config value below the application will use 'low' quality until the thumbnails are\nat least 360 pixels tall. If the thumbnail height reaches 720 pixels then the application will switch to\nthe high quality."}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"whiteboard",children:"Whiteboard"}),"\n",(0,s.jsx)(n.h3,{id:"whiteboard-1",children:"whiteboard"}),"\n",(0,s.jsxs)(n.p,{children:["type: ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Options related to the Excalidraw whiteboard integration."}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.strong,{children:"unset"})]}),"\n",(0,s.jsx)(n.p,{children:"Properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enabled"})," - Whether the feature is enabled or not."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"collabServerBaseUrl"})," - The ",(0,s.jsx)(n.a,{href:"https://github.com/jitsi/excalidraw-backend",children:"server"})," used to support whiteboard collaboration."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"userLimit"})," - The user access limit to the whiteboard, introduced as a means to control the performance."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"limitUrl"})," - The url for more info about the whiteboard and its usage limitations."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"whiteboard: {\n enabled: true,\n collabServerBaseUrl: 'https://excalidraw-backend.example.com',\n userLimit: 25,\n limitUrl: 'https://example.com/blog/whiteboard-limits'\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(6540);const l={},t=s.createContext(l);function a(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/619256ff.076c79ce.js b/assets/js/619256ff.f19b2ff9.js similarity index 99% rename from assets/js/619256ff.076c79ce.js rename to assets/js/619256ff.f19b2ff9.js index a7690ef22..bdf85b714 100644 --- a/assets/js/619256ff.076c79ce.js +++ b/assets/js/619256ff.f19b2ff9.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[9368],{6350:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=i(4848),s=i(8453);const o={id:"dev-guide-android-sdk",title:"Android SDK"},d=void 0,r={id:"dev-guide/dev-guide-android-sdk",title:"Android SDK",description:"The Jitsi Meet Android SDK provides the same user experience as the Jitsi Meet app,",source:"@site/docs/dev-guide/android-sdk.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-android-sdk",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/android-sdk.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"dev-guide-android-sdk",title:"Android SDK"},sidebar:"docs",previous:{title:"React SDK",permalink:"/handbook/docs/dev-guide/dev-guide-react-sdk"},next:{title:"iOS SDK",permalink:"/handbook/docs/dev-guide/dev-guide-ios-sdk"}},a={},l=[{value:"Sample applications using the SDK",id:"sample-applications-using-the-sdk",level:2},{value:"Build your own, or use a pre-build SDK artifacts/binaries",id:"build-your-own-or-use-a-pre-build-sdk-artifactsbinaries",level:2},{value:"Use pre-build SDK artifacts/binaries",id:"use-pre-build-sdk-artifactsbinaries",level:3},{value:"Build and use your own SDK artifacts/binaries",id:"build-and-use-your-own-sdk-artifactsbinaries",level:3},{value:"Using the API",id:"using-the-api",level:2},{value:"JitsiMeetActivity",id:"jitsimeetactivity",level:3},{value:"JitsiMeetView",id:"jitsimeetview",level:3},{value:"join(options)",id:"joinoptions",level:4},{value:"dispose()",id:"dispose",level:4},{value:"JitsiMeetConferenceOptions",id:"jitsimeetconferenceoptions",level:3},{value:"JitsiMeetActivityDelegate",id:"jitsimeetactivitydelegate",level:3},{value:"onActivityResult(...)",id:"onactivityresult",level:4},{value:"onBackPressed()",id:"onbackpressed",level:4},{value:"onHostDestroy(...)",id:"onhostdestroy",level:4},{value:"onHostResume(...)",id:"onhostresume",level:4},{value:"onHostStop(...)",id:"onhoststop",level:4},{value:"onNewIntent(...)",id:"onnewintent",level:4},{value:"onRequestPermissionsResult(...)",id:"onrequestpermissionsresult",level:4},{value:"onUserLeaveHint()",id:"onuserleavehint",level:4},{value:"Listening for broadcasted events",id:"listening-for-broadcasted-events",level:3},{value:"Supported events",id:"supported-events",level:4},{value:"CONFERENCE_JOINED",id:"conference_joined",level:5},{value:"CONFERENCE_TERMINATED",id:"conference_terminated",level:5},{value:"CONFERENCE_WILL_JOIN",id:"conference_will_join",level:5},{value:"AUDIO_MUTED_CHANGED",id:"audio_muted_changed",level:5},{value:"PARTICIPANT_JOINED",id:"participant_joined",level:5},{value:"PARTICIPANT_LEFT",id:"participant_left",level:5},{value:"ENDPOINT_TEXT_MESSAGE_RECEIVED",id:"endpoint_text_message_received",level:5},{value:"SCREEN_SHARE_TOGGLED",id:"screen_share_toggled",level:4},{value:"PARTICIPANTS_INFO_RETRIEVED",id:"participants_info_retrieved",level:5},{value:"CHAT_MESSAGE_RECEIVED",id:"chat_message_received",level:5},{value:"CHAT_TOGGLED",id:"chat_toggled",level:5},{value:"VIDEO_MUTED_CHANGED",id:"video_muted_changed",level:5},{value:"READY_TO_CLOSE",id:"ready_to_close",level:5},{value:"CUSTOM_OVERFLOW_MENU_BUTTON_PRESSED",id:"custom_overflow_menu_button_pressed",level:5},{value:"Broadcasting Actions",id:"broadcasting-actions",level:3},{value:"Supported actions",id:"supported-actions",level:4},{value:"SET_AUDIO_MUTED",id:"set_audio_muted",level:5},{value:"SET_VIDEO_MUTED",id:"set_video_muted",level:5},{value:"HANG_UP",id:"hang_up",level:5},{value:"SEND_ENDPOINT_TEXT_MESSAGE",id:"send_endpoint_text_message",level:5},{value:"TOGGLE_SCREEN_SHARE",id:"toggle_screen_share",level:5},{value:"RETRIEVE_PARTICIPANTS_INFO",id:"retrieve_participants_info",level:5},{value:"OPEN_CHAT",id:"open_chat",level:5},{value:"CLOSE_CHAT",id:"close_chat",level:5},{value:"SEND_CHAT_MESSAGE",id:"send_chat_message",level:5},{value:"ProGuard rules",id:"proguard-rules",level:2},{value:"Picture-in-Picture",id:"picture-in-picture",level:2},{value:"Dropbox integration",id:"dropbox-integration",level:2}];function c(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components},{Details:i}=n;return i||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"The Jitsi Meet Android SDK provides the same user experience as the Jitsi Meet app,\nin a customizable way which you can embed in your apps."}),"\n",(0,t.jsx)(n.admonition,{type:"important",children:(0,t.jsx)(n.p,{children:"Android 7.0 (API level 24) or higher is required."})}),"\n",(0,t.jsx)(n.h2,{id:"sample-applications-using-the-sdk",children:"Sample applications using the SDK"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the\n",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-sdk-samples#android",children:"sample applications repository"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"build-your-own-or-use-a-pre-build-sdk-artifactsbinaries",children:"Build your own, or use a pre-build SDK artifacts/binaries"}),"\n",(0,t.jsx)(n.p,{children:"Jitsi conveniently provides a pre-build SDK artifacts/binaries in its Maven repository. When you do not require any\nmodification to the SDK itself or any of its dependencies, it's suggested to use the pre-build SDK. This avoids the\ncomplexity of building and installing your own SDK artifacts/binaries."}),"\n",(0,t.jsx)(n.h3,{id:"use-pre-build-sdk-artifactsbinaries",children:"Use pre-build SDK artifacts/binaries"}),"\n",(0,t.jsxs)(n.p,{children:["In your project, add the Maven repository\n",(0,t.jsx)(n.code,{children:"https://github.com/jitsi/jitsi-maven-repository/raw/master/releases"})," and the\ndependency ",(0,t.jsx)(n.code,{children:"org.jitsi.react:jitsi-meet-sdk"})," into your ",(0,t.jsx)(n.code,{children:"build.gradle"})," files."]}),"\n",(0,t.jsxs)(n.p,{children:["The repository typically goes into the ",(0,t.jsx)(n.code,{children:"build.gradle"})," file in the root of your project:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",metastring:'title="build.gradle"',children:"allprojects {\n repositories {\n maven {\n url \"https://github.com/jitsi/jitsi-maven-repository/raw/master/releases\"\n }\n google()\n mavenCentral()\n maven { url 'https://www.jitpack.io' }\n }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["In recent versions of Android Studios, ",(0,t.jsx)(n.code,{children:"allprojects{}"})," might not be found in ",(0,t.jsx)(n.code,{children:"build.gradle"}),". In that case, the repository goes into the ",(0,t.jsx)(n.code,{children:"settings.gradle"})," file in the root of your project:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",metastring:'title="settings.gradle"',children:'dependencyResolutionManagement {\n repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)\n repositories {\n google()\n mavenCentral()\n maven {\n url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases"\n }\n maven {\n url "https://maven.google.com"\n }\n }\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Dependency definitions belong in the individual module ",(0,t.jsx)(n.code,{children:"build.gradle"})," files:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",children:"dependencies {\n // (other dependencies)\n implementation ('org.jitsi.react:jitsi-meet-sdk:+') { transitive = true }\n}\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"warning",children:(0,t.jsxs)(n.p,{children:["Make sure you pin your dependency by checking the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-release-notes/blob/master/CHANGELOG-MOBILE-SDKS.md",children:"releases page"}),"."]})}),"\n",(0,t.jsx)(n.h3,{id:"build-and-use-your-own-sdk-artifactsbinaries",children:"Build and use your own SDK artifacts/binaries"}),"\n",(0,t.jsxs)(i,{children:[(0,t.jsx)("summary",{children:"Show building instructions"}),(0,t.jsxs)(n.p,{children:["Start by making sure that your development environment ",(0,t.jsx)(n.a,{href:"/docs/category/mobile",children:"is set up correctly"}),"."]}),(0,t.jsx)(n.admonition,{title:"A Note on Dependencies",type:"note",children:(0,t.jsxs)(n.p,{children:["Apart from the SDK, Jitsi also publishes a binary Maven artifact for some of the SDK dependencies (that are not otherwise publicly available) to the Jitsi Maven repository. When you're planning to use a SDK that is built from source, you'll likely use a version of the source code that is newer (or at least ",(0,t.jsx)(n.em,{children:"different"}),") than the version of the source that was used to create the binary SDK artifact. As a consequence, the dependencies that your project will need, might also be different from those that are published in the Jitsi Maven repository. This might lead to build problems, caused by dependencies that are unavailable."]})}),(0,t.jsxs)(n.p,{children:["If you want to use a SDK that is built from source, you will likely benefit from composing a local Maven repository that contains these dependencies. The text below describes how you create a repository that includes both the SDK as well as these dependencies. For illustration purposes, we'll define the location of this local Maven repository as ",(0,t.jsx)(n.code,{children:"/tmp/repo"})]}),(0,t.jsxs)(n.p,{children:["In source code form, the Android SDK dependencies are locked/pinned by ",(0,t.jsx)(n.code,{children:"package.json"})," and ",(0,t.jsx)(n.code,{children:"package-lock.json"})," of the Jitsi Meet project. To obtain the data, execute NPM in the jitsi-meet project directory:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-shell",children:" npm install\n"})}),(0,t.jsx)(n.p,{children:"This will pull in the dependencies in either binary format, or in source code format, somewhere under /node_modules/"}),(0,t.jsxs)(n.p,{children:["Third-party React Native ",(0,t.jsx)(n.em,{children:"modules"}),", which Jitsi Meet SDK for Android depends on, are download by NPM in source code\nor binary form. These need to be assembled into Maven artifacts, and then published to your local Maven repository.\nA script is provided to facilitate this. From the root of the jitsi-meet project repository, run:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-shell",children:" ./android/scripts/release-sdk.sh /tmp/repo\n"})}),(0,t.jsxs)(n.p,{children:["This will build and publish the SDK, and all of its dependencies to the specified Maven repository (",(0,t.jsx)(n.code,{children:"/tmp/repo"}),") in\nthis example."]}),(0,t.jsxs)(n.p,{children:["You're now ready to use the artifacts. In ",(0,t.jsx)(n.em,{children:"your"})," project, add the Maven repository that you used above (",(0,t.jsx)(n.code,{children:"/tmp/repo"}),") into your top-level ",(0,t.jsx)(n.code,{children:"build.gradle"})," file:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",children:" allprojects {\n repositories {\n maven { url \"file:/tmp/repo\" }\n google()\n mavenCentral()\n maven { url 'https://www.jitpack.io' }\n }\n }\n"})}),(0,t.jsxs)(n.p,{children:["You can use your local repository to replace the Jitsi repository (",(0,t.jsx)(n.code,{children:'maven { url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases" }'}),") when you published ",(0,t.jsx)(n.em,{children:"all"})," subprojects. If you didn't do that, you'll have to add both repositories. Make sure your local repository is listed first!"]}),(0,t.jsxs)(n.p,{children:["Then, define the dependency ",(0,t.jsx)(n.code,{children:"org.jitsi.react:jitsi-meet-sdk"})," into the ",(0,t.jsx)(n.code,{children:"build.gradle"})," file of your module:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:" implementation ('org.jitsi.react:jitsi-meet-sdk:+') { transitive = true }\n"})}),(0,t.jsxs)(n.p,{children:["Note that there should not be a need to explicitly add the other dependencies, as they will be pulled in as transitive\ndependencies of ",(0,t.jsx)(n.code,{children:"jitsi-meet-sdk"}),"."]})]}),"\n",(0,t.jsx)(n.h2,{id:"using-the-api",children:"Using the API"}),"\n",(0,t.jsx)(n.p,{children:"Jitsi Meet SDK is an Android library which embodies the whole Jitsi Meet\nexperience and makes it reusable by third-party apps."}),"\n",(0,t.jsxs)(n.p,{children:["First, add Java 1.8 compatibility support to your project by adding the\nfollowing lines into your ",(0,t.jsx)(n.code,{children:"build.gradle"})," file:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",children:"compileOptions {\n sourceCompatibility JavaVersion.VERSION_1_8\n targetCompatibility JavaVersion.VERSION_1_8\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["To get started, just launch ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"})," pointing to the room you want:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'// Somewhere early in your app.\nJitsiMeetConferenceOptions defaultOptions\n = new JitsiMeetConferenceOptions.Builder()\n .setServerURL(serverURL)\n // When using JaaS, set the obtained JWT here\n //.setToken("MyJWT")\n // Different features flags can be set\n // .setFeatureFlag("toolbox.enabled", false)\n // .setFeatureFlag("filmstrip.enabled", false)\n .setFeatureFlag("welcomepage.enabled", false)\n .build();\nJitsiMeet.setDefaultConferenceOptions(defaultOptions);\n// ...\n// Build options object for joining the conference. The SDK will merge the default\n// one we set earlier and this one when joining.\nJitsiMeetConferenceOptions options\n = new JitsiMeetConferenceOptions.Builder()\n .setRoom(roomName)\n // Settings for audio and video\n //.setAudioMuted(true)\n //.setVideoMuted(true)\n .build();\n// Launch the new activity with the given options. The launch() method takes care\n// of creating the required Intent and passing the options.\nJitsiMeetActivity.launch(this, options);\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Alternatively, you can use the ",(0,t.jsx)(n.code,{children:"org.jitsi.meet.sdk.JitsiMeetView"})," class which\nextends ",(0,t.jsx)(n.code,{children:"android.view.View"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Note that this should only be needed when ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"})," cannot be used for\nsome reason. Extending ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," requires manual wiring of the view to\nthe activity, using a lot of boilerplate code. Using the Activity instead of the\nView is strongly recommended."]}),"\n",(0,t.jsxs)(i,{children:[(0,t.jsx)("summary",{children:"Show example"}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'package org.jitsi.example;\n\nimport android.os.Bundle;\nimport android.support.v4.app.FragmentActivity;\n\nimport org.jitsi.meet.sdk.JitsiMeetView;\nimport org.jitsi.meet.sdk.ReactActivityLifecycleCallbacks;\n\n// Example\n//\npublic class MainActivity extends FragmentActivity implements JitsiMeetActivityInterface {\n private JitsiMeetView view;\n\n @Override\n protected void onActivityResult(\n int requestCode,\n int resultCode,\n Intent data) {\n JitsiMeetActivityDelegate.onActivityResult(\n this, requestCode, resultCode, data);\n }\n\n @Override\n public void onBackPressed() {\n JitsiMeetActivityDelegate.onBackPressed();\n }\n\n @Override\n protected void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n view = new JitsiMeetView(this);\n JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder()\n .setRoom("https://meet.jit.si/test123")\n .build();\n view.join(options);\n\n setContentView(view);\n }\n\n @Override\n protected void onDestroy() {\n super.onDestroy();\n\n view.dispose();\n view = null;\n\n JitsiMeetActivityDelegate.onHostDestroy(this);\n }\n\n @Override\n public void onNewIntent(Intent intent) {\n JitsiMeetActivityDelegate.onNewIntent(intent);\n }\n\n @Override\n public void onRequestPermissionsResult(\n final int requestCode,\n final String[] permissions,\n final int[] grantResults) {\n JitsiMeetActivityDelegate.onRequestPermissionsResult(requestCode, permissions, grantResults);\n }\n\n @Override\n protected void onResume() {\n super.onResume();\n\n JitsiMeetActivityDelegate.onHostResume(this);\n }\n\n @Override\n protected void onStop() {\n super.onStop();\n\n JitsiMeetActivityDelegate.onHostPause(this);\n }\n}\n'})})]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetactivity",children:"JitsiMeetActivity"}),"\n",(0,t.jsxs)(n.p,{children:["This class encapsulates a high level API in the form of an Android ",(0,t.jsx)(n.code,{children:"FragmentActivity"}),"\nwhich displays a single ",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),". You can pass a URL as a ",(0,t.jsx)(n.code,{children:"ACTION_VIEW"}),"\non the Intent when starting it and it will join the conference, and will be\nautomatically terminated (finish() will be called on the activity) when the\nconference ends or fails."]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetview",children:"JitsiMeetView"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," class is the core of Jitsi Meet SDK. It's designed to\ndisplay a Jitsi Meet conference (or a welcome page)."]}),"\n",(0,t.jsx)(n.h4,{id:"joinoptions",children:"join(options)"}),"\n",(0,t.jsxs)(n.p,{children:["Joins the conference specified by the given ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptions"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(n.p,{children:["Releases all resources associated with this view. This method MUST be called\nwhen the Activity holding this view is going to be destroyed, usually in the\n",(0,t.jsx)(n.code,{children:"onDestroy()"})," method."]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetconferenceoptions",children:"JitsiMeetConferenceOptions"}),"\n",(0,t.jsx)(n.p,{children:"This object encapsulates all the options that can be tweaked when joining\na conference."}),"\n",(0,t.jsx)(n.p,{children:"Example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'ArrayList customToolbarButtons = new ArrayList();\n\nBundle firstCustomButton = new Bundle();\nBundle secondCustomButton = new Bundle();\n\nfirstCustomButton.putString("text", "Button one");\nfirstCustomButton.putString("icon", "https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png");\nfirstCustomButton.putString("id", "btn1");\n\nsecondCustomButton.putString("text", "Button two");\nsecondCustomButton.putString("icon", "https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png");\nsecondCustomButton.putString("id", "btn2");\n\ncustomToolbarButtons.add(firstCustomButton);\ncustomToolbarButtons.add(secondCustomButton);\n \nJitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder()\n .setServerURL(new URL("https://meet.jit.si"))\n .setRoom("MonthlyEndorsementsRebuildConsequently")\n .setAudioMuted(false)\n .setVideoMuted(false)\n .setAudioOnly(false)\n .setWelcomePageEnabled(false)\n .setConfigOverride("requireDisplayName", true)\n .setConfigOverride("customToolbarButtons", customToolbarButtons)\n .build();\n'})}),"\n",(0,t.jsxs)(n.p,{children:["See the ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptions"})," implementation for all available options."]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetactivitydelegate",children:"JitsiMeetActivityDelegate"}),"\n",(0,t.jsxs)(n.p,{children:["This class handles the interaction between ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," and its enclosing\n",(0,t.jsx)(n.code,{children:"Activity"}),". Generally this shouldn't be consumed by users, because they'd be\nusing ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"})," instead, which is already completely integrated."]}),"\n",(0,t.jsx)(n.p,{children:"All its methods are static."}),"\n",(0,t.jsx)(n.h4,{id:"onactivityresult",children:"onActivityResult(...)"}),"\n",(0,t.jsx)(n.p,{children:"Helper method to handle results of auxiliary activities launched by the SDK.\nShould be called from the activity method of the same name."}),"\n",(0,t.jsx)(n.h4,{id:"onbackpressed",children:"onBackPressed()"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onBackPressed"})," method.\nIf this function returns ",(0,t.jsx)(n.code,{children:"true"}),", it means the action was handled and thus no\nextra processing is required; otherwise the app should call the parent's\n",(0,t.jsx)(n.code,{children:"onBackPressed"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onhostdestroy",children:"onHostDestroy(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onDestroy"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onhostresume",children:"onHostResume(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onResume"})," or ",(0,t.jsx)(n.code,{children:"onStop"}),"\nmethod."]}),"\n",(0,t.jsx)(n.h4,{id:"onhoststop",children:"onHostStop(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onSstop"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onnewintent",children:"onNewIntent(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method for integrating the ",(0,t.jsx)(n.em,{children:"deep linking"})," functionality. If your app's\nactivity is launched in \"singleTask\" mode this method should be called from the\nactivity's ",(0,t.jsx)(n.code,{children:"onNewIntent"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onrequestpermissionsresult",children:"onRequestPermissionsResult(...)"}),"\n",(0,t.jsx)(n.p,{children:"Helper method to handle permission requests inside the SDK. It should be called\nfrom the activity method of the same name."}),"\n",(0,t.jsx)(n.h4,{id:"onuserleavehint",children:"onUserLeaveHint()"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method for integrating automatic Picture-in-Picture. It should be called\nfrom the activity's ",(0,t.jsx)(n.code,{children:"onUserLeaveHint"})," method."]}),"\n",(0,t.jsx)(n.p,{children:"This is a static method."}),"\n",(0,t.jsx)(n.h3,{id:"listening-for-broadcasted-events",children:"Listening for broadcasted events"}),"\n",(0,t.jsx)(n.p,{children:"The SDK broadcasts several events that the users can listen for."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:" IntentFilter intentFilter = new IntentFilter();\n intentFilter.addAction(BroadcastEvent.Type.CONFERENCE_JOINED.getAction());\n LocalBroadcastManager.getInstance(this).registerReceiver(broadcastReceiver, intentFilter);\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Please see ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"}),", which registers for all the events and can serve as an example."]}),"\n",(0,t.jsx)(n.h4,{id:"supported-events",children:"Supported events"}),"\n",(0,t.jsx)(n.h5,{id:"conference_joined",children:"CONFERENCE_JOINED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a conference was joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"conference_terminated",children:"CONFERENCE_TERMINATED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the active conference ends, be it because of user choice or because of a failure. ",(0,t.jsx)(n.code,{children:"data"})," contains the\nfollowing information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"error"}),": missing if the conference finished gracefully, otherwise contains the error message"]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"conference_will_join",children:"CONFERENCE_WILL_JOIN"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted before a conference is joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"audio_muted_changed",children:"AUDIO_MUTED_CHANGED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the local participant's audio is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": a boolean indicating whether the audio is muted or not."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"participant_joined",children:"PARTICIPANT_JOINED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a participant has joined the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"email"}),": the email of the participant. It may not be set if the remote participant didn't set one."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"name"}),": the name of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"role"}),": the role of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"participant_left",children:"PARTICIPANT_LEFT"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a participant has left the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant that left."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"endpoint_text_message_received",children:"ENDPOINT_TEXT_MESSAGE_RECEIVED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when an endpoint text message is received. The ",(0,t.jsx)(n.code,{children:"data"})," HashMap contains a ",(0,t.jsx)(n.code,{children:"senderId"})," key with the\nparticipantId of the sender and a ",(0,t.jsx)(n.code,{children:"message"})," key with the content."]}),"\n",(0,t.jsx)(n.h4,{id:"screen_share_toggled",children:"SCREEN_SHARE_TOGGLED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a participant starts or stops sharing his screen. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": Id of the participant that started or stopped sharing his screen."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"sharing"}),": True if the participant is sharing his screen, false otherwise."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"participants_info_retrieved",children:"PARTICIPANTS_INFO_RETRIEVED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a RETRIEVE_PARTICIPANTS_INFO action is called. The ",(0,t.jsx)(n.code,{children:"data"})," HashMap contains a ",(0,t.jsx)(n.code,{children:"participantsInfo"})," key\nwith a list of participants information and a ",(0,t.jsx)(n.code,{children:"requestId"})," key with the ID that was sent in the\nRETRIEVE_PARTICIPANTS_INFO action."]}),"\n",(0,t.jsx)(n.h5,{id:"chat_message_received",children:"CHAT_MESSAGE_RECEIVED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a chat text message is received. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"senderId"}),": the id of the participant that sent the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"message"}),": the content of the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isPrivate"}),": true if the message is private, false otherwise."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"timestamp"}),": the (optional) timestamp of the message."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"chat_toggled",children:"CHAT_TOGGLED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the chat dialog is opened or closed. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isOpen"}),": true if the chat dialog is open, false otherwise."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"video_muted_changed",children:"VIDEO_MUTED_CHANGED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the local participant's video is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": an integer indicating whether the video is muted or not. 0 means unmuted, and 4 means muted."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"ready_to_close",children:"READY_TO_CLOSE"}),"\n",(0,t.jsx)(n.p,{children:"The SDK is ready to be closed / dismissed."}),"\n",(0,t.jsx)(n.h5,{id:"custom_overflow_menu_button_pressed",children:"CUSTOM_OVERFLOW_MENU_BUTTON_PRESSED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a custom button in the overflow menu is pressed. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"id"}),": the id of the pressed custom button."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"text"}),": the label of the pressed custom button."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"broadcasting-actions",children:"Broadcasting Actions"}),"\n",(0,t.jsx)(n.p,{children:"The SDK listens for broadcasted actions from the users and reacts accordingly."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:' Intent muteBroadcastIntent = new Intent(BroadcastAction.Type.SET_AUDIO_MUTED.getAction());\n muteBroadcastIntent.putExtra("muted", muted);\n LocalBroadcastManager.getInstance(getApplicationContext()).sendBroadcast(muteBroadcastIntent);\n'})}),"\n",(0,t.jsxs)(n.p,{children:["The intents can be built manually (as shown above) or through the methods in ",(0,t.jsx)(n.code,{children:"BroadcastIntentHelper"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Please see ",(0,t.jsx)(n.code,{children:"JitsiMeetOngoingConferenceService"})," for more examples of sending actions."]}),"\n",(0,t.jsx)(n.h4,{id:"supported-actions",children:"Supported actions"}),"\n",(0,t.jsx)(n.h5,{id:"set_audio_muted",children:"SET_AUDIO_MUTED"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant audio muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter.\nExpects a ",(0,t.jsx)(n.code,{children:"muted"})," key on the intent extra with a boolean value."]}),"\n",(0,t.jsx)(n.h5,{id:"set_video_muted",children:"SET_VIDEO_MUTED"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant video muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter.\nExpects a ",(0,t.jsx)(n.code,{children:"muted"})," key on the intent extra with a boolean value."]}),"\n",(0,t.jsx)(n.h5,{id:"hang_up",children:"HANG_UP"}),"\n",(0,t.jsx)(n.p,{children:"The localParticipant leaves the current conference.\nDoes not expect any extra value."}),"\n",(0,t.jsx)(n.h5,{id:"send_endpoint_text_message",children:"SEND_ENDPOINT_TEXT_MESSAGE"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a message via the data channel to one particular participant or all of them.\nExpects a ",(0,t.jsx)(n.code,{children:"to"})," key on the intent extra with the ID of the participant to which the message\nis meant and a ",(0,t.jsx)(n.code,{children:"message"})," key with a string value, the actual content of the message.\nIf the ",(0,t.jsx)(n.code,{children:"to"})," key is not present or its value is empty, the message will be sent\nto all the participants in the conference."]}),"\n",(0,t.jsxs)(n.p,{children:["To get the participantId, the ",(0,t.jsx)(n.code,{children:"PARTICIPANT_JOINED"})," event should be listened for,\nwhich ",(0,t.jsx)(n.code,{children:"data"})," includes the id and this should be stored somehow."]}),"\n",(0,t.jsx)(n.h5,{id:"toggle_screen_share",children:"TOGGLE_SCREEN_SHARE"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant screen share according to the ",(0,t.jsx)(n.code,{children:"enabled"})," parameter.\nExpects an ",(0,t.jsx)(n.code,{children:"enabled"})," key on the intent extra with a boolean value."]}),"\n",(0,t.jsx)(n.h5,{id:"retrieve_participants_info",children:"RETRIEVE_PARTICIPANTS_INFO"}),"\n",(0,t.jsxs)(n.p,{children:["Signals the SDK to retrieve a list with the participant's information. The SDK will emit a PARTICIPANTS_INFO_RETRIEVED event.\nExpects a ",(0,t.jsx)(n.code,{children:"requestId"})," key on the intent extra with a string value, this parameter will be present on the PARTICIPANTS_INFO_RETRIEVED event."]}),"\n",(0,t.jsx)(n.h5,{id:"open_chat",children:"OPEN_CHAT"}),"\n",(0,t.jsxs)(n.p,{children:["Opens the chat dialog. If a ",(0,t.jsx)(n.code,{children:"to"})," key is present with a valid participantId, the private chat for that particular participant will be opened."]}),"\n",(0,t.jsx)(n.h5,{id:"close_chat",children:"CLOSE_CHAT"}),"\n",(0,t.jsx)(n.p,{children:"Closes the chat dialog.\nDoes not expect any extra value."}),"\n",(0,t.jsx)(n.h5,{id:"send_chat_message",children:"SEND_CHAT_MESSAGE"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a chat message, either a private one if a ",(0,t.jsx)(n.code,{children:"to"})," key is present with a valid participantId and to everybody otherwise.\nExpect a ",(0,t.jsx)(n.code,{children:"message"})," key with a string value."]}),"\n",(0,t.jsx)(n.h2,{id:"proguard-rules",children:"ProGuard rules"}),"\n",(0,t.jsxs)(n.p,{children:["When using the SDK on a project some proguard rules have to be added to avoid necessary code being stripped. Add the following to your project's\nrules file: ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/android/app/proguard-rules.pro",children:"https://github.com/jitsi/jitsi-meet/blob/master/android/app/proguard-rules.pro"})]}),"\n",(0,t.jsx)(n.h2,{id:"picture-in-picture",children:"Picture-in-Picture"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"JitsiMeetView"}),' will automatically adjust its UI when presented in a\nPicture-in-Picture style scenario, in a rectangle too small to accommodate its\n"full" UI.']}),"\n",(0,t.jsx)(n.h2,{id:"dropbox-integration",children:"Dropbox integration"}),"\n",(0,t.jsx)(n.p,{children:"To set up the Dropbox integration, follow these steps:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Add the following to the app's AndroidManifest.xml and change ",(0,t.jsx)(n.code,{children:""})," to\nyour Dropbox app key:"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-xml",children:'\n \n \n \n \n \n \n\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsxs)(n.li,{children:["Add the following to the app's strings.xml and change ",(0,t.jsx)(n.code,{children:""})," to your\nDropbox app key:"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-xml",children:'\n'})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var t=i(6540);const s={},o=t.createContext(s);function d(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[9368],{6350:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=i(4848),s=i(8453);const o={id:"dev-guide-android-sdk",title:"Android SDK"},d=void 0,r={id:"dev-guide/dev-guide-android-sdk",title:"Android SDK",description:"The Jitsi Meet Android SDK provides the same user experience as the Jitsi Meet app,",source:"@site/docs/dev-guide/android-sdk.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-android-sdk",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/android-sdk.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"dev-guide-android-sdk",title:"Android SDK"},sidebar:"docs",previous:{title:"React SDK",permalink:"/handbook/docs/dev-guide/dev-guide-react-sdk"},next:{title:"iOS SDK",permalink:"/handbook/docs/dev-guide/dev-guide-ios-sdk"}},a={},l=[{value:"Sample applications using the SDK",id:"sample-applications-using-the-sdk",level:2},{value:"Build your own, or use a pre-build SDK artifacts/binaries",id:"build-your-own-or-use-a-pre-build-sdk-artifactsbinaries",level:2},{value:"Use pre-build SDK artifacts/binaries",id:"use-pre-build-sdk-artifactsbinaries",level:3},{value:"Build and use your own SDK artifacts/binaries",id:"build-and-use-your-own-sdk-artifactsbinaries",level:3},{value:"Using the API",id:"using-the-api",level:2},{value:"JitsiMeetActivity",id:"jitsimeetactivity",level:3},{value:"JitsiMeetView",id:"jitsimeetview",level:3},{value:"join(options)",id:"joinoptions",level:4},{value:"dispose()",id:"dispose",level:4},{value:"JitsiMeetConferenceOptions",id:"jitsimeetconferenceoptions",level:3},{value:"JitsiMeetActivityDelegate",id:"jitsimeetactivitydelegate",level:3},{value:"onActivityResult(...)",id:"onactivityresult",level:4},{value:"onBackPressed()",id:"onbackpressed",level:4},{value:"onHostDestroy(...)",id:"onhostdestroy",level:4},{value:"onHostResume(...)",id:"onhostresume",level:4},{value:"onHostStop(...)",id:"onhoststop",level:4},{value:"onNewIntent(...)",id:"onnewintent",level:4},{value:"onRequestPermissionsResult(...)",id:"onrequestpermissionsresult",level:4},{value:"onUserLeaveHint()",id:"onuserleavehint",level:4},{value:"Listening for broadcasted events",id:"listening-for-broadcasted-events",level:3},{value:"Supported events",id:"supported-events",level:4},{value:"CONFERENCE_JOINED",id:"conference_joined",level:5},{value:"CONFERENCE_TERMINATED",id:"conference_terminated",level:5},{value:"CONFERENCE_WILL_JOIN",id:"conference_will_join",level:5},{value:"AUDIO_MUTED_CHANGED",id:"audio_muted_changed",level:5},{value:"PARTICIPANT_JOINED",id:"participant_joined",level:5},{value:"PARTICIPANT_LEFT",id:"participant_left",level:5},{value:"ENDPOINT_TEXT_MESSAGE_RECEIVED",id:"endpoint_text_message_received",level:5},{value:"SCREEN_SHARE_TOGGLED",id:"screen_share_toggled",level:4},{value:"PARTICIPANTS_INFO_RETRIEVED",id:"participants_info_retrieved",level:5},{value:"CHAT_MESSAGE_RECEIVED",id:"chat_message_received",level:5},{value:"CHAT_TOGGLED",id:"chat_toggled",level:5},{value:"VIDEO_MUTED_CHANGED",id:"video_muted_changed",level:5},{value:"READY_TO_CLOSE",id:"ready_to_close",level:5},{value:"CUSTOM_OVERFLOW_MENU_BUTTON_PRESSED",id:"custom_overflow_menu_button_pressed",level:5},{value:"Broadcasting Actions",id:"broadcasting-actions",level:3},{value:"Supported actions",id:"supported-actions",level:4},{value:"SET_AUDIO_MUTED",id:"set_audio_muted",level:5},{value:"SET_VIDEO_MUTED",id:"set_video_muted",level:5},{value:"HANG_UP",id:"hang_up",level:5},{value:"SEND_ENDPOINT_TEXT_MESSAGE",id:"send_endpoint_text_message",level:5},{value:"TOGGLE_SCREEN_SHARE",id:"toggle_screen_share",level:5},{value:"RETRIEVE_PARTICIPANTS_INFO",id:"retrieve_participants_info",level:5},{value:"OPEN_CHAT",id:"open_chat",level:5},{value:"CLOSE_CHAT",id:"close_chat",level:5},{value:"SEND_CHAT_MESSAGE",id:"send_chat_message",level:5},{value:"ProGuard rules",id:"proguard-rules",level:2},{value:"Picture-in-Picture",id:"picture-in-picture",level:2},{value:"Dropbox integration",id:"dropbox-integration",level:2}];function c(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components},{Details:i}=n;return i||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"The Jitsi Meet Android SDK provides the same user experience as the Jitsi Meet app,\nin a customizable way which you can embed in your apps."}),"\n",(0,t.jsx)(n.admonition,{type:"important",children:(0,t.jsx)(n.p,{children:"Android 7.0 (API level 24) or higher is required."})}),"\n",(0,t.jsx)(n.h2,{id:"sample-applications-using-the-sdk",children:"Sample applications using the SDK"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the\n",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-sdk-samples#android",children:"sample applications repository"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"build-your-own-or-use-a-pre-build-sdk-artifactsbinaries",children:"Build your own, or use a pre-build SDK artifacts/binaries"}),"\n",(0,t.jsx)(n.p,{children:"Jitsi conveniently provides a pre-build SDK artifacts/binaries in its Maven repository. When you do not require any\nmodification to the SDK itself or any of its dependencies, it's suggested to use the pre-build SDK. This avoids the\ncomplexity of building and installing your own SDK artifacts/binaries."}),"\n",(0,t.jsx)(n.h3,{id:"use-pre-build-sdk-artifactsbinaries",children:"Use pre-build SDK artifacts/binaries"}),"\n",(0,t.jsxs)(n.p,{children:["In your project, add the Maven repository\n",(0,t.jsx)(n.code,{children:"https://github.com/jitsi/jitsi-maven-repository/raw/master/releases"})," and the\ndependency ",(0,t.jsx)(n.code,{children:"org.jitsi.react:jitsi-meet-sdk"})," into your ",(0,t.jsx)(n.code,{children:"build.gradle"})," files."]}),"\n",(0,t.jsxs)(n.p,{children:["The repository typically goes into the ",(0,t.jsx)(n.code,{children:"build.gradle"})," file in the root of your project:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",metastring:'title="build.gradle"',children:"allprojects {\n repositories {\n maven {\n url \"https://github.com/jitsi/jitsi-maven-repository/raw/master/releases\"\n }\n google()\n mavenCentral()\n maven { url 'https://www.jitpack.io' }\n }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["In recent versions of Android Studios, ",(0,t.jsx)(n.code,{children:"allprojects{}"})," might not be found in ",(0,t.jsx)(n.code,{children:"build.gradle"}),". In that case, the repository goes into the ",(0,t.jsx)(n.code,{children:"settings.gradle"})," file in the root of your project:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",metastring:'title="settings.gradle"',children:'dependencyResolutionManagement {\n repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)\n repositories {\n google()\n mavenCentral()\n maven {\n url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases"\n }\n maven {\n url "https://maven.google.com"\n }\n }\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Dependency definitions belong in the individual module ",(0,t.jsx)(n.code,{children:"build.gradle"})," files:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",children:"dependencies {\n // (other dependencies)\n implementation ('org.jitsi.react:jitsi-meet-sdk:+') { transitive = true }\n}\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"warning",children:(0,t.jsxs)(n.p,{children:["Make sure you pin your dependency by checking the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-release-notes/blob/master/CHANGELOG-MOBILE-SDKS.md",children:"releases page"}),"."]})}),"\n",(0,t.jsx)(n.h3,{id:"build-and-use-your-own-sdk-artifactsbinaries",children:"Build and use your own SDK artifacts/binaries"}),"\n",(0,t.jsxs)(i,{children:[(0,t.jsx)("summary",{children:"Show building instructions"}),(0,t.jsxs)(n.p,{children:["Start by making sure that your development environment ",(0,t.jsx)(n.a,{href:"/docs/category/mobile",children:"is set up correctly"}),"."]}),(0,t.jsx)(n.admonition,{title:"A Note on Dependencies",type:"note",children:(0,t.jsxs)(n.p,{children:["Apart from the SDK, Jitsi also publishes a binary Maven artifact for some of the SDK dependencies (that are not otherwise publicly available) to the Jitsi Maven repository. When you're planning to use a SDK that is built from source, you'll likely use a version of the source code that is newer (or at least ",(0,t.jsx)(n.em,{children:"different"}),") than the version of the source that was used to create the binary SDK artifact. As a consequence, the dependencies that your project will need, might also be different from those that are published in the Jitsi Maven repository. This might lead to build problems, caused by dependencies that are unavailable."]})}),(0,t.jsxs)(n.p,{children:["If you want to use a SDK that is built from source, you will likely benefit from composing a local Maven repository that contains these dependencies. The text below describes how you create a repository that includes both the SDK as well as these dependencies. For illustration purposes, we'll define the location of this local Maven repository as ",(0,t.jsx)(n.code,{children:"/tmp/repo"})]}),(0,t.jsxs)(n.p,{children:["In source code form, the Android SDK dependencies are locked/pinned by ",(0,t.jsx)(n.code,{children:"package.json"})," and ",(0,t.jsx)(n.code,{children:"package-lock.json"})," of the Jitsi Meet project. To obtain the data, execute NPM in the jitsi-meet project directory:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-shell",children:" npm install\n"})}),(0,t.jsx)(n.p,{children:"This will pull in the dependencies in either binary format, or in source code format, somewhere under /node_modules/"}),(0,t.jsxs)(n.p,{children:["Third-party React Native ",(0,t.jsx)(n.em,{children:"modules"}),", which Jitsi Meet SDK for Android depends on, are download by NPM in source code\nor binary form. These need to be assembled into Maven artifacts, and then published to your local Maven repository.\nA script is provided to facilitate this. From the root of the jitsi-meet project repository, run:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-shell",children:" ./android/scripts/release-sdk.sh /tmp/repo\n"})}),(0,t.jsxs)(n.p,{children:["This will build and publish the SDK, and all of its dependencies to the specified Maven repository (",(0,t.jsx)(n.code,{children:"/tmp/repo"}),") in\nthis example."]}),(0,t.jsxs)(n.p,{children:["You're now ready to use the artifacts. In ",(0,t.jsx)(n.em,{children:"your"})," project, add the Maven repository that you used above (",(0,t.jsx)(n.code,{children:"/tmp/repo"}),") into your top-level ",(0,t.jsx)(n.code,{children:"build.gradle"})," file:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",children:" allprojects {\n repositories {\n maven { url \"file:/tmp/repo\" }\n google()\n mavenCentral()\n maven { url 'https://www.jitpack.io' }\n }\n }\n"})}),(0,t.jsxs)(n.p,{children:["You can use your local repository to replace the Jitsi repository (",(0,t.jsx)(n.code,{children:'maven { url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases" }'}),") when you published ",(0,t.jsx)(n.em,{children:"all"})," subprojects. If you didn't do that, you'll have to add both repositories. Make sure your local repository is listed first!"]}),(0,t.jsxs)(n.p,{children:["Then, define the dependency ",(0,t.jsx)(n.code,{children:"org.jitsi.react:jitsi-meet-sdk"})," into the ",(0,t.jsx)(n.code,{children:"build.gradle"})," file of your module:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:" implementation ('org.jitsi.react:jitsi-meet-sdk:+') { transitive = true }\n"})}),(0,t.jsxs)(n.p,{children:["Note that there should not be a need to explicitly add the other dependencies, as they will be pulled in as transitive\ndependencies of ",(0,t.jsx)(n.code,{children:"jitsi-meet-sdk"}),"."]})]}),"\n",(0,t.jsx)(n.h2,{id:"using-the-api",children:"Using the API"}),"\n",(0,t.jsx)(n.p,{children:"Jitsi Meet SDK is an Android library which embodies the whole Jitsi Meet\nexperience and makes it reusable by third-party apps."}),"\n",(0,t.jsxs)(n.p,{children:["First, add Java 1.8 compatibility support to your project by adding the\nfollowing lines into your ",(0,t.jsx)(n.code,{children:"build.gradle"})," file:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-gradle",children:"compileOptions {\n sourceCompatibility JavaVersion.VERSION_1_8\n targetCompatibility JavaVersion.VERSION_1_8\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["To get started, just launch ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"})," pointing to the room you want:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'// Somewhere early in your app.\nJitsiMeetConferenceOptions defaultOptions\n = new JitsiMeetConferenceOptions.Builder()\n .setServerURL(serverURL)\n // When using JaaS, set the obtained JWT here\n //.setToken("MyJWT")\n // Different features flags can be set\n // .setFeatureFlag("toolbox.enabled", false)\n // .setFeatureFlag("filmstrip.enabled", false)\n .setFeatureFlag("welcomepage.enabled", false)\n .build();\nJitsiMeet.setDefaultConferenceOptions(defaultOptions);\n// ...\n// Build options object for joining the conference. The SDK will merge the default\n// one we set earlier and this one when joining.\nJitsiMeetConferenceOptions options\n = new JitsiMeetConferenceOptions.Builder()\n .setRoom(roomName)\n // Settings for audio and video\n //.setAudioMuted(true)\n //.setVideoMuted(true)\n .build();\n// Launch the new activity with the given options. The launch() method takes care\n// of creating the required Intent and passing the options.\nJitsiMeetActivity.launch(this, options);\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Alternatively, you can use the ",(0,t.jsx)(n.code,{children:"org.jitsi.meet.sdk.JitsiMeetView"})," class which\nextends ",(0,t.jsx)(n.code,{children:"android.view.View"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Note that this should only be needed when ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"})," cannot be used for\nsome reason. Extending ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," requires manual wiring of the view to\nthe activity, using a lot of boilerplate code. Using the Activity instead of the\nView is strongly recommended."]}),"\n",(0,t.jsxs)(i,{children:[(0,t.jsx)("summary",{children:"Show example"}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'package org.jitsi.example;\n\nimport android.os.Bundle;\nimport android.support.v4.app.FragmentActivity;\n\nimport org.jitsi.meet.sdk.JitsiMeetView;\nimport org.jitsi.meet.sdk.ReactActivityLifecycleCallbacks;\n\n// Example\n//\npublic class MainActivity extends FragmentActivity implements JitsiMeetActivityInterface {\n private JitsiMeetView view;\n\n @Override\n protected void onActivityResult(\n int requestCode,\n int resultCode,\n Intent data) {\n JitsiMeetActivityDelegate.onActivityResult(\n this, requestCode, resultCode, data);\n }\n\n @Override\n public void onBackPressed() {\n JitsiMeetActivityDelegate.onBackPressed();\n }\n\n @Override\n protected void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n view = new JitsiMeetView(this);\n JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder()\n .setRoom("https://meet.jit.si/test123")\n .build();\n view.join(options);\n\n setContentView(view);\n }\n\n @Override\n protected void onDestroy() {\n super.onDestroy();\n\n view.dispose();\n view = null;\n\n JitsiMeetActivityDelegate.onHostDestroy(this);\n }\n\n @Override\n public void onNewIntent(Intent intent) {\n JitsiMeetActivityDelegate.onNewIntent(intent);\n }\n\n @Override\n public void onRequestPermissionsResult(\n final int requestCode,\n final String[] permissions,\n final int[] grantResults) {\n JitsiMeetActivityDelegate.onRequestPermissionsResult(requestCode, permissions, grantResults);\n }\n\n @Override\n protected void onResume() {\n super.onResume();\n\n JitsiMeetActivityDelegate.onHostResume(this);\n }\n\n @Override\n protected void onStop() {\n super.onStop();\n\n JitsiMeetActivityDelegate.onHostPause(this);\n }\n}\n'})})]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetactivity",children:"JitsiMeetActivity"}),"\n",(0,t.jsxs)(n.p,{children:["This class encapsulates a high level API in the form of an Android ",(0,t.jsx)(n.code,{children:"FragmentActivity"}),"\nwhich displays a single ",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),". You can pass a URL as a ",(0,t.jsx)(n.code,{children:"ACTION_VIEW"}),"\non the Intent when starting it and it will join the conference, and will be\nautomatically terminated (finish() will be called on the activity) when the\nconference ends or fails."]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetview",children:"JitsiMeetView"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," class is the core of Jitsi Meet SDK. It's designed to\ndisplay a Jitsi Meet conference (or a welcome page)."]}),"\n",(0,t.jsx)(n.h4,{id:"joinoptions",children:"join(options)"}),"\n",(0,t.jsxs)(n.p,{children:["Joins the conference specified by the given ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptions"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(n.p,{children:["Releases all resources associated with this view. This method MUST be called\nwhen the Activity holding this view is going to be destroyed, usually in the\n",(0,t.jsx)(n.code,{children:"onDestroy()"})," method."]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetconferenceoptions",children:"JitsiMeetConferenceOptions"}),"\n",(0,t.jsx)(n.p,{children:"This object encapsulates all the options that can be tweaked when joining\na conference."}),"\n",(0,t.jsx)(n.p,{children:"Example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'ArrayList customToolbarButtons = new ArrayList();\n\nBundle firstCustomButton = new Bundle();\nBundle secondCustomButton = new Bundle();\n\nfirstCustomButton.putString("text", "Button one");\nfirstCustomButton.putString("icon", "https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png");\nfirstCustomButton.putString("id", "btn1");\n\nsecondCustomButton.putString("text", "Button two");\nsecondCustomButton.putString("icon", "https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png");\nsecondCustomButton.putString("id", "btn2");\n\ncustomToolbarButtons.add(firstCustomButton);\ncustomToolbarButtons.add(secondCustomButton);\n \nJitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder()\n .setServerURL(new URL("https://meet.jit.si"))\n .setRoom("MonthlyEndorsementsRebuildConsequently")\n .setAudioMuted(false)\n .setVideoMuted(false)\n .setAudioOnly(false)\n .setWelcomePageEnabled(false)\n .setConfigOverride("requireDisplayName", true)\n .setConfigOverride("customToolbarButtons", customToolbarButtons)\n .build();\n'})}),"\n",(0,t.jsxs)(n.p,{children:["See the ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptions"})," implementation for all available options."]}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetactivitydelegate",children:"JitsiMeetActivityDelegate"}),"\n",(0,t.jsxs)(n.p,{children:["This class handles the interaction between ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," and its enclosing\n",(0,t.jsx)(n.code,{children:"Activity"}),". Generally this shouldn't be consumed by users, because they'd be\nusing ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"})," instead, which is already completely integrated."]}),"\n",(0,t.jsx)(n.p,{children:"All its methods are static."}),"\n",(0,t.jsx)(n.h4,{id:"onactivityresult",children:"onActivityResult(...)"}),"\n",(0,t.jsx)(n.p,{children:"Helper method to handle results of auxiliary activities launched by the SDK.\nShould be called from the activity method of the same name."}),"\n",(0,t.jsx)(n.h4,{id:"onbackpressed",children:"onBackPressed()"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onBackPressed"})," method.\nIf this function returns ",(0,t.jsx)(n.code,{children:"true"}),", it means the action was handled and thus no\nextra processing is required; otherwise the app should call the parent's\n",(0,t.jsx)(n.code,{children:"onBackPressed"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onhostdestroy",children:"onHostDestroy(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onDestroy"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onhostresume",children:"onHostResume(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onResume"})," or ",(0,t.jsx)(n.code,{children:"onStop"}),"\nmethod."]}),"\n",(0,t.jsx)(n.h4,{id:"onhoststop",children:"onHostStop(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method which should be called from the activity's ",(0,t.jsx)(n.code,{children:"onSstop"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onnewintent",children:"onNewIntent(...)"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method for integrating the ",(0,t.jsx)(n.em,{children:"deep linking"})," functionality. If your app's\nactivity is launched in \"singleTask\" mode this method should be called from the\nactivity's ",(0,t.jsx)(n.code,{children:"onNewIntent"})," method."]}),"\n",(0,t.jsx)(n.h4,{id:"onrequestpermissionsresult",children:"onRequestPermissionsResult(...)"}),"\n",(0,t.jsx)(n.p,{children:"Helper method to handle permission requests inside the SDK. It should be called\nfrom the activity method of the same name."}),"\n",(0,t.jsx)(n.h4,{id:"onuserleavehint",children:"onUserLeaveHint()"}),"\n",(0,t.jsxs)(n.p,{children:["Helper method for integrating automatic Picture-in-Picture. It should be called\nfrom the activity's ",(0,t.jsx)(n.code,{children:"onUserLeaveHint"})," method."]}),"\n",(0,t.jsx)(n.p,{children:"This is a static method."}),"\n",(0,t.jsx)(n.h3,{id:"listening-for-broadcasted-events",children:"Listening for broadcasted events"}),"\n",(0,t.jsx)(n.p,{children:"The SDK broadcasts several events that the users can listen for."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:" IntentFilter intentFilter = new IntentFilter();\n intentFilter.addAction(BroadcastEvent.Type.CONFERENCE_JOINED.getAction());\n LocalBroadcastManager.getInstance(this).registerReceiver(broadcastReceiver, intentFilter);\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Please see ",(0,t.jsx)(n.code,{children:"JitsiMeetActivity"}),", which registers for all the events and can serve as an example."]}),"\n",(0,t.jsx)(n.h4,{id:"supported-events",children:"Supported events"}),"\n",(0,t.jsx)(n.h5,{id:"conference_joined",children:"CONFERENCE_JOINED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a conference was joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"conference_terminated",children:"CONFERENCE_TERMINATED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the active conference ends, be it because of user choice or because of a failure. ",(0,t.jsx)(n.code,{children:"data"})," contains the\nfollowing information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"error"}),": missing if the conference finished gracefully, otherwise contains the error message"]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"conference_will_join",children:"CONFERENCE_WILL_JOIN"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted before a conference is joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"audio_muted_changed",children:"AUDIO_MUTED_CHANGED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the local participant's audio is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": a boolean indicating whether the audio is muted or not."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"participant_joined",children:"PARTICIPANT_JOINED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a participant has joined the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"email"}),": the email of the participant. It may not be set if the remote participant didn't set one."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"name"}),": the name of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"role"}),": the role of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"participant_left",children:"PARTICIPANT_LEFT"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a participant has left the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant that left."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"endpoint_text_message_received",children:"ENDPOINT_TEXT_MESSAGE_RECEIVED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when an endpoint text message is received. The ",(0,t.jsx)(n.code,{children:"data"})," HashMap contains a ",(0,t.jsx)(n.code,{children:"senderId"})," key with the\nparticipantId of the sender and a ",(0,t.jsx)(n.code,{children:"message"})," key with the content."]}),"\n",(0,t.jsx)(n.h4,{id:"screen_share_toggled",children:"SCREEN_SHARE_TOGGLED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a participant starts or stops sharing his screen. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": Id of the participant that started or stopped sharing his screen."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"sharing"}),": True if the participant is sharing his screen, false otherwise."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"participants_info_retrieved",children:"PARTICIPANTS_INFO_RETRIEVED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a RETRIEVE_PARTICIPANTS_INFO action is called. The ",(0,t.jsx)(n.code,{children:"data"})," HashMap contains a ",(0,t.jsx)(n.code,{children:"participantsInfo"})," key\nwith a list of participants information and a ",(0,t.jsx)(n.code,{children:"requestId"})," key with the ID that was sent in the\nRETRIEVE_PARTICIPANTS_INFO action."]}),"\n",(0,t.jsx)(n.h5,{id:"chat_message_received",children:"CHAT_MESSAGE_RECEIVED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a chat text message is received. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"senderId"}),": the id of the participant that sent the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"message"}),": the content of the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isPrivate"}),": true if the message is private, false otherwise."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"timestamp"}),": the (optional) timestamp of the message."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"chat_toggled",children:"CHAT_TOGGLED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the chat dialog is opened or closed. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isOpen"}),": true if the chat dialog is open, false otherwise."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"video_muted_changed",children:"VIDEO_MUTED_CHANGED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when the local participant's video is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": an integer indicating whether the video is muted or not. 0 means unmuted, and 4 means muted."]}),"\n"]}),"\n",(0,t.jsx)(n.h5,{id:"ready_to_close",children:"READY_TO_CLOSE"}),"\n",(0,t.jsx)(n.p,{children:"The SDK is ready to be closed / dismissed."}),"\n",(0,t.jsx)(n.h5,{id:"custom_overflow_menu_button_pressed",children:"CUSTOM_OVERFLOW_MENU_BUTTON_PRESSED"}),"\n",(0,t.jsxs)(n.p,{children:["Broadcasted when a custom button in the overflow menu is pressed. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"id"}),": the id of the pressed custom button."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"text"}),": the label of the pressed custom button."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"broadcasting-actions",children:"Broadcasting Actions"}),"\n",(0,t.jsx)(n.p,{children:"The SDK listens for broadcasted actions from the users and reacts accordingly."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:' Intent muteBroadcastIntent = new Intent(BroadcastAction.Type.SET_AUDIO_MUTED.getAction());\n muteBroadcastIntent.putExtra("muted", muted);\n LocalBroadcastManager.getInstance(getApplicationContext()).sendBroadcast(muteBroadcastIntent);\n'})}),"\n",(0,t.jsxs)(n.p,{children:["The intents can be built manually (as shown above) or through the methods in ",(0,t.jsx)(n.code,{children:"BroadcastIntentHelper"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Please see ",(0,t.jsx)(n.code,{children:"JitsiMeetOngoingConferenceService"})," for more examples of sending actions."]}),"\n",(0,t.jsx)(n.h4,{id:"supported-actions",children:"Supported actions"}),"\n",(0,t.jsx)(n.h5,{id:"set_audio_muted",children:"SET_AUDIO_MUTED"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant audio muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter.\nExpects a ",(0,t.jsx)(n.code,{children:"muted"})," key on the intent extra with a boolean value."]}),"\n",(0,t.jsx)(n.h5,{id:"set_video_muted",children:"SET_VIDEO_MUTED"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant video muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter.\nExpects a ",(0,t.jsx)(n.code,{children:"muted"})," key on the intent extra with a boolean value."]}),"\n",(0,t.jsx)(n.h5,{id:"hang_up",children:"HANG_UP"}),"\n",(0,t.jsx)(n.p,{children:"The localParticipant leaves the current conference.\nDoes not expect any extra value."}),"\n",(0,t.jsx)(n.h5,{id:"send_endpoint_text_message",children:"SEND_ENDPOINT_TEXT_MESSAGE"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a message via the data channel to one particular participant or all of them.\nExpects a ",(0,t.jsx)(n.code,{children:"to"})," key on the intent extra with the ID of the participant to which the message\nis meant and a ",(0,t.jsx)(n.code,{children:"message"})," key with a string value, the actual content of the message.\nIf the ",(0,t.jsx)(n.code,{children:"to"})," key is not present or its value is empty, the message will be sent\nto all the participants in the conference."]}),"\n",(0,t.jsxs)(n.p,{children:["To get the participantId, the ",(0,t.jsx)(n.code,{children:"PARTICIPANT_JOINED"})," event should be listened for,\nwhich ",(0,t.jsx)(n.code,{children:"data"})," includes the id and this should be stored somehow."]}),"\n",(0,t.jsx)(n.h5,{id:"toggle_screen_share",children:"TOGGLE_SCREEN_SHARE"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant screen share according to the ",(0,t.jsx)(n.code,{children:"enabled"})," parameter.\nExpects an ",(0,t.jsx)(n.code,{children:"enabled"})," key on the intent extra with a boolean value."]}),"\n",(0,t.jsx)(n.h5,{id:"retrieve_participants_info",children:"RETRIEVE_PARTICIPANTS_INFO"}),"\n",(0,t.jsxs)(n.p,{children:["Signals the SDK to retrieve a list with the participant's information. The SDK will emit a PARTICIPANTS_INFO_RETRIEVED event.\nExpects a ",(0,t.jsx)(n.code,{children:"requestId"})," key on the intent extra with a string value, this parameter will be present on the PARTICIPANTS_INFO_RETRIEVED event."]}),"\n",(0,t.jsx)(n.h5,{id:"open_chat",children:"OPEN_CHAT"}),"\n",(0,t.jsxs)(n.p,{children:["Opens the chat dialog. If a ",(0,t.jsx)(n.code,{children:"to"})," key is present with a valid participantId, the private chat for that particular participant will be opened."]}),"\n",(0,t.jsx)(n.h5,{id:"close_chat",children:"CLOSE_CHAT"}),"\n",(0,t.jsx)(n.p,{children:"Closes the chat dialog.\nDoes not expect any extra value."}),"\n",(0,t.jsx)(n.h5,{id:"send_chat_message",children:"SEND_CHAT_MESSAGE"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a chat message, either a private one if a ",(0,t.jsx)(n.code,{children:"to"})," key is present with a valid participantId and to everybody otherwise.\nExpect a ",(0,t.jsx)(n.code,{children:"message"})," key with a string value."]}),"\n",(0,t.jsx)(n.h2,{id:"proguard-rules",children:"ProGuard rules"}),"\n",(0,t.jsxs)(n.p,{children:["When using the SDK on a project some proguard rules have to be added to avoid necessary code being stripped. Add the following to your project's\nrules file: ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet/blob/master/android/app/proguard-rules.pro",children:"https://github.com/jitsi/jitsi-meet/blob/master/android/app/proguard-rules.pro"})]}),"\n",(0,t.jsx)(n.h2,{id:"picture-in-picture",children:"Picture-in-Picture"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"JitsiMeetView"}),' will automatically adjust its UI when presented in a\nPicture-in-Picture style scenario, in a rectangle too small to accommodate its\n"full" UI.']}),"\n",(0,t.jsx)(n.h2,{id:"dropbox-integration",children:"Dropbox integration"}),"\n",(0,t.jsx)(n.p,{children:"To set up the Dropbox integration, follow these steps:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Add the following to the app's AndroidManifest.xml and change ",(0,t.jsx)(n.code,{children:""})," to\nyour Dropbox app key:"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-xml",children:'\n \n \n \n \n \n \n\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsxs)(n.li,{children:["Add the following to the app's strings.xml and change ",(0,t.jsx)(n.code,{children:""})," to your\nDropbox app key:"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-xml",children:'\n'})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var t=i(6540);const s={},o=t.createContext(s);function d(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6506de4b.88a861bf.js b/assets/js/6506de4b.044361e5.js similarity index 99% rename from assets/js/6506de4b.88a861bf.js rename to assets/js/6506de4b.044361e5.js index 3c7534e6f..93fc6c88f 100644 --- a/assets/js/6506de4b.88a861bf.js +++ b/assets/js/6506de4b.044361e5.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7637],{7184:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var t=i(4848),s=i(8453);const o={id:"dev-guide-ios-sdk",title:"iOS SDK"},r=void 0,d={id:"dev-guide/dev-guide-ios-sdk",title:"iOS SDK",description:"The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app,",source:"@site/docs/dev-guide/ios-sdk.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-ios-sdk",permalink:"/handbook/docs/dev-guide/dev-guide-ios-sdk",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/ios-sdk.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"dev-guide-ios-sdk",title:"iOS SDK"},sidebar:"docs",previous:{title:"Android SDK",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk"},next:{title:"React Native SDK",permalink:"/handbook/docs/dev-guide/dev-guide-react-native-sdk"}},a={},c=[{value:"Sample applications using the SDK",id:"sample-applications-using-the-sdk",level:2},{value:"Usage",id:"usage",level:2},{value:"Using CocoaPods",id:"using-cocoapods",level:3},{value:"Building it yourself",id:"building-it-yourself",level:3},{value:"API",id:"api",level:2},{value:"JitsiMeetView class",id:"jitsimeetview-class",level:3},{value:"delegate",id:"delegate",level:4},{value:"join",id:"join",level:4},{value:"leave",id:"leave",level:4},{value:"hangUp",id:"hangup",level:4},{value:"setAudioMuted",id:"setaudiomuted",level:4},{value:"setVideoMuted",id:"setvideomuted",level:4},{value:"sendEndpointTextMessage",id:"sendendpointtextmessage",level:4},{value:"toggleScreenShare",id:"togglescreenshare",level:4},{value:"openChat",id:"openchat",level:4},{value:"sendChatMessage",id:"sendchatmessage",level:4},{value:"closeChat",id:"closechat",level:4},{value:"retrieveParticipantsInfo",id:"retrieveparticipantsinfo",level:4},{value:"Universal / deep linking",id:"universal--deep-linking",level:4},{value:"JitsiMeetViewDelegate",id:"jitsimeetviewdelegate",level:3},{value:"conferenceJoined",id:"conferencejoined",level:4},{value:"conferenceTerminated",id:"conferenceterminated",level:4},{value:"conferenceWillJoin",id:"conferencewilljoin",level:4},{value:"enterPictureInPicture",id:"enterpictureinpicture",level:4},{value:"participantJoined",id:"participantjoined",level:4},{value:"participantLeft",id:"participantleft",level:4},{value:"audioMutedChanged",id:"audiomutedchanged",level:4},{value:"videoMutedChanged",id:"videomutedchanged",level:4},{value:"endpointTextMessageReceived",id:"endpointtextmessagereceived",level:4},{value:"screenShareToggled",id:"screensharetoggled",level:4},{value:"chatMessageReceived",id:"chatmessagereceived",level:4},{value:"chatToggled",id:"chattoggled",level:4},{value:"readyToClose",id:"readytoclose",level:4},{value:"customOverflowMenuButtonPressed",id:"customoverflowmenubuttonpressed",level:4},{value:"Picture-in-Picture",id:"picture-in-picture",level:3},{value:"Dropbox integration",id:"dropbox-integration",level:2},{value:"Screen Sharing integration",id:"screen-sharing-integration",level:2},{value:"Creating the Broadcast Upload Extension",id:"creating-the-broadcast-upload-extension",level:3},{value:"Setting up the socket connection",id:"setting-up-the-socket-connection",level:3},{value:"Opening the socket connection",id:"opening-the-socket-connection",level:3},{value:"Sending video frames",id:"sending-video-frames",level:3},{value:"Handling stop screen sharing",id:"handling-stop-screen-sharing",level:3},{value:"TL;DR",id:"tldr",level:3},{value:"Debugging",id:"debugging",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app,\nin a customizable way which you can embed in your apps."}),"\n",(0,t.jsx)(n.admonition,{type:"important",children:(0,t.jsx)(n.p,{children:"iOS 15.1 or higher is required."})}),"\n",(0,t.jsx)(n.h2,{id:"sample-applications-using-the-sdk",children:"Sample applications using the SDK"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the\n",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-sdk-samples#ios",children:"sample applications repository"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,t.jsx)(n.p,{children:"There are 2 ways to integrate the SDK into your project:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Using CocoaPods"}),"\n",(0,t.jsx)(n.li,{children:"Building it yourself"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"using-cocoapods",children:"Using CocoaPods"}),"\n",(0,t.jsxs)(n.p,{children:["The recommended way for using the SDK is by using CocoaPods. In order to\ndo so, add the ",(0,t.jsx)(n.code,{children:"JitsiMeetSDK"})," dependency to your existing ",(0,t.jsx)(n.code,{children:"Podfile"})," or create\na new one following this example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ruby",children:"platform :ios, '15.1'\n\nworkspace 'JitsiMeetSDKTest.xcworkspace'\n\ntarget 'JitsiMeetSDKTest' do\n project 'JitsiMeetSDKTest.xcodeproj'\n\n pod 'JitsiMeetSDK'\nend\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Replace ",(0,t.jsx)(n.code,{children:"JitsiMeetSDKTest"})," with your project and target names."]}),"\n",(0,t.jsxs)(n.p,{children:["Since the SDK requests camera and microphone access, make sure to include the\nrequired entries for ",(0,t.jsx)(n.code,{children:"NSCameraUsageDescription"})," and ",(0,t.jsx)(n.code,{children:"NSMicrophoneUsageDescription"}),"\nin your ",(0,t.jsx)(n.code,{children:"Info.plist"})," file."]}),"\n",(0,t.jsx)(n.p,{children:'In order for app to properly work in the background, select the "audio" and "voip"\nbackground modes.'}),"\n",(0,t.jsxs)(n.p,{children:["Last, since the SDK shows and hides the status bar based on the conference state,\nyou may want to set ",(0,t.jsx)(n.code,{children:"UIViewControllerBasedStatusBarAppearance"})," to ",(0,t.jsx)(n.code,{children:"NO"})," in your\n",(0,t.jsx)(n.code,{children:"Info.plist"})," file."]}),"\n",(0,t.jsx)(n.h3,{id:"building-it-yourself",children:"Building it yourself"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install all required ",(0,t.jsx)(n.a,{href:"https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet",children:"dependencies"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Build it:"}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"mkdir -p ios/sdk/out\nxcodebuild clean \\\n -workspace ios/jitsi-meet.xcworkspace \\\n -scheme JitsiMeetSDK\nxcodebuild archive \\\n -workspace ios/jitsi-meet.xcworkspace \\\n -scheme JitsiMeetSDK \\\n -configuration Release \\\n -sdk iphonesimulator \\\n -destination='generic/platform=iOS Simulator' \\\n -archivePath ios/sdk/out/ios-simulator \\\n SKIP_INSTALL=NO \\\n BUILD_LIBRARY_FOR_DISTRIBUTION=YES\nxcodebuild archive \\\n -workspace ios/jitsi-meet.xcworkspace \\\n -scheme JitsiMeetSDK \\\n -configuration Release \\\n -sdk iphoneos \\\n -destination='generic/platform=iOS' \\\n -archivePath ios/sdk/out/ios-device \\\n SKIP_INSTALL=NO \\\n BUILD_LIBRARY_FOR_DISTRIBUTION=YES\nxcodebuild -create-xcframework \\\n -framework ios/sdk/out/ios-device.xcarchive/Products/Library/Frameworks/JitsiMeetSDK.framework \\\n -framework ios/sdk/out/ios-simulator.xcarchive/Products/Library/Frameworks/JitsiMeetSDK.framework \\\n -output ios/sdk/out/JitsiMeetSDK.xcframework\n"})}),"\n",(0,t.jsx)(n.p,{children:"After successfully building Jitsi Meet SDK for iOS, the resulting XCFramework will be in the ios/sdk/out directory."}),"\n",(0,t.jsx)(n.p,{children:"NOTE: Your app will need to depend on the JitsiWebRTC CocoaPod."}),"\n",(0,t.jsx)(n.h2,{id:"api",children:"API"}),"\n",(0,t.jsx)(n.p,{children:"JitsiMeet is an iOS framework which embodies the whole Jitsi Meet experience and\nmakes it reusable by third-party apps."}),"\n",(0,t.jsx)(n.p,{children:"To get started:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Add a ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," to your app using a Storyboard or Interface Builder,\nfor example."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Then, once the view has loaded, set the delegate in your controller and load\nthe desired URL:"}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:'- (void)viewDidLoad {\n [super viewDidLoad];\n\n JitsiMeetView *jitsiMeetView = (JitsiMeetView *) self.view;\n jitsiMeetView.delegate = self;\n\n JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) {\n builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"];\n builder.room = @"test123";\n builder.audioOnly = YES;\n }];\n\n [jitsiMeetView join:options];\n}\n'})}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetview-class",children:"JitsiMeetView class"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," class is the entry point to the SDK. It a subclass of\n",(0,t.jsx)(n.code,{children:"UIView"})," which renders a full conference in the designated area."]}),"\n",(0,t.jsx)(n.h4,{id:"delegate",children:"delegate"}),"\n",(0,t.jsxs)(n.p,{children:["Property to get/set the ",(0,t.jsx)(n.code,{children:"JitsiMeetViewDelegate"})," on ",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),"."]}),"\n",(0,t.jsxs)(n.h4,{id:"join",children:["join",":JitsiMeetConferenceOptions"]}),"\n",(0,t.jsx)(n.p,{children:"Joins the conference specified by the given options."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:' JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) {\n builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"];\n builder.room = @"test123";\n builder.audioOnly = NO;\n builder.audioMuted = NO;\n builder.videoMuted = NO;\n builder.welcomePageEnabled = NO;\n [builder setConfigOverride:@"requireDisplayName" withBoolean:YES];\n [builder setConfigOverride:@"customToolbarButtons" withArray:@[\n @{\n @"icon": @"https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png",\n @"id": @"btn1",\n @"text": @"Button one"\n }, \n @{\n @"icon": @"https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png",\n @"id": @"btn2",\n @"text": @"Button two"\n }]];\n }];\n\n [jitsiMeetView join:options];\n'})}),"\n",(0,t.jsx)(n.h4,{id:"leave",children:"leave"}),"\n",(0,t.jsx)(n.p,{children:"Leaves the currently active conference."}),"\n",(0,t.jsx)(n.h4,{id:"hangup",children:"hangUp"}),"\n",(0,t.jsx)(n.p,{children:"The localParticipant leaves the current conference."}),"\n",(0,t.jsx)(n.h4,{id:"setaudiomuted",children:"setAudioMuted"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant audio muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter."]}),"\n",(0,t.jsx)(n.h4,{id:"setvideomuted",children:"setVideoMuted"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant video muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter."]}),"\n",(0,t.jsx)(n.h4,{id:"sendendpointtextmessage",children:"sendEndpointTextMessage"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a message via the data channel to one particular participant or to all of them.\nIf the ",(0,t.jsx)(n.code,{children:"to"})," param is empty, the message will be sent to all the participants in the conference."]}),"\n",(0,t.jsxs)(n.p,{children:["In order to get the participantId, the ",(0,t.jsx)(n.code,{children:"PARTICIPANT_JOINED"})," event should be listened for,\nwhich ",(0,t.jsx)(n.code,{children:"data"})," includes the id and this should be stored somehow."]}),"\n",(0,t.jsx)(n.h4,{id:"togglescreenshare",children:"toggleScreenShare"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant screen sharing according to the ",(0,t.jsx)(n.code,{children:"enabled"})," parameter."]}),"\n",(0,t.jsx)(n.h4,{id:"openchat",children:"openChat"}),"\n",(0,t.jsxs)(n.p,{children:["Opens the chat dialog. If ",(0,t.jsx)(n.code,{children:"to"})," contains a valid participantId, the private chat with that particular participant will be opened."]}),"\n",(0,t.jsx)(n.h4,{id:"sendchatmessage",children:"sendChatMessage"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a chat message via to one particular participant or to all of them.\nIf the ",(0,t.jsx)(n.code,{children:"to"})," param is empty, the message will be sent to all the participants in the conference."]}),"\n",(0,t.jsxs)(n.p,{children:["In order to get the participantId, the ",(0,t.jsx)(n.code,{children:"PARTICIPANT_JOINED"})," event should be listened for,\nwhich ",(0,t.jsx)(n.code,{children:"data"})," includes the id and this should be stored somehow."]}),"\n",(0,t.jsx)(n.h4,{id:"closechat",children:"closeChat"}),"\n",(0,t.jsx)(n.p,{children:"Closes the chat dialog."}),"\n",(0,t.jsx)(n.h4,{id:"retrieveparticipantsinfo",children:"retrieveParticipantsInfo"}),"\n",(0,t.jsx)(n.p,{children:"Retrieves the participants information in the completionHandler sent as parameter."}),"\n",(0,t.jsx)(n.h4,{id:"universal--deep-linking",children:"Universal / deep linking"}),"\n",(0,t.jsxs)(n.p,{children:["In order to support Universal / deep linking, ",(0,t.jsx)(n.code,{children:"JitsiMeet"})," offers 2 class\nmethods that you app's delegate should call in order for the app to follow those\nlinks."]}),"\n",(0,t.jsx)(n.p,{children:"If these functions return NO it means the URL wasn't handled by the SDK. This\nis useful when the host application uses other SDKs which also use linking."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:"- (BOOL)application:(UIApplication *)application\ncontinueUserActivity:(NSUserActivity *)userActivity\n restorationHandler:(void (^)(NSArray *restorableObjects))restorationHandler\n{\n return [[JitsiMeet sharedInstance] application:application\n continueUserActivity:userActivity\n restorationHandler:restorationHandler];\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"And also one of the following:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:"// See https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623073-application?language=objc\n- (BOOL)application:(UIApplication *)app\n openURL:(NSURL *)url\n options:(NSDictionary *)options {\n return [[JitsiMeet sharedInstance] application:app\n openURL:url\n options: options];\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetviewdelegate",children:"JitsiMeetViewDelegate"}),"\n",(0,t.jsxs)(n.p,{children:["This delegate is optional, and can be set on the ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," instance using\nthe ",(0,t.jsx)(n.code,{children:"delegate"})," property."]}),"\n",(0,t.jsx)(n.p,{children:"It provides information about the conference state: was it joined, left, did it\nfail?"}),"\n",(0,t.jsx)(n.p,{children:"All methods in this delegate are optional."}),"\n",(0,t.jsx)(n.h4,{id:"conferencejoined",children:"conferenceJoined"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a conference was joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"conferenceterminated",children:"conferenceTerminated"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the active conference ends, be it because of user choice or because of a failure. ",(0,t.jsx)(n.code,{children:"data"})," contains the\nfollowing information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"error"}),": missing if the conference finished gracefully, otherwise contains the error message"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"conferencewilljoin",children:"conferenceWillJoin"}),"\n",(0,t.jsxs)(n.p,{children:["Called before a conference is joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"enterpictureinpicture",children:"enterPictureInPicture"}),"\n",(0,t.jsxs)(n.p,{children:["Called when entering Picture-in-Picture is requested by the user. The app should\nnow activate its Picture-in-Picture implementation (and resize the associated\n",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),". The latter will automatically detect its new size and adjust\nits user interface to a variant appropriate for the small size ordinarily\nassociated with Picture-in-Picture.)"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"data"})," dictionary is empty."]}),"\n",(0,t.jsx)(n.h4,{id:"participantjoined",children:"participantJoined"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a participant has joined the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"email"}),": the email of the participant. It may not be set if the remote participant didn't set one."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"name"}),": the name of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"role"}),": the role of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"participantleft",children:"participantLeft"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a participant has left the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant that left."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"audiomutedchanged",children:"audioMutedChanged"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the local participant's audio is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": a boolean indicating whether the audio is muted or not."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"videomutedchanged",children:"videoMutedChanged"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the local participant's video is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": an integer indicating whether the video is muted or not. 0 means unmuted, 4 means muted."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"endpointtextmessagereceived",children:"endpointTextMessageReceived"}),"\n",(0,t.jsx)(n.p,{children:"Called when an endpoint text message is received."}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"data"})," dictionary contains a ",(0,t.jsx)(n.code,{children:"senderId"})," key with the participantId of the sender and a ",(0,t.jsx)(n.code,{children:"message"})," key with the\ncontent."]}),"\n",(0,t.jsx)(n.h4,{id:"screensharetoggled",children:"screenShareToggled"}),"\n",(0,t.jsx)(n.p,{children:"Called when a participant starts or stops sharing his screen."}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"data"})," dictionary contains a ",(0,t.jsx)(n.code,{children:"participantId"})," key with the id of the participant and a 'sharing' key with boolean\nvalue."]}),"\n",(0,t.jsx)(n.h4,{id:"chatmessagereceived",children:"chatMessageReceived"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a chat text message is received. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"senderId"}),": the id of the participant that sent the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"message"}),": the content of the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isPrivate"}),": true if the message is private, false otherwise."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"timestamp"}),": the (optional) timestamp of the message."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"chattoggled",children:"chatToggled"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the chat dialog is opened or closed. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isOpen"}),": true if the chat dialog is open, false otherwise."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"readytoclose",children:"readyToClose"}),"\n",(0,t.jsx)(n.p,{children:"Called when the SDK is ready to be closed. No meeting is happening at this point."}),"\n",(0,t.jsx)(n.h4,{id:"customoverflowmenubuttonpressed",children:"customOverflowMenuButtonPressed"}),"\n",(0,t.jsxs)(n.p,{children:["Called when custom buttons are added to the overflow menu. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"id"}),": the id of the pressed custom button."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"text"}),": the label of the pressed custom button."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"picture-in-picture",children:"Picture-in-Picture"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"JitsiMeetView"}),' will automatically adjust its UI when presented in a\nPicture-in-Picture style scenario, in a rectangle too small to accommodate its\n"full" UI.']}),"\n",(0,t.jsxs)(n.p,{children:["Jitsi Meet SDK does not currently implement native Picture-in-Picture on iOS. If\ndesired, apps need to implement non-native Picture-in-Picture themselves and\nresize ",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["If ",(0,t.jsx)(n.code,{children:"delegate"})," implements ",(0,t.jsx)(n.code,{children:"enterPictureInPicture:"}),", the in-call toolbar will\nrender a button to afford the user to request entering Picture-in-Picture."]}),"\n",(0,t.jsx)(n.h2,{id:"dropbox-integration",children:"Dropbox integration"}),"\n",(0,t.jsx)(n.p,{children:"To setup the Dropbox integration, follow these steps:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Add the following to the app's Info.plist and change ",(0,t.jsx)(n.code,{children:""})," to your\nDropbox app key:"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"CFBundleURLTypes\n\n \n CFBundleURLName\n \n CFBundleURLSchemes\n \n db-\n \n \n\nLSApplicationQueriesSchemes\n\n dbapi-2\n dbapi-8-emm\n\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsx)(n.li,{children:"Make sure your app calls the Jitsi Meet SDK universal / deep linking delegate methods."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"screen-sharing-integration",children:"Screen Sharing integration"}),"\n",(0,t.jsx)(n.p,{children:"The screen sharing functionality for iOS was added to Jitsi starting with JitsiMeetSDK version 3.3.0. It is available for applications running on iOS 14 or newer."}),"\n",(0,t.jsxs)(n.p,{children:["For achieving this we are using the ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"})," for capturing the contents of the user's screen. Passing the frames to the RN WebRTC is done using Unix stream-oriented sockets communication, the extension acting as the client and the React Native WebRTC being the server."]}),"\n",(0,t.jsxs)(n.p,{children:["The following documentation covers the code provided in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-sdk-samples/tree/master/ios/swift-screensharing/JitsiSDKScreenSharingTest",children:"sample app"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"creating-the-broadcast-upload-extension",children:"Creating the Broadcast Upload Extension"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"})," is one of the App Extensions types defined in iOS and is used for capturing the contents of the user's screen."]}),"\n",(0,t.jsxs)(n.p,{children:["For creating the extension you need to add a new target to your application, selecting the ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"})," template. Fill in the desired name, change the language to Swift, make sure ",(0,t.jsx)(n.code,{children:"Include UI Extension"})," is not selected, as we don't need custom UI for our case, then press Finish (screenshot 1). You will see that a new folder with the extension's name was added to the project's tree, containing the ",(0,t.jsx)(n.code,{children:"SampleHandler.swift"})," class. Also, make sure to update the ",(0,t.jsx)(n.code,{children:"Deployment Info"}),", for the newly created extension, to iOS 14 or newer. To learn more about creating App Extensions check the ",(0,t.jsx)(n.a,{href:"https://developer.apple.com/library/archive/documentation/General/Conceptual/ExtensibilityPG/ExtensionCreation.html",children:"official documentation"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{alt:"screenshot 1",src:i(4994).A+"",title:"screenshot 1",width:"594",height:"402"})}),"\n",(0,t.jsxs)(n.p,{children:["With the extension created the next steps are to set up the socket connection, add the functionality for handling the received frames, and send them to RN WebRTC for processing. We will be using the code provided with the sample project for this. Copy ",(0,t.jsx)(n.code,{children:"SampleUploader.swift"}),", ",(0,t.jsx)(n.code,{children:"SocketConnection.swift"}),", ",(0,t.jsx)(n.code,{children:"DarwinNotificationCenter.swift"}),", and ",(0,t.jsx)(n.code,{children:"Atomic.swift"})," files to your extension's folder and make sure they're added to the target."]}),"\n",(0,t.jsx)(n.h3,{id:"setting-up-the-socket-connection",children:"Setting up the socket connection"}),"\n",(0,t.jsx)(n.p,{children:"Sending the recorded frames to RN WebRTC is done via Unix SOCK_STREAM sockets. The extension needs to be set up as the client endpoint for this."}),"\n",(0,t.jsxs)(n.p,{children:["We will update ",(0,t.jsx)(n.code,{children:"SampleHandler.swift"})," to initiate the socket connection with RN WebRTC, using the ",(0,t.jsx)(n.code,{children:"SocketConnection"})," class. But before, we have to set up the file that the sockets will use for communication."]}),"\n",(0,t.jsxs)(n.p,{children:["Even though an app extension bundle is nested within its containing app\u2019s bundle, the running app extension and containing app have no direct access to each other\u2019s containers. We will address this by enabling data sharing. To enable data sharing, use Xcode or the Developer portal to enable app groups for the containing app and its contained app extensions. Next, register the app group in the portal and specify the app group to use in the containing app. To learn about working with app groups, see ",(0,t.jsx)(n.a,{href:"https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/EntitlementKeyReference/Chapters/EnablingAppSandbox.html#//apple_ref/doc/uid/TP40011195-CH4-SW19",children:"Adding an App to an App Group"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Now, add a ",(0,t.jsx)(n.code,{children:"private var socketFilePath: String"})," to your ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class and set it up with a shared file named ",(0,t.jsx)(n.code,{children:"rtc_SSFD"}),", using the newly registered app group, like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'private enum Constants {\n static let appGroupIdentifier = "my.custom.app.group"\n}\n\nprivate var socketFilePath: String {\n let sharedContainer = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: Constants.appGroupIdentifier)\n \n return sharedContainer?.appendingPathComponent("rtc_SSFD").path ?? ""\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Next, we will configure the ",(0,t.jsx)(n.code,{children:"SocketConnection"})," to use the shared file. Add a ",(0,t.jsx)(n.code,{children:"private var clientConnection: SocketConnection?"})," to the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class and override ",(0,t.jsx)(n.code,{children:"init"})," to set it up, like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override init() {\n super.init()\n if let connection = SocketConnection(filePath: socketFilePath) {\n clientConnection = connection\n }\n} \n"})}),"\n",(0,t.jsxs)(n.p,{children:["In order for this to work, the RN WebRTC end needs to know about the app group identifier we have configured the app with. We are doing this by adding a new key named ",(0,t.jsx)(n.code,{children:"RTCAppGroupIdentifier"})," to the app's ",(0,t.jsx)(n.code,{children:"Info.plist"})," with the app group identifier as the value."]}),"\n",(0,t.jsx)(n.h3,{id:"opening-the-socket-connection",children:"Opening the socket connection"}),"\n",(0,t.jsxs)(n.p,{children:["For starting screen sharing JitsiMeet SDK provides the UI to present the ",(0,t.jsx)(n.code,{children:"RPSystemBroadcastPickerView"})," to the user. By default, the picker will display a list of all the available broadcast providers. In order to limit the picker to our particular broadcast provider, we have to set ",(0,t.jsx)(n.code,{children:"preferredExtension"})," to the bundle identifier of the broadcast extension. We are doing this by adding a new key named ",(0,t.jsx)(n.code,{children:"RTCScreenSharingExtension"})," to the app's Info.plist and setting the broadcast extension bundle identifier as the value."]}),"\n",(0,t.jsxs)(n.p,{children:["Once screen recording has started ReplayKit invokes the methods to handle video buffers, as well as the methods to handle starting and stopping the broadcast, from the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class. The ",(0,t.jsx)(n.code,{children:"broadcastStarted(withSetupInfo:)"})," method is our entry point for opening the socket connection with the RN WebRTC server. To do this we have to post the ",(0,t.jsx)(n.code,{children:"broadcastStarted"})," notification the server is listening for, in order to start the connection, and we are ready to connect. Add a new method ",(0,t.jsx)(n.code,{children:"openConnection()"})," to the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class which will repeatedly attempt connecting to the server, for cases when the server connection start is delayed:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'func openConnection() {\n let queue = DispatchQueue(label: "broadcast.connectTimer")\n let timer = DispatchSource.makeTimerSource(queue: queue)\n timer.schedule(deadline: .now(), repeating: .milliseconds(100), leeway: .milliseconds(500))\n timer.setEventHandler { [weak self] in\n guard self?.clientConnection?.open() == true else {\n return\n }\n \n timer.cancel()\n }\n \n timer.resume()\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Next, update the ",(0,t.jsx)(n.code,{children:"broadcastStarted(withSetupInfo:)"})," method to post the notification and connect:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?) {\n DarwinNotificationCenter.shared.postNotification(.broadcastStarted)\n openConnection()\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"DarwinNotificationCenter"})," is a simple helper class for broadcasting system-wide notifications, instead of delivering only within a single program, as ",(0,t.jsx)(n.code,{children:"NSNotificationCenter"})," does. This mechanism allows the app to register for notifications sent from the extension."]}),"\n",(0,t.jsx)(n.p,{children:"Now we are ready to start sending video frames."}),"\n",(0,t.jsx)(n.h3,{id:"sending-video-frames",children:"Sending video frames"}),"\n",(0,t.jsxs)(n.p,{children:["RN WebRTC is designed to work with jpeg encoded images framed in a ",(0,t.jsx)(n.code,{children:"CFHTTPMessage"})," object. The following header fields are required:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Content-Length"})," - the size of the jpeg data"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Buffer-Width"})," - the width of the buffer, in pixels"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Buffer-Height"})," - the buffer height, in pixels"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Buffer-Orientation"})," - the value for the ",(0,t.jsx)(n.code,{children:"RPVideoSampleOrientationKey"})," that describes the video orientation."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["We are going to prepare and send our video frames using the ",(0,t.jsx)(n.code,{children:"SampleUploader"})," class. Add a new ",(0,t.jsx)(n.code,{children:"private var uploader: SampleUploader?"})," to the SampleHandler class and update ",(0,t.jsx)(n.code,{children:"init()"})," to initialize it:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override init() {\n super.init()\n if let connection = SocketConnection(filePath: socketFilePath) {\n clientConnection = connection\n uploader = SampleUploader(connection: connection)\n }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Next, we are going to update the ",(0,t.jsx)(n.code,{children:"processSampleBuffer(_ sampleBuffer: CMSampleBuffer, with sampleBufferType: RPSampleBufferType)"})," method to send our video frames. For performance reasons, we'll also implement a very simple mechanism for adjusting the frame rate by using every third frame. Add a new ",(0,t.jsx)(n.code,{children:"private var frameCount = 0"})," and update the above-mentioned method like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func processSampleBuffer(_ sampleBuffer: CMSampleBuffer, with sampleBufferType: RPSampleBufferType) {\n switch sampleBufferType {\n case .video:\n // very simple mechanism for adjusting frame rate by using every third frame\n frameCount += 1\n if frameCount % 3 == 0 {\n uploader?.send(sample: sampleBuffer)\n }\n default:\n break\n }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Also, update ",(0,t.jsx)(n.code,{children:"broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?)"})," to reset the ",(0,t.jsx)(n.code,{children:"frameCount"})," every time screen sharing is started:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?) {\n frameCount = 0\n \n DarwinNotificationCenter.shared.postNotification(.broadcastStarted)\n openConnection()\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"With this, we've concluded sending the video frames and we can move to the last step, handling stop screen sharing."}),"\n",(0,t.jsx)(n.h3,{id:"handling-stop-screen-sharing",children:"Handling stop screen sharing"}),"\n",(0,t.jsx)(n.p,{children:"Besides the in-meeting UI (screenshot 2), ReplayKit integration with iOS provides support for stopping screen recording outside of the app's control, from the status bar (screenshot 3) or using the Control Center (screenshot 4)."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.img,{alt:"ios-screensharing",src:i(3177).A+"",title:"screenshot 2",width:"226",height:"487"})," ",(0,t.jsx)(n.img,{alt:"ios-screensharing",src:i(6272).A+"",title:"screenshot 3",width:"226",height:"487"})," ",(0,t.jsx)(n.img,{alt:"ios-screensharing",src:i(9119).A+"",title:"screenshot 4",width:"226",height:"487"})]}),"\n",(0,t.jsxs)(n.p,{children:["Any of these actions will trigger ",(0,t.jsx)(n.code,{children:"broadcastFinished"})," in our ",(0,t.jsx)(n.code,{children:"SampleHandler"})," implementation. This is our entry point for closing the connection and cleaning up. We will update ",(0,t.jsx)(n.code,{children:"broadcastFinished"})," to post a ",(0,t.jsx)(n.code,{children:"DarwinNotification.broadcastStopped"})," system-wide notification and close the connection:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func broadcastFinished() {\n DarwinNotificationCenter.shared.postNotification(.broadcastStopped)\n clientConnection?.close()\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Another scenario we need to take care of is when the server connection is dropped, like when leaving a meeting while screen sharing or an error is encountered. We will address this by handling ",(0,t.jsx)(n.code,{children:"clientConnection.didClose"})," event. Add a new method ",(0,t.jsx)(n.code,{children:"setupConnection"})," to the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class and update ",(0,t.jsx)(n.code,{children:"init"})," to call it:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'func setupConnection() {\n clientConnection?.didClose = { [weak self] error in \n if let error = error {\n self?.finishBroadcastWithError(error)\n } else {\n // the displayed failure message is more user friendly when using NSError instead of Error\n let JMScreenSharingStopped = 10001\n let customError = NSError(domain: RPRecordingErrorDomain, code: JMScreenSharingStopped, userInfo: [NSLocalizedDescriptionKey: "Screen sharing stopped"])\n self?.finishBroadcastWithError(customError)\n }\n }\n}\n\noverride init() {\n super.init()\n if let connection = SocketConnection(filePath: socketFilePath) {\n clientConnection = connection\n setupConnection()\n \n uploader = SampleUploader(connection: connection)\n }\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Now, that we are done writing the implementation, we just need to enable the functionality in Jitsi. We are doing this by configuring ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptionsBuilder"})," with the ",(0,t.jsx)(n.code,{children:"ios.screensharing.enabled feature"})," flag, like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'let options = JitsiMeetConferenceOptions.fromBuilder { [weak self] builder in\n ...\n builder.setFeatureFlag("ios.screensharing.enabled", withBoolean: true)\n}\nmeetView.join(options)\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Finally, we are ready to test the implementation. Before doing so, make sure voip is added to ",(0,t.jsx)(n.code,{children:"UIBackgroundModes"}),", in the app's ",(0,t.jsx)(n.code,{children:"Info.playlist"}),", in order to work when the app is in the background."]}),"\n",(0,t.jsx)(n.h3,{id:"tldr",children:"TL;DR"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Add a ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"}),", without UI, to your app. Update deployment info to run in iOS 14 or newer."]}),"\n",(0,t.jsxs)(n.li,{children:["Copy ",(0,t.jsx)(n.code,{children:"SampleUploader.swift"}),", ",(0,t.jsx)(n.code,{children:"SocketConnection.swift"}),", ",(0,t.jsx)(n.code,{children:"DarwinNotificationCenter.swift"})," and ",(0,t.jsx)(n.code,{children:"Atomic.swift"})," files from the sample project to your extension. Make sure they are added to the extension's target."]}),"\n",(0,t.jsxs)(n.li,{children:["Add both the app and the extension to the same App Group. Next, add the app group id value to the app's ",(0,t.jsx)(n.code,{children:"Info.plist"})," for the ",(0,t.jsx)(n.code,{children:"RTCAppGroupIdentifier"})," key."]}),"\n",(0,t.jsxs)(n.li,{children:["Add a new key ",(0,t.jsx)(n.code,{children:"RTCScreenSharingExtension"})," to the app's ",(0,t.jsx)(n.code,{children:"Info.plist"})," with the extension's ",(0,t.jsx)(n.code,{children:"Bundle Identifier"})," as the value."]}),"\n",(0,t.jsxs)(n.li,{children:["Update ",(0,t.jsx)(n.code,{children:"SampleHandler.swift"})," with the code from the sample project. Update ",(0,t.jsx)(n.code,{children:"appGroupIdentifier"})," constant with the App Group name your app and extension are both registered to."]}),"\n",(0,t.jsxs)(n.li,{children:["Update ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptions"})," to enable screen sharing using the ",(0,t.jsx)(n.code,{children:"ios.screensharing.enabled"})," feature flag."]}),"\n",(0,t.jsxs)(n.li,{children:["Make sure ",(0,t.jsx)(n.code,{children:"voip"})," is added to ",(0,t.jsx)(n.code,{children:"UIBackgroundModes"}),", in the app's ",(0,t.jsx)(n.code,{children:"Info.plist"}),", in order to work when the app is in the background."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"debugging",children:"Debugging"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["If you choose ",(0,t.jsx)(n.code,{children:"Console"})," app for debugging, please be sure that you select:\n",(0,t.jsx)(n.code,{children:"Action"}),"(tab) -> ",(0,t.jsx)(n.code,{children:"Include Info Messages"}),"\n",(0,t.jsx)(n.code,{children:"Action"}),"(tab) -> ",(0,t.jsx)(n.code,{children:"Include Debug Messages"})]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["In the Search filter please type ",(0,t.jsx)(n.code,{children:"JitsiMeetSDK"}),", press Return key and replace ",(0,t.jsx)(n.code,{children:"ANY"})," with ",(0,t.jsx)(n.code,{children:"Category"}),".\nThis will show you all the real time logs related to our SDK."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},4994:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_1-9fc051cab7c6c45813ac86a09d9be7f8.png"},3177:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_2-e4305e7a7935b01689f316310cae41e9.png"},6272:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_3-83343a2407deba42d29b363470fa4680.png"},9119:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_4-985c0a05d859624dab3201410a425ca1.png"},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var t=i(6540);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7637],{7184:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var t=i(4848),s=i(8453);const o={id:"dev-guide-ios-sdk",title:"iOS SDK"},r=void 0,d={id:"dev-guide/dev-guide-ios-sdk",title:"iOS SDK",description:"The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app,",source:"@site/docs/dev-guide/ios-sdk.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-ios-sdk",permalink:"/handbook/docs/dev-guide/dev-guide-ios-sdk",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/ios-sdk.md",tags:[],version:"current",lastUpdatedAt:1734882343e3,frontMatter:{id:"dev-guide-ios-sdk",title:"iOS SDK"},sidebar:"docs",previous:{title:"Android SDK",permalink:"/handbook/docs/dev-guide/dev-guide-android-sdk"},next:{title:"React Native SDK",permalink:"/handbook/docs/dev-guide/dev-guide-react-native-sdk"}},a={},c=[{value:"Sample applications using the SDK",id:"sample-applications-using-the-sdk",level:2},{value:"Usage",id:"usage",level:2},{value:"Using CocoaPods",id:"using-cocoapods",level:3},{value:"Building it yourself",id:"building-it-yourself",level:3},{value:"API",id:"api",level:2},{value:"JitsiMeetView class",id:"jitsimeetview-class",level:3},{value:"delegate",id:"delegate",level:4},{value:"join",id:"join",level:4},{value:"leave",id:"leave",level:4},{value:"hangUp",id:"hangup",level:4},{value:"setAudioMuted",id:"setaudiomuted",level:4},{value:"setVideoMuted",id:"setvideomuted",level:4},{value:"sendEndpointTextMessage",id:"sendendpointtextmessage",level:4},{value:"toggleScreenShare",id:"togglescreenshare",level:4},{value:"openChat",id:"openchat",level:4},{value:"sendChatMessage",id:"sendchatmessage",level:4},{value:"closeChat",id:"closechat",level:4},{value:"retrieveParticipantsInfo",id:"retrieveparticipantsinfo",level:4},{value:"Universal / deep linking",id:"universal--deep-linking",level:4},{value:"JitsiMeetViewDelegate",id:"jitsimeetviewdelegate",level:3},{value:"conferenceJoined",id:"conferencejoined",level:4},{value:"conferenceTerminated",id:"conferenceterminated",level:4},{value:"conferenceWillJoin",id:"conferencewilljoin",level:4},{value:"enterPictureInPicture",id:"enterpictureinpicture",level:4},{value:"participantJoined",id:"participantjoined",level:4},{value:"participantLeft",id:"participantleft",level:4},{value:"audioMutedChanged",id:"audiomutedchanged",level:4},{value:"videoMutedChanged",id:"videomutedchanged",level:4},{value:"endpointTextMessageReceived",id:"endpointtextmessagereceived",level:4},{value:"screenShareToggled",id:"screensharetoggled",level:4},{value:"chatMessageReceived",id:"chatmessagereceived",level:4},{value:"chatToggled",id:"chattoggled",level:4},{value:"readyToClose",id:"readytoclose",level:4},{value:"customOverflowMenuButtonPressed",id:"customoverflowmenubuttonpressed",level:4},{value:"Picture-in-Picture",id:"picture-in-picture",level:3},{value:"Dropbox integration",id:"dropbox-integration",level:2},{value:"Screen Sharing integration",id:"screen-sharing-integration",level:2},{value:"Creating the Broadcast Upload Extension",id:"creating-the-broadcast-upload-extension",level:3},{value:"Setting up the socket connection",id:"setting-up-the-socket-connection",level:3},{value:"Opening the socket connection",id:"opening-the-socket-connection",level:3},{value:"Sending video frames",id:"sending-video-frames",level:3},{value:"Handling stop screen sharing",id:"handling-stop-screen-sharing",level:3},{value:"TL;DR",id:"tldr",level:3},{value:"Debugging",id:"debugging",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app,\nin a customizable way which you can embed in your apps."}),"\n",(0,t.jsx)(n.admonition,{type:"important",children:(0,t.jsx)(n.p,{children:"iOS 15.1 or higher is required."})}),"\n",(0,t.jsx)(n.h2,{id:"sample-applications-using-the-sdk",children:"Sample applications using the SDK"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the\n",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-sdk-samples#ios",children:"sample applications repository"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,t.jsx)(n.p,{children:"There are 2 ways to integrate the SDK into your project:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Using CocoaPods"}),"\n",(0,t.jsx)(n.li,{children:"Building it yourself"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"using-cocoapods",children:"Using CocoaPods"}),"\n",(0,t.jsxs)(n.p,{children:["The recommended way for using the SDK is by using CocoaPods. In order to\ndo so, add the ",(0,t.jsx)(n.code,{children:"JitsiMeetSDK"})," dependency to your existing ",(0,t.jsx)(n.code,{children:"Podfile"})," or create\na new one following this example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ruby",children:"platform :ios, '15.1'\n\nworkspace 'JitsiMeetSDKTest.xcworkspace'\n\ntarget 'JitsiMeetSDKTest' do\n project 'JitsiMeetSDKTest.xcodeproj'\n\n pod 'JitsiMeetSDK'\nend\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Replace ",(0,t.jsx)(n.code,{children:"JitsiMeetSDKTest"})," with your project and target names."]}),"\n",(0,t.jsxs)(n.p,{children:["Since the SDK requests camera and microphone access, make sure to include the\nrequired entries for ",(0,t.jsx)(n.code,{children:"NSCameraUsageDescription"})," and ",(0,t.jsx)(n.code,{children:"NSMicrophoneUsageDescription"}),"\nin your ",(0,t.jsx)(n.code,{children:"Info.plist"})," file."]}),"\n",(0,t.jsx)(n.p,{children:'In order for app to properly work in the background, select the "audio" and "voip"\nbackground modes.'}),"\n",(0,t.jsxs)(n.p,{children:["Last, since the SDK shows and hides the status bar based on the conference state,\nyou may want to set ",(0,t.jsx)(n.code,{children:"UIViewControllerBasedStatusBarAppearance"})," to ",(0,t.jsx)(n.code,{children:"NO"})," in your\n",(0,t.jsx)(n.code,{children:"Info.plist"})," file."]}),"\n",(0,t.jsx)(n.h3,{id:"building-it-yourself",children:"Building it yourself"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install all required ",(0,t.jsx)(n.a,{href:"https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet",children:"dependencies"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Build it:"}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"mkdir -p ios/sdk/out\nxcodebuild clean \\\n -workspace ios/jitsi-meet.xcworkspace \\\n -scheme JitsiMeetSDK\nxcodebuild archive \\\n -workspace ios/jitsi-meet.xcworkspace \\\n -scheme JitsiMeetSDK \\\n -configuration Release \\\n -sdk iphonesimulator \\\n -destination='generic/platform=iOS Simulator' \\\n -archivePath ios/sdk/out/ios-simulator \\\n SKIP_INSTALL=NO \\\n BUILD_LIBRARY_FOR_DISTRIBUTION=YES\nxcodebuild archive \\\n -workspace ios/jitsi-meet.xcworkspace \\\n -scheme JitsiMeetSDK \\\n -configuration Release \\\n -sdk iphoneos \\\n -destination='generic/platform=iOS' \\\n -archivePath ios/sdk/out/ios-device \\\n SKIP_INSTALL=NO \\\n BUILD_LIBRARY_FOR_DISTRIBUTION=YES\nxcodebuild -create-xcframework \\\n -framework ios/sdk/out/ios-device.xcarchive/Products/Library/Frameworks/JitsiMeetSDK.framework \\\n -framework ios/sdk/out/ios-simulator.xcarchive/Products/Library/Frameworks/JitsiMeetSDK.framework \\\n -output ios/sdk/out/JitsiMeetSDK.xcframework\n"})}),"\n",(0,t.jsx)(n.p,{children:"After successfully building Jitsi Meet SDK for iOS, the resulting XCFramework will be in the ios/sdk/out directory."}),"\n",(0,t.jsx)(n.p,{children:"NOTE: Your app will need to depend on the JitsiWebRTC CocoaPod."}),"\n",(0,t.jsx)(n.h2,{id:"api",children:"API"}),"\n",(0,t.jsx)(n.p,{children:"JitsiMeet is an iOS framework which embodies the whole Jitsi Meet experience and\nmakes it reusable by third-party apps."}),"\n",(0,t.jsx)(n.p,{children:"To get started:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Add a ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," to your app using a Storyboard or Interface Builder,\nfor example."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Then, once the view has loaded, set the delegate in your controller and load\nthe desired URL:"}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:'- (void)viewDidLoad {\n [super viewDidLoad];\n\n JitsiMeetView *jitsiMeetView = (JitsiMeetView *) self.view;\n jitsiMeetView.delegate = self;\n\n JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) {\n builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"];\n builder.room = @"test123";\n builder.audioOnly = YES;\n }];\n\n [jitsiMeetView join:options];\n}\n'})}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetview-class",children:"JitsiMeetView class"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," class is the entry point to the SDK. It a subclass of\n",(0,t.jsx)(n.code,{children:"UIView"})," which renders a full conference in the designated area."]}),"\n",(0,t.jsx)(n.h4,{id:"delegate",children:"delegate"}),"\n",(0,t.jsxs)(n.p,{children:["Property to get/set the ",(0,t.jsx)(n.code,{children:"JitsiMeetViewDelegate"})," on ",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),"."]}),"\n",(0,t.jsxs)(n.h4,{id:"join",children:["join",":JitsiMeetConferenceOptions"]}),"\n",(0,t.jsx)(n.p,{children:"Joins the conference specified by the given options."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:' JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) {\n builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"];\n builder.room = @"test123";\n builder.audioOnly = NO;\n builder.audioMuted = NO;\n builder.videoMuted = NO;\n builder.welcomePageEnabled = NO;\n [builder setConfigOverride:@"requireDisplayName" withBoolean:YES];\n [builder setConfigOverride:@"customToolbarButtons" withArray:@[\n @{\n @"icon": @"https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png",\n @"id": @"btn1",\n @"text": @"Button one"\n }, \n @{\n @"icon": @"https://w7.pngwing.com/pngs/987/537/png-transparent-download-downloading-save-basic-user-interface-icon-thumbnail.png",\n @"id": @"btn2",\n @"text": @"Button two"\n }]];\n }];\n\n [jitsiMeetView join:options];\n'})}),"\n",(0,t.jsx)(n.h4,{id:"leave",children:"leave"}),"\n",(0,t.jsx)(n.p,{children:"Leaves the currently active conference."}),"\n",(0,t.jsx)(n.h4,{id:"hangup",children:"hangUp"}),"\n",(0,t.jsx)(n.p,{children:"The localParticipant leaves the current conference."}),"\n",(0,t.jsx)(n.h4,{id:"setaudiomuted",children:"setAudioMuted"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant audio muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter."]}),"\n",(0,t.jsx)(n.h4,{id:"setvideomuted",children:"setVideoMuted"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant video muted according to the ",(0,t.jsx)(n.code,{children:"muted"})," parameter."]}),"\n",(0,t.jsx)(n.h4,{id:"sendendpointtextmessage",children:"sendEndpointTextMessage"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a message via the data channel to one particular participant or to all of them.\nIf the ",(0,t.jsx)(n.code,{children:"to"})," param is empty, the message will be sent to all the participants in the conference."]}),"\n",(0,t.jsxs)(n.p,{children:["In order to get the participantId, the ",(0,t.jsx)(n.code,{children:"PARTICIPANT_JOINED"})," event should be listened for,\nwhich ",(0,t.jsx)(n.code,{children:"data"})," includes the id and this should be stored somehow."]}),"\n",(0,t.jsx)(n.h4,{id:"togglescreenshare",children:"toggleScreenShare"}),"\n",(0,t.jsxs)(n.p,{children:["Sets the state of the localParticipant screen sharing according to the ",(0,t.jsx)(n.code,{children:"enabled"})," parameter."]}),"\n",(0,t.jsx)(n.h4,{id:"openchat",children:"openChat"}),"\n",(0,t.jsxs)(n.p,{children:["Opens the chat dialog. If ",(0,t.jsx)(n.code,{children:"to"})," contains a valid participantId, the private chat with that particular participant will be opened."]}),"\n",(0,t.jsx)(n.h4,{id:"sendchatmessage",children:"sendChatMessage"}),"\n",(0,t.jsxs)(n.p,{children:["Sends a chat message via to one particular participant or to all of them.\nIf the ",(0,t.jsx)(n.code,{children:"to"})," param is empty, the message will be sent to all the participants in the conference."]}),"\n",(0,t.jsxs)(n.p,{children:["In order to get the participantId, the ",(0,t.jsx)(n.code,{children:"PARTICIPANT_JOINED"})," event should be listened for,\nwhich ",(0,t.jsx)(n.code,{children:"data"})," includes the id and this should be stored somehow."]}),"\n",(0,t.jsx)(n.h4,{id:"closechat",children:"closeChat"}),"\n",(0,t.jsx)(n.p,{children:"Closes the chat dialog."}),"\n",(0,t.jsx)(n.h4,{id:"retrieveparticipantsinfo",children:"retrieveParticipantsInfo"}),"\n",(0,t.jsx)(n.p,{children:"Retrieves the participants information in the completionHandler sent as parameter."}),"\n",(0,t.jsx)(n.h4,{id:"universal--deep-linking",children:"Universal / deep linking"}),"\n",(0,t.jsxs)(n.p,{children:["In order to support Universal / deep linking, ",(0,t.jsx)(n.code,{children:"JitsiMeet"})," offers 2 class\nmethods that you app's delegate should call in order for the app to follow those\nlinks."]}),"\n",(0,t.jsx)(n.p,{children:"If these functions return NO it means the URL wasn't handled by the SDK. This\nis useful when the host application uses other SDKs which also use linking."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:"- (BOOL)application:(UIApplication *)application\ncontinueUserActivity:(NSUserActivity *)userActivity\n restorationHandler:(void (^)(NSArray *restorableObjects))restorationHandler\n{\n return [[JitsiMeet sharedInstance] application:application\n continueUserActivity:userActivity\n restorationHandler:restorationHandler];\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"And also one of the following:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-objc",children:"// See https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623073-application?language=objc\n- (BOOL)application:(UIApplication *)app\n openURL:(NSURL *)url\n options:(NSDictionary *)options {\n return [[JitsiMeet sharedInstance] application:app\n openURL:url\n options: options];\n}\n"})}),"\n",(0,t.jsx)(n.h3,{id:"jitsimeetviewdelegate",children:"JitsiMeetViewDelegate"}),"\n",(0,t.jsxs)(n.p,{children:["This delegate is optional, and can be set on the ",(0,t.jsx)(n.code,{children:"JitsiMeetView"})," instance using\nthe ",(0,t.jsx)(n.code,{children:"delegate"})," property."]}),"\n",(0,t.jsx)(n.p,{children:"It provides information about the conference state: was it joined, left, did it\nfail?"}),"\n",(0,t.jsx)(n.p,{children:"All methods in this delegate are optional."}),"\n",(0,t.jsx)(n.h4,{id:"conferencejoined",children:"conferenceJoined"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a conference was joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"conferenceterminated",children:"conferenceTerminated"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the active conference ends, be it because of user choice or because of a failure. ",(0,t.jsx)(n.code,{children:"data"})," contains the\nfollowing information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"error"}),": missing if the conference finished gracefully, otherwise contains the error message"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"conferencewilljoin",children:"conferenceWillJoin"}),"\n",(0,t.jsxs)(n.p,{children:["Called before a conference is joined. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"url"}),": the conference URL"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"enterpictureinpicture",children:"enterPictureInPicture"}),"\n",(0,t.jsxs)(n.p,{children:["Called when entering Picture-in-Picture is requested by the user. The app should\nnow activate its Picture-in-Picture implementation (and resize the associated\n",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),". The latter will automatically detect its new size and adjust\nits user interface to a variant appropriate for the small size ordinarily\nassociated with Picture-in-Picture.)"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"data"})," dictionary is empty."]}),"\n",(0,t.jsx)(n.h4,{id:"participantjoined",children:"participantJoined"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a participant has joined the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"email"}),": the email of the participant. It may not be set if the remote participant didn't set one."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"name"}),": the name of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"role"}),": the role of the participant."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"participantleft",children:"participantLeft"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a participant has left the conference. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"participantId"}),": the id of the participant that left."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"audiomutedchanged",children:"audioMutedChanged"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the local participant's audio is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": a boolean indicating whether the audio is muted or not."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"videomutedchanged",children:"videoMutedChanged"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the local participant's video is muted or unmuted. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"muted"}),": an integer indicating whether the video is muted or not. 0 means unmuted, 4 means muted."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"endpointtextmessagereceived",children:"endpointTextMessageReceived"}),"\n",(0,t.jsx)(n.p,{children:"Called when an endpoint text message is received."}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"data"})," dictionary contains a ",(0,t.jsx)(n.code,{children:"senderId"})," key with the participantId of the sender and a ",(0,t.jsx)(n.code,{children:"message"})," key with the\ncontent."]}),"\n",(0,t.jsx)(n.h4,{id:"screensharetoggled",children:"screenShareToggled"}),"\n",(0,t.jsx)(n.p,{children:"Called when a participant starts or stops sharing his screen."}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"data"})," dictionary contains a ",(0,t.jsx)(n.code,{children:"participantId"})," key with the id of the participant and a 'sharing' key with boolean\nvalue."]}),"\n",(0,t.jsx)(n.h4,{id:"chatmessagereceived",children:"chatMessageReceived"}),"\n",(0,t.jsxs)(n.p,{children:["Called when a chat text message is received. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"senderId"}),": the id of the participant that sent the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"message"}),": the content of the message."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isPrivate"}),": true if the message is private, false otherwise."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"timestamp"}),": the (optional) timestamp of the message."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"chattoggled",children:"chatToggled"}),"\n",(0,t.jsxs)(n.p,{children:["Called when the chat dialog is opened or closed. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"isOpen"}),": true if the chat dialog is open, false otherwise."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"readytoclose",children:"readyToClose"}),"\n",(0,t.jsx)(n.p,{children:"Called when the SDK is ready to be closed. No meeting is happening at this point."}),"\n",(0,t.jsx)(n.h4,{id:"customoverflowmenubuttonpressed",children:"customOverflowMenuButtonPressed"}),"\n",(0,t.jsxs)(n.p,{children:["Called when custom buttons are added to the overflow menu. ",(0,t.jsx)(n.code,{children:"data"})," contains the following information:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"id"}),": the id of the pressed custom button."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"text"}),": the label of the pressed custom button."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"picture-in-picture",children:"Picture-in-Picture"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"JitsiMeetView"}),' will automatically adjust its UI when presented in a\nPicture-in-Picture style scenario, in a rectangle too small to accommodate its\n"full" UI.']}),"\n",(0,t.jsxs)(n.p,{children:["Jitsi Meet SDK does not currently implement native Picture-in-Picture on iOS. If\ndesired, apps need to implement non-native Picture-in-Picture themselves and\nresize ",(0,t.jsx)(n.code,{children:"JitsiMeetView"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["If ",(0,t.jsx)(n.code,{children:"delegate"})," implements ",(0,t.jsx)(n.code,{children:"enterPictureInPicture:"}),", the in-call toolbar will\nrender a button to afford the user to request entering Picture-in-Picture."]}),"\n",(0,t.jsx)(n.h2,{id:"dropbox-integration",children:"Dropbox integration"}),"\n",(0,t.jsx)(n.p,{children:"To setup the Dropbox integration, follow these steps:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Add the following to the app's Info.plist and change ",(0,t.jsx)(n.code,{children:""})," to your\nDropbox app key:"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"CFBundleURLTypes\n\n \n CFBundleURLName\n \n CFBundleURLSchemes\n \n db-\n \n \n\nLSApplicationQueriesSchemes\n\n dbapi-2\n dbapi-8-emm\n\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsx)(n.li,{children:"Make sure your app calls the Jitsi Meet SDK universal / deep linking delegate methods."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"screen-sharing-integration",children:"Screen Sharing integration"}),"\n",(0,t.jsx)(n.p,{children:"The screen sharing functionality for iOS was added to Jitsi starting with JitsiMeetSDK version 3.3.0. It is available for applications running on iOS 14 or newer."}),"\n",(0,t.jsxs)(n.p,{children:["For achieving this we are using the ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"})," for capturing the contents of the user's screen. Passing the frames to the RN WebRTC is done using Unix stream-oriented sockets communication, the extension acting as the client and the React Native WebRTC being the server."]}),"\n",(0,t.jsxs)(n.p,{children:["The following documentation covers the code provided in the ",(0,t.jsx)(n.a,{href:"https://github.com/jitsi/jitsi-meet-sdk-samples/tree/master/ios/swift-screensharing/JitsiSDKScreenSharingTest",children:"sample app"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"creating-the-broadcast-upload-extension",children:"Creating the Broadcast Upload Extension"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"})," is one of the App Extensions types defined in iOS and is used for capturing the contents of the user's screen."]}),"\n",(0,t.jsxs)(n.p,{children:["For creating the extension you need to add a new target to your application, selecting the ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"})," template. Fill in the desired name, change the language to Swift, make sure ",(0,t.jsx)(n.code,{children:"Include UI Extension"})," is not selected, as we don't need custom UI for our case, then press Finish (screenshot 1). You will see that a new folder with the extension's name was added to the project's tree, containing the ",(0,t.jsx)(n.code,{children:"SampleHandler.swift"})," class. Also, make sure to update the ",(0,t.jsx)(n.code,{children:"Deployment Info"}),", for the newly created extension, to iOS 14 or newer. To learn more about creating App Extensions check the ",(0,t.jsx)(n.a,{href:"https://developer.apple.com/library/archive/documentation/General/Conceptual/ExtensibilityPG/ExtensionCreation.html",children:"official documentation"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{alt:"screenshot 1",src:i(4994).A+"",title:"screenshot 1",width:"594",height:"402"})}),"\n",(0,t.jsxs)(n.p,{children:["With the extension created the next steps are to set up the socket connection, add the functionality for handling the received frames, and send them to RN WebRTC for processing. We will be using the code provided with the sample project for this. Copy ",(0,t.jsx)(n.code,{children:"SampleUploader.swift"}),", ",(0,t.jsx)(n.code,{children:"SocketConnection.swift"}),", ",(0,t.jsx)(n.code,{children:"DarwinNotificationCenter.swift"}),", and ",(0,t.jsx)(n.code,{children:"Atomic.swift"})," files to your extension's folder and make sure they're added to the target."]}),"\n",(0,t.jsx)(n.h3,{id:"setting-up-the-socket-connection",children:"Setting up the socket connection"}),"\n",(0,t.jsx)(n.p,{children:"Sending the recorded frames to RN WebRTC is done via Unix SOCK_STREAM sockets. The extension needs to be set up as the client endpoint for this."}),"\n",(0,t.jsxs)(n.p,{children:["We will update ",(0,t.jsx)(n.code,{children:"SampleHandler.swift"})," to initiate the socket connection with RN WebRTC, using the ",(0,t.jsx)(n.code,{children:"SocketConnection"})," class. But before, we have to set up the file that the sockets will use for communication."]}),"\n",(0,t.jsxs)(n.p,{children:["Even though an app extension bundle is nested within its containing app\u2019s bundle, the running app extension and containing app have no direct access to each other\u2019s containers. We will address this by enabling data sharing. To enable data sharing, use Xcode or the Developer portal to enable app groups for the containing app and its contained app extensions. Next, register the app group in the portal and specify the app group to use in the containing app. To learn about working with app groups, see ",(0,t.jsx)(n.a,{href:"https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/EntitlementKeyReference/Chapters/EnablingAppSandbox.html#//apple_ref/doc/uid/TP40011195-CH4-SW19",children:"Adding an App to an App Group"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Now, add a ",(0,t.jsx)(n.code,{children:"private var socketFilePath: String"})," to your ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class and set it up with a shared file named ",(0,t.jsx)(n.code,{children:"rtc_SSFD"}),", using the newly registered app group, like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'private enum Constants {\n static let appGroupIdentifier = "my.custom.app.group"\n}\n\nprivate var socketFilePath: String {\n let sharedContainer = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: Constants.appGroupIdentifier)\n \n return sharedContainer?.appendingPathComponent("rtc_SSFD").path ?? ""\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Next, we will configure the ",(0,t.jsx)(n.code,{children:"SocketConnection"})," to use the shared file. Add a ",(0,t.jsx)(n.code,{children:"private var clientConnection: SocketConnection?"})," to the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class and override ",(0,t.jsx)(n.code,{children:"init"})," to set it up, like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override init() {\n super.init()\n if let connection = SocketConnection(filePath: socketFilePath) {\n clientConnection = connection\n }\n} \n"})}),"\n",(0,t.jsxs)(n.p,{children:["In order for this to work, the RN WebRTC end needs to know about the app group identifier we have configured the app with. We are doing this by adding a new key named ",(0,t.jsx)(n.code,{children:"RTCAppGroupIdentifier"})," to the app's ",(0,t.jsx)(n.code,{children:"Info.plist"})," with the app group identifier as the value."]}),"\n",(0,t.jsx)(n.h3,{id:"opening-the-socket-connection",children:"Opening the socket connection"}),"\n",(0,t.jsxs)(n.p,{children:["For starting screen sharing JitsiMeet SDK provides the UI to present the ",(0,t.jsx)(n.code,{children:"RPSystemBroadcastPickerView"})," to the user. By default, the picker will display a list of all the available broadcast providers. In order to limit the picker to our particular broadcast provider, we have to set ",(0,t.jsx)(n.code,{children:"preferredExtension"})," to the bundle identifier of the broadcast extension. We are doing this by adding a new key named ",(0,t.jsx)(n.code,{children:"RTCScreenSharingExtension"})," to the app's Info.plist and setting the broadcast extension bundle identifier as the value."]}),"\n",(0,t.jsxs)(n.p,{children:["Once screen recording has started ReplayKit invokes the methods to handle video buffers, as well as the methods to handle starting and stopping the broadcast, from the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class. The ",(0,t.jsx)(n.code,{children:"broadcastStarted(withSetupInfo:)"})," method is our entry point for opening the socket connection with the RN WebRTC server. To do this we have to post the ",(0,t.jsx)(n.code,{children:"broadcastStarted"})," notification the server is listening for, in order to start the connection, and we are ready to connect. Add a new method ",(0,t.jsx)(n.code,{children:"openConnection()"})," to the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class which will repeatedly attempt connecting to the server, for cases when the server connection start is delayed:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'func openConnection() {\n let queue = DispatchQueue(label: "broadcast.connectTimer")\n let timer = DispatchSource.makeTimerSource(queue: queue)\n timer.schedule(deadline: .now(), repeating: .milliseconds(100), leeway: .milliseconds(500))\n timer.setEventHandler { [weak self] in\n guard self?.clientConnection?.open() == true else {\n return\n }\n \n timer.cancel()\n }\n \n timer.resume()\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Next, update the ",(0,t.jsx)(n.code,{children:"broadcastStarted(withSetupInfo:)"})," method to post the notification and connect:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?) {\n DarwinNotificationCenter.shared.postNotification(.broadcastStarted)\n openConnection()\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"DarwinNotificationCenter"})," is a simple helper class for broadcasting system-wide notifications, instead of delivering only within a single program, as ",(0,t.jsx)(n.code,{children:"NSNotificationCenter"})," does. This mechanism allows the app to register for notifications sent from the extension."]}),"\n",(0,t.jsx)(n.p,{children:"Now we are ready to start sending video frames."}),"\n",(0,t.jsx)(n.h3,{id:"sending-video-frames",children:"Sending video frames"}),"\n",(0,t.jsxs)(n.p,{children:["RN WebRTC is designed to work with jpeg encoded images framed in a ",(0,t.jsx)(n.code,{children:"CFHTTPMessage"})," object. The following header fields are required:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Content-Length"})," - the size of the jpeg data"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Buffer-Width"})," - the width of the buffer, in pixels"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Buffer-Height"})," - the buffer height, in pixels"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Buffer-Orientation"})," - the value for the ",(0,t.jsx)(n.code,{children:"RPVideoSampleOrientationKey"})," that describes the video orientation."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["We are going to prepare and send our video frames using the ",(0,t.jsx)(n.code,{children:"SampleUploader"})," class. Add a new ",(0,t.jsx)(n.code,{children:"private var uploader: SampleUploader?"})," to the SampleHandler class and update ",(0,t.jsx)(n.code,{children:"init()"})," to initialize it:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override init() {\n super.init()\n if let connection = SocketConnection(filePath: socketFilePath) {\n clientConnection = connection\n uploader = SampleUploader(connection: connection)\n }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Next, we are going to update the ",(0,t.jsx)(n.code,{children:"processSampleBuffer(_ sampleBuffer: CMSampleBuffer, with sampleBufferType: RPSampleBufferType)"})," method to send our video frames. For performance reasons, we'll also implement a very simple mechanism for adjusting the frame rate by using every third frame. Add a new ",(0,t.jsx)(n.code,{children:"private var frameCount = 0"})," and update the above-mentioned method like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func processSampleBuffer(_ sampleBuffer: CMSampleBuffer, with sampleBufferType: RPSampleBufferType) {\n switch sampleBufferType {\n case .video:\n // very simple mechanism for adjusting frame rate by using every third frame\n frameCount += 1\n if frameCount % 3 == 0 {\n uploader?.send(sample: sampleBuffer)\n }\n default:\n break\n }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Also, update ",(0,t.jsx)(n.code,{children:"broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?)"})," to reset the ",(0,t.jsx)(n.code,{children:"frameCount"})," every time screen sharing is started:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?) {\n frameCount = 0\n \n DarwinNotificationCenter.shared.postNotification(.broadcastStarted)\n openConnection()\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"With this, we've concluded sending the video frames and we can move to the last step, handling stop screen sharing."}),"\n",(0,t.jsx)(n.h3,{id:"handling-stop-screen-sharing",children:"Handling stop screen sharing"}),"\n",(0,t.jsx)(n.p,{children:"Besides the in-meeting UI (screenshot 2), ReplayKit integration with iOS provides support for stopping screen recording outside of the app's control, from the status bar (screenshot 3) or using the Control Center (screenshot 4)."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.img,{alt:"ios-screensharing",src:i(3177).A+"",title:"screenshot 2",width:"226",height:"487"})," ",(0,t.jsx)(n.img,{alt:"ios-screensharing",src:i(6272).A+"",title:"screenshot 3",width:"226",height:"487"})," ",(0,t.jsx)(n.img,{alt:"ios-screensharing",src:i(9119).A+"",title:"screenshot 4",width:"226",height:"487"})]}),"\n",(0,t.jsxs)(n.p,{children:["Any of these actions will trigger ",(0,t.jsx)(n.code,{children:"broadcastFinished"})," in our ",(0,t.jsx)(n.code,{children:"SampleHandler"})," implementation. This is our entry point for closing the connection and cleaning up. We will update ",(0,t.jsx)(n.code,{children:"broadcastFinished"})," to post a ",(0,t.jsx)(n.code,{children:"DarwinNotification.broadcastStopped"})," system-wide notification and close the connection:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:"override func broadcastFinished() {\n DarwinNotificationCenter.shared.postNotification(.broadcastStopped)\n clientConnection?.close()\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Another scenario we need to take care of is when the server connection is dropped, like when leaving a meeting while screen sharing or an error is encountered. We will address this by handling ",(0,t.jsx)(n.code,{children:"clientConnection.didClose"})," event. Add a new method ",(0,t.jsx)(n.code,{children:"setupConnection"})," to the ",(0,t.jsx)(n.code,{children:"SampleHandler"})," class and update ",(0,t.jsx)(n.code,{children:"init"})," to call it:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'func setupConnection() {\n clientConnection?.didClose = { [weak self] error in \n if let error = error {\n self?.finishBroadcastWithError(error)\n } else {\n // the displayed failure message is more user friendly when using NSError instead of Error\n let JMScreenSharingStopped = 10001\n let customError = NSError(domain: RPRecordingErrorDomain, code: JMScreenSharingStopped, userInfo: [NSLocalizedDescriptionKey: "Screen sharing stopped"])\n self?.finishBroadcastWithError(customError)\n }\n }\n}\n\noverride init() {\n super.init()\n if let connection = SocketConnection(filePath: socketFilePath) {\n clientConnection = connection\n setupConnection()\n \n uploader = SampleUploader(connection: connection)\n }\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Now, that we are done writing the implementation, we just need to enable the functionality in Jitsi. We are doing this by configuring ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptionsBuilder"})," with the ",(0,t.jsx)(n.code,{children:"ios.screensharing.enabled feature"})," flag, like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-swift",children:'let options = JitsiMeetConferenceOptions.fromBuilder { [weak self] builder in\n ...\n builder.setFeatureFlag("ios.screensharing.enabled", withBoolean: true)\n}\nmeetView.join(options)\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Finally, we are ready to test the implementation. Before doing so, make sure voip is added to ",(0,t.jsx)(n.code,{children:"UIBackgroundModes"}),", in the app's ",(0,t.jsx)(n.code,{children:"Info.playlist"}),", in order to work when the app is in the background."]}),"\n",(0,t.jsx)(n.h3,{id:"tldr",children:"TL;DR"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Add a ",(0,t.jsx)(n.code,{children:"Broadcast Upload Extension"}),", without UI, to your app. Update deployment info to run in iOS 14 or newer."]}),"\n",(0,t.jsxs)(n.li,{children:["Copy ",(0,t.jsx)(n.code,{children:"SampleUploader.swift"}),", ",(0,t.jsx)(n.code,{children:"SocketConnection.swift"}),", ",(0,t.jsx)(n.code,{children:"DarwinNotificationCenter.swift"})," and ",(0,t.jsx)(n.code,{children:"Atomic.swift"})," files from the sample project to your extension. Make sure they are added to the extension's target."]}),"\n",(0,t.jsxs)(n.li,{children:["Add both the app and the extension to the same App Group. Next, add the app group id value to the app's ",(0,t.jsx)(n.code,{children:"Info.plist"})," for the ",(0,t.jsx)(n.code,{children:"RTCAppGroupIdentifier"})," key."]}),"\n",(0,t.jsxs)(n.li,{children:["Add a new key ",(0,t.jsx)(n.code,{children:"RTCScreenSharingExtension"})," to the app's ",(0,t.jsx)(n.code,{children:"Info.plist"})," with the extension's ",(0,t.jsx)(n.code,{children:"Bundle Identifier"})," as the value."]}),"\n",(0,t.jsxs)(n.li,{children:["Update ",(0,t.jsx)(n.code,{children:"SampleHandler.swift"})," with the code from the sample project. Update ",(0,t.jsx)(n.code,{children:"appGroupIdentifier"})," constant with the App Group name your app and extension are both registered to."]}),"\n",(0,t.jsxs)(n.li,{children:["Update ",(0,t.jsx)(n.code,{children:"JitsiMeetConferenceOptions"})," to enable screen sharing using the ",(0,t.jsx)(n.code,{children:"ios.screensharing.enabled"})," feature flag."]}),"\n",(0,t.jsxs)(n.li,{children:["Make sure ",(0,t.jsx)(n.code,{children:"voip"})," is added to ",(0,t.jsx)(n.code,{children:"UIBackgroundModes"}),", in the app's ",(0,t.jsx)(n.code,{children:"Info.plist"}),", in order to work when the app is in the background."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"debugging",children:"Debugging"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["If you choose ",(0,t.jsx)(n.code,{children:"Console"})," app for debugging, please be sure that you select:\n",(0,t.jsx)(n.code,{children:"Action"}),"(tab) -> ",(0,t.jsx)(n.code,{children:"Include Info Messages"}),"\n",(0,t.jsx)(n.code,{children:"Action"}),"(tab) -> ",(0,t.jsx)(n.code,{children:"Include Debug Messages"})]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["In the Search filter please type ",(0,t.jsx)(n.code,{children:"JitsiMeetSDK"}),", press Return key and replace ",(0,t.jsx)(n.code,{children:"ANY"})," with ",(0,t.jsx)(n.code,{children:"Category"}),".\nThis will show you all the real time logs related to our SDK."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},4994:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_1-9fc051cab7c6c45813ac86a09d9be7f8.png"},3177:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_2-e4305e7a7935b01689f316310cae41e9.png"},6272:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_3-83343a2407deba42d29b363470fa4680.png"},9119:(e,n,i)=>{i.d(n,{A:()=>t});const t=i.p+"assets/images/iOS_screensharing_4-985c0a05d859624dab3201410a425ca1.png"},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var t=i(6540);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6d2ef372.3a2db03a.js b/assets/js/6d2ef372.982f2189.js similarity index 99% rename from assets/js/6d2ef372.3a2db03a.js rename to assets/js/6d2ef372.982f2189.js index 80cb4c405..166d80a81 100644 --- a/assets/js/6d2ef372.3a2db03a.js +++ b/assets/js/6d2ef372.982f2189.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_jitsi_handbook=self.webpackChunk_jitsi_handbook||[]).push([[7344],{5220:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>l});var s=i(4848),r=i(8453);const t={id:"dev-guide-ljm-api",title:"lib-jitsi-meet API (low level)"},c=void 0,d={id:"dev-guide/dev-guide-ljm-api",title:"lib-jitsi-meet API (low level)",description:"You can use Jitsi Meet API to create Jitsi Meet video conferences with a custom GUI.",source:"@site/docs/dev-guide/ljm-api.md",sourceDirName:"dev-guide",slug:"/dev-guide/dev-guide-ljm-api",permalink:"/handbook/docs/dev-guide/dev-guide-ljm-api",draft:!1,unlisted:!1,editUrl:"https://github.com/jitsi/handbook/edit/master/docs/dev-guide/ljm-api.md",tags:[],version:"current",lastUpdatedAt:1734716243e3,frontMatter:{id:"dev-guide-ljm-api",title:"lib-jitsi-meet API (low level)"},sidebar:"docs",previous:{title:"IFrame API",permalink:"/handbook/docs/dev-guide/dev-guide-iframe"},next:{title:"Electron SDK",permalink:"/handbook/docs/dev-guide/dev-guide-electron-sdk"}},o={},l=[{value:"Installation",id:"installation",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Components",id:"components",level:2},{value:"Usage",id:"usage",level:2},{value:"JitsiMeetJS",id:"jitsimeetjs",level:3},{value:"JitsiConnection",id:"jitsiconnection",level:3},{value:"JitsiConference",id:"jitsiconference",level:3},{value:"JitsiTrack",id:"jitsitrack",level:3},{value:"JitsiTrackError",id:"jitsitrackerror",level:3}];function a(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"You can use Jitsi Meet API to create Jitsi Meet video conferences with a custom GUI."}),"\n",(0,s.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,s.jsx)(n.p,{children:"To embed Jitsi Meet API in your application you need to add Jitsi Meet API library"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-html",children:' - + +

Architecture

In this section, a global overview of the Jitsi infrastructure is provided. If you just started contributing to the project, we highly recommend reading this section thoroughly.

@@ -47,6 +47,6 @@

Code MapTesting​

The main form of testing code changes is done through torture tests, next to this the code is tested manually.

The torture tests are located in a separate repository, Jitsi Meet Torture. The project contains end-to-end tests for several key functions such as peer-to-peer and invites. The testing can be done for iOS, Android, and the web, which are all the platforms that Jitsi Meet can be used on. The testing is done automatically for pull requests by project members, where it is used in combination with the continuous integration by a Jenkins instance running the tests, testing on the meet.jit.si instance. Other members can run the tests locally. The test results can be viewed on an automatically generated web page.

-

Manual testing is performed while doing code reviews, however, there are also testing releases that can be freely downloaded and deployed or can be used on the beta test server.

+

Manual testing is performed while doing code reviews, however, there are also testing releases that can be freely downloaded and deployed or can be used on the beta test server.

\ No newline at end of file diff --git a/docs/category/configuration/index.html b/docs/category/configuration/index.html index cf9dbb05b..b0397697b 100644 --- a/docs/category/configuration/index.html +++ b/docs/category/configuration/index.html @@ -4,8 +4,8 @@ Configuration | Jitsi Meet - - + +

Configuration

diff --git a/docs/category/deployment/index.html b/docs/category/deployment/index.html index ee51bc4e8..f76b9cecc 100644 --- a/docs/category/deployment/index.html +++ b/docs/category/deployment/index.html @@ -4,8 +4,8 @@ Deployment | Jitsi Meet - - + +

Deployment

diff --git a/docs/category/developer-guide/index.html b/docs/category/developer-guide/index.html index 97339f395..edb49946a 100644 --- a/docs/category/developer-guide/index.html +++ b/docs/category/developer-guide/index.html @@ -4,8 +4,8 @@ Developer Guide | Jitsi Meet - - + +

Developer Guide

diff --git a/docs/category/mobile/index.html b/docs/category/mobile/index.html index fa80e9f9b..6fb144bb4 100644 --- a/docs/category/mobile/index.html +++ b/docs/category/mobile/index.html @@ -4,8 +4,8 @@ Mobile | Jitsi Meet - - + +

Mobile

diff --git a/docs/category/sdks/index.html b/docs/category/sdks/index.html index 73278b1ba..c72741bf4 100644 --- a/docs/category/sdks/index.html +++ b/docs/category/sdks/index.html @@ -4,8 +4,8 @@ SDKs | Jitsi Meet - - + +

SDKs

diff --git a/docs/category/user-guide/index.html b/docs/category/user-guide/index.html index fa53c2195..e64986b78 100644 --- a/docs/category/user-guide/index.html +++ b/docs/category/user-guide/index.html @@ -4,8 +4,8 @@ User Guide | Jitsi Meet - - + +

User Guide

diff --git a/docs/category/web/index.html b/docs/category/web/index.html index e5077c06b..eb2efe94e 100644 --- a/docs/category/web/index.html +++ b/docs/category/web/index.html @@ -4,8 +4,8 @@ Web | Jitsi Meet - - + +

Web

diff --git a/docs/community/community-intro/index.html b/docs/community/community-intro/index.html index 34be654ad..1f1b8a072 100644 --- a/docs/community/community-intro/index.html +++ b/docs/community/community-intro/index.html @@ -4,8 +4,8 @@ Our community | Jitsi Meet - - + +
+
\ No newline at end of file diff --git a/docs/community/third-party-software/index.html b/docs/community/third-party-software/index.html index 0d8b73018..6394ee97d 100644 --- a/docs/community/third-party-software/index.html +++ b/docs/community/third-party-software/index.html @@ -4,8 +4,8 @@ Third-Party Software | Jitsi Meet - - + +
+

Github: https://github.com/aadpM2hhdixoJm3u/jitsi-OIDC-adapter

\ No newline at end of file diff --git a/docs/dev-guide/dev-guide-android-sdk/index.html b/docs/dev-guide/dev-guide-android-sdk/index.html index 02bca9b05..a30ba41c0 100644 --- a/docs/dev-guide/dev-guide-android-sdk/index.html +++ b/docs/dev-guide/dev-guide-android-sdk/index.html @@ -4,8 +4,8 @@ Android SDK | Jitsi Meet - - + +

Android SDK

The Jitsi Meet Android SDK provides the same user experience as the Jitsi Meet app, @@ -236,6 +236,6 @@

Dropbox
  • Add the following to the app's strings.xml and change <APP_KEY> to your Dropbox app key:
    • -
    <string name="dropbox_app_key"><APP_KEY></string>

    +
    <string name="dropbox_app_key"><APP_KEY></string>
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-configuration/index.html b/docs/dev-guide/dev-guide-configuration/index.html index 7f7fad6af..f4ceb7492 100644 --- a/docs/dev-guide/dev-guide-configuration/index.html +++ b/docs/dev-guide/dev-guide-configuration/index.html @@ -4,8 +4,8 @@ Configuration | Jitsi Meet - - + +

    Configuration

    This page describes available configuration options for Jitsi Meet. These are either set in config.js on the server @@ -716,6 +716,6 @@

    whiteboarduserLimit - The user access limit to the whiteboard, introduced as a means to control the performance.
  • limitUrl - The url for more info about the whiteboard and its usage limitations.
    • -
    whiteboard: {
        enabled: true,
        collabServerBaseUrl: 'https://excalidraw-backend.example.com',
        userLimit: 25,
        limitUrl: 'https://example.com/blog/whiteboard-limits'
    }

    +
    whiteboard: {
        enabled: true,
        collabServerBaseUrl: 'https://excalidraw-backend.example.com',
        userLimit: 25,
        limitUrl: 'https://example.com/blog/whiteboard-limits'
    }
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-contributing/index.html b/docs/dev-guide/dev-guide-contributing/index.html index a36e0425e..f73b9ebf8 100644 --- a/docs/dev-guide/dev-guide-contributing/index.html +++ b/docs/dev-guide/dev-guide-contributing/index.html @@ -4,8 +4,8 @@ Contributing Guidelines | Jitsi Meet - - + +
    +
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-electron-sdk/index.html b/docs/dev-guide/dev-guide-electron-sdk/index.html index b857ced3d..c325beb2a 100644 --- a/docs/dev-guide/dev-guide-electron-sdk/index.html +++ b/docs/dev-guide/dev-guide-electron-sdk/index.html @@ -4,8 +4,8 @@ Electron SDK | Jitsi Meet - - + +

    Electron SDK

    The Jitsi Meet Electron SDK provides a toolkit for adding Jitsi Meet into electron applications with additional features for a better desktop experience.

    @@ -70,6 +70,6 @@

    Power Monitor<

    NOTE:​

    You'll need to add 'disable-site-isolation-trials' switch because of https://github.com/electron/electron/issues/18214:

    app.commandLine.appendSwitch('disable-site-isolation-trials')
    -

    For more information please check out the SDK's repository https://github.com/jitsi/jitsi-meet-electron-sdk.

    +

    For more information please check out the SDK's repository https://github.com/jitsi/jitsi-meet-electron-sdk.

    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-flutter-sdk/index.html b/docs/dev-guide/dev-guide-flutter-sdk/index.html index 65d273799..3c9ab5aa3 100644 --- a/docs/dev-guide/dev-guide-flutter-sdk/index.html +++ b/docs/dev-guide/dev-guide-flutter-sdk/index.html @@ -4,8 +4,8 @@ Flutter SDK | Jitsi Meet - - + +

    Flutter SDK

    The Jitsi Meet Flutter SDK provides the same user experience as the Jitsi Meet app, in the form of a Flutter plugin so that you can embed and customize Jitsi Meet in your own Flutter app.

    @@ -183,6 +183,6 @@

    readyToClose()​

    Called when the SDK is ready to be closed. No meeting is happening at this point.

    Example of listener:​

    -
    var listener = JitsiMeetEventListener(
          conferenceJoined: (url) {
            debugPrint("conferenceJoined: url: $url");
          },

          participantJoined: (email, name, role, participantId) {
            debugPrint(
              "participantJoined: email: $email, name: $name, role: $role, "
                  "participantId: $participantId",
            );
            participants.add(participantId!);
          },

          chatMessageReceived: (senderId, message, isPrivate) {
            debugPrint(
              "chatMessageReceived: senderId: $senderId, message: $message, "
                  "isPrivate: $isPrivate",
            );
          },

          readyToClose: () {
            debugPrint("readyToClose");
          },
        );
    +
    var listener = JitsiMeetEventListener(
          conferenceJoined: (url) {
            debugPrint("conferenceJoined: url: $url");
          },

          participantJoined: (email, name, role, participantId) {
            debugPrint(
              "participantJoined: email: $email, name: $name, role: $role, "
                  "participantId: $participantId",
            );
            participants.add(participantId!);
          },

          chatMessageReceived: (senderId, message, isPrivate) {
            debugPrint(
              "chatMessageReceived: senderId: $senderId, message: $message, "
                  "isPrivate: $isPrivate",
            );
          },

          readyToClose: () {
            debugPrint("readyToClose");
          },
        );
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-iframe-commands/index.html b/docs/dev-guide/dev-guide-iframe-commands/index.html index 8429ef6ce..eeeb18c24 100644 --- a/docs/dev-guide/dev-guide-iframe-commands/index.html +++ b/docs/dev-guide/dev-guide-iframe-commands/index.html @@ -4,8 +4,8 @@ Commands | Jitsi Meet - - + +

    Commands

    You can control the embedded Jitsi Meet conference by calling executeCommand on the JitsiMeetExternalAPI object:

    @@ -264,6 +264,6 @@

    setAudioOnly
    api.executeCommand('setAudioOnly',
        enable: boolean // Required. true for enable and false for disable 
    );

    setVirtualBackground​

    Set your virtual background with a base64 image.

    -
    api.executeCommand('setVirtualBackground',
        enabled: boolean, // Required. Enable or disable the virtual background.
        backgroundImage: string // Required. Base64 image string, eg. "data:image/png;base64, iVBOR...".
    );
    +
    api.executeCommand('setVirtualBackground',
        enabled: boolean, // Required. Enable or disable the virtual background.
        backgroundImage: string // Required. Base64 image string, eg. "data:image/png;base64, iVBOR...".
    );
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-iframe-events/index.html b/docs/dev-guide/dev-guide-iframe-events/index.html index 06aee0cfb..4e4c250da 100644 --- a/docs/dev-guide/dev-guide-iframe-events/index.html +++ b/docs/dev-guide/dev-guide-iframe-events/index.html @@ -4,8 +4,8 @@ Events | Jitsi Meet - - + +

    Events

    The JitsiMeetExternalAPI object implements the EventEmitter API for emitting and listening for events.

    @@ -247,6 +247,6 @@

    p2pStatusCh

    audioOnlyChanged​

    Provides event notifications about changes to the audio only mode status.

    The listener receives an object with the following structure:

    -
    {
        audioOnlyChanged: boolean // whether the audio only is enabled or disabled.
    }
    +
    {
        audioOnlyChanged: boolean // whether the audio only is enabled or disabled.
    }
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-iframe-functions/index.html b/docs/dev-guide/dev-guide-iframe-functions/index.html index 48d0e1518..5d433a13c 100644 --- a/docs/dev-guide/dev-guide-iframe-functions/index.html +++ b/docs/dev-guide/dev-guide-iframe-functions/index.html @@ -4,8 +4,8 @@ Functions | Jitsi Meet - - + +

    Functions

    Use the following API functions to control your embedded Jitsi Meet Conference.

    @@ -164,6 +164,6 @@

    invitedispose​

    Removes the embedded Jitsi Meet conference:

    api.dispose();
    -

    NOTE: Jitsi recommends removing the conference before the page is unloaded.

    +

    NOTE: Jitsi recommends removing the conference before the page is unloaded.

    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-iframe/index.html b/docs/dev-guide/dev-guide-iframe/index.html index f02835091..ce24653f5 100644 --- a/docs/dev-guide/dev-guide-iframe/index.html +++ b/docs/dev-guide/dev-guide-iframe/index.html @@ -4,8 +4,8 @@ IFrame API | Jitsi Meet - - + +

    IFrame API

    Embedding the Jitsi Meet API into your site or app enables you to host and provide secure video meetings with your colleagues, teams, and stakeholders. The Meet API provides a full complement of comprehensive meeting features.

    @@ -127,6 +127,6 @@

    FunctionsCommands​

    All commands are documented here now.

    Events​

    -

    All events are documented here now.

    +

    All events are documented here now.

    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-ios-sdk/index.html b/docs/dev-guide/dev-guide-ios-sdk/index.html index 5c4b66a02..2d37eaa27 100644 --- a/docs/dev-guide/dev-guide-ios-sdk/index.html +++ b/docs/dev-guide/dev-guide-ios-sdk/index.html @@ -4,8 +4,8 @@ iOS SDK | Jitsi Meet - - + +

    iOS SDK

    The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app, @@ -277,6 +277,6 @@

    Debugging
    Edit this page
    Last updated on

    +
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-ljm-api/index.html b/docs/dev-guide/dev-guide-ljm-api/index.html index ec76f07fa..3292c0ec1 100644 --- a/docs/dev-guide/dev-guide-ljm-api/index.html +++ b/docs/dev-guide/dev-guide-ljm-api/index.html @@ -4,8 +4,8 @@ lib-jitsi-meet API (low level) | Jitsi Meet - - + +

    lib-jitsi-meet API (low level)

    You can use Jitsi Meet API to create Jitsi Meet video conferences with a custom GUI.

    @@ -754,6 +754,6 @@

    JitsiTrackEr
  • error - original GUM error
  • constraints - GUM constraints object used for the call
  • devices - array of devices requested in GUM call (possible values - "audio", "video", "screen", "desktop", "audiooutput")
    • -

    +
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-ljm/index.html b/docs/dev-guide/dev-guide-ljm/index.html index 8066bbb42..7763b45d0 100644 --- a/docs/dev-guide/dev-guide-ljm/index.html +++ b/docs/dev-guide/dev-guide-ljm/index.html @@ -4,8 +4,8 @@ Modifying lib-jitsi-meet | Jitsi Meet - - + +

    Modifying lib-jitsi-meet

    @@ -25,6 +25,6 @@

    After changes in your local lib-jitsi-meet repository, you can rebuild it with npm run build and your jitsi-meet repository will use that modified library:

    cd node_modules/lib-jitsi-meet
    npm run build

    If you do not want to use local repository anymore you should run:

    -
    cd jitsi-meet
    npm unlink lib-jitsi-meet
    npm install
    +
    cd jitsi-meet
    npm unlink lib-jitsi-meet
    npm install
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-mobile-jitsi-meet/index.html b/docs/dev-guide/dev-guide-mobile-jitsi-meet/index.html index 8bd55629d..bd15a9790 100644 --- a/docs/dev-guide/dev-guide-mobile-jitsi-meet/index.html +++ b/docs/dev-guide/dev-guide-mobile-jitsi-meet/index.html @@ -4,8 +4,8 @@ Developer Guide for Jitsi Meet | Jitsi Meet - - + +
    +
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-react-native-sdk/index.html b/docs/dev-guide/dev-guide-react-native-sdk/index.html index 8d4e2373b..e3e956f99 100644 --- a/docs/dev-guide/dev-guide-react-native-sdk/index.html +++ b/docs/dev-guide/dev-guide-react-native-sdk/index.html @@ -4,8 +4,8 @@ React Native SDK | Jitsi Meet - - + +

    React Native SDK

    The Jitsi React Native SDK provides the same user experience as the Jitsi Meet app, @@ -152,6 +152,6 @@

    userInfo
    Edit this page
    Last updated on

    +
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-react-sdk/index.html b/docs/dev-guide/dev-guide-react-sdk/index.html index 1e8a820a1..359488625 100644 --- a/docs/dev-guide/dev-guide-react-sdk/index.html +++ b/docs/dev-guide/dev-guide-react-sdk/index.html @@ -4,8 +4,8 @@ React SDK | Jitsi Meet - - + +

    React SDK

    The Jitsi Meet React SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps.

    @@ -73,6 +73,6 @@

    Common pro

  • getIFrameRef: Optional. The parent node used by the IFrame.

    • -

    +
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-web-integrations/index.html b/docs/dev-guide/dev-guide-web-integrations/index.html index 227fa9dde..b0cfa5b84 100644 --- a/docs/dev-guide/dev-guide-web-integrations/index.html +++ b/docs/dev-guide/dev-guide-web-integrations/index.html @@ -4,8 +4,8 @@ Web integrations | Jitsi Meet - - + +

    Web integrations

    Creating the Google API client for Google Calendar and YouTube integration​

    @@ -47,6 +47,6 @@

    Edit this page
    Last updated on

    +
    \ No newline at end of file diff --git a/docs/dev-guide/dev-guide-web-jitsi-meet/index.html b/docs/dev-guide/dev-guide-web-jitsi-meet/index.html index 4a0cc6861..6335b68e5 100644 --- a/docs/dev-guide/dev-guide-web-jitsi-meet/index.html +++ b/docs/dev-guide/dev-guide-web-jitsi-meet/index.html @@ -4,8 +4,8 @@ Developer Guide for Jitsi Meet | Jitsi Meet - - + +

    Developer Guide for Jitsi Meet

    This guide will help you setup a development environment to start working on the Jitsi Meet web app itself.

    @@ -34,6 +34,6 @@

    Building .debs 
    npm install
    make
    dpkg-buildpackage -A -rfakeroot -us -uc -tc

    You'll have a bunch of .deb files in the parent directory, and can push the updated source to your server and install it with the jitsi-meet-web deb file.

    Running from source on existing deployment​

    -

    Follow the document https://community.jitsi.org/t/how-to-how-to-build-jitsi-meet-from-source-a-developers-guide/75422

    +

    Follow the document https://community.jitsi.org/t/how-to-how-to-build-jitsi-meet-from-source-a-developers-guide/75422

    \ No newline at end of file diff --git a/docs/dev-guide/mobile-dropbox/index.html b/docs/dev-guide/mobile-dropbox/index.html index a8933727c..2afb364f1 100644 --- a/docs/dev-guide/mobile-dropbox/index.html +++ b/docs/dev-guide/mobile-dropbox/index.html @@ -4,8 +4,8 @@ Setting up Dropbox integration | Jitsi Meet - - + +

    Setting up Dropbox integration

      @@ -17,6 +17,6 @@ 
      <key>CFBundleURLTypes</key>
      <array>
        <dict>
          <key>CFBundleURLName</key>
          <string></string>
          <key>CFBundleURLSchemes</key>
          <array>
            <string>db-<APP_KEY></string>
          </array>
        </dict>
      </array>
      <key>LSApplicationQueriesSchemes</key>
      <array>
        <string>dbapi-2</string>
        <string>dbapi-8-emm</string>
      </array>

      NOTE: Both Android and iOS builds of the apps will parse the Dropbox app key from ios/app/src/Info.plist.

      -

      NOTE: See Dropbox developer guide for more information

    +

    NOTE: See Dropbox developer guide for more information

    \ No newline at end of file diff --git a/docs/dev-guide/mobile-feature-flags/index.html b/docs/dev-guide/mobile-feature-flags/index.html index 06d662422..4dd97ea5a 100644 --- a/docs/dev-guide/mobile-feature-flags/index.html +++ b/docs/dev-guide/mobile-feature-flags/index.html @@ -4,12 +4,12 @@ Feature flags | Jitsi Meet - - + +

    Feature flags

    The mobile SDK supports a number of feature flags which allow for customizing certain UI aspects and behavior.

    -

    All flags are defined here.

    +

    All flags are defined here.

    \ No newline at end of file diff --git a/docs/dev-guide/mobile-google-auth/index.html b/docs/dev-guide/mobile-google-auth/index.html index c5541b9e1..1bebaba9e 100644 --- a/docs/dev-guide/mobile-google-auth/index.html +++ b/docs/dev-guide/mobile-google-auth/index.html @@ -4,8 +4,8 @@ Setting up Google sign-in integration | Jitsi Meet - - + +

    Setting up Google sign-in integration

      @@ -29,6 +29,6 @@ (replacing placeholder).
    • Enable YouTube API access on the developer console (see above) to enable live streaming.
      • -
    + \ No newline at end of file diff --git a/docs/devops-guide/cloud-api/index.html b/docs/devops-guide/cloud-api/index.html index 39e2a76b6..8dcc3ccbe 100644 --- a/docs/devops-guide/cloud-api/index.html +++ b/docs/devops-guide/cloud-api/index.html @@ -4,13 +4,13 @@ Cloud API | Jitsi Meet - - + +
    +

    https://github.com/luki-ev/conferencemapper

    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-bsd/index.html b/docs/devops-guide/devops-guide-bsd/index.html index 6fd8b9dcf..72498d26d 100644 --- a/docs/devops-guide/devops-guide-bsd/index.html +++ b/docs/devops-guide/devops-guide-bsd/index.html @@ -4,8 +4,8 @@ Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD | Jitsi Meet - - + +

    Self-Hosting Guide - FreeBSD/NetBSD/OpenBSD

    This document is a reference point for pointing to the upstream packages provided by the FreeBSD, NetBSD and OpenBSD distributions. Jitsi only officially supports Linux, for any problems with the BSD packages you can contact their respective mailing lists.

    @@ -21,6 +21,6 @@

    OpenBSDLimitations​

    • Jigasi and Jibri have not yet been ported to work with any BSD systems.
      • -
    +
    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-docker/index.html b/docs/devops-guide/devops-guide-docker/index.html index 6201649ef..386f9dc11 100644 --- a/docs/devops-guide/devops-guide-docker/index.html +++ b/docs/devops-guide/devops-guide-docker/index.html @@ -4,8 +4,8 @@ Self-Hosting Guide - Docker | Jitsi Meet - - + +

    Self-Hosting Guide - Docker

    Quick start​

    @@ -257,7 +257,7 @@

    VariableDescriptionExample
    ENABLE_TRANSCRIPTIONSEnable Jigasi transcription in a conference1

    In addition, the following are options are used to configure the various transcription backends and features:

    VariableDescriptionDefault
    GC_PROJECT_IDproject_id from Google Cloud Credentials
    GC_PRIVATE_KEY_IDprivate_key_id from Google Cloud Credentials
    GC_PRIVATE_KEYprivate_key from Google Cloud Credentials
    GC_CLIENT_EMAILclient_email from Google Cloud Credentials
    GC_CLIENT_IDclient_id from Google Cloud Credentials
    GC_CLIENT_CERT_URLclient_x509_cert_url from Google Cloud Credentials
    JIGASI_TRANSCRIBER_ADVERTISE_URLJigasi will post an url to the chat with transcription filetrue
    JIGASI_TRANSCRIBER_CUSTOM_SERVICEJigasi will use this class for custom transcriptions instead of google cloud
    JIGASI_TRANSCRIBER_CUSTOM_TRANSLATION_SERVICEJigasi will use this class for custom transctions instead of google cloud
    JIGASI_TRANSCRIBER_ENABLE_SAVINGJigasi will save results to a transcription filetrue
    JIGASI_TRANSCRIBER_FILTER_SILENCEJigasi will filter silent audio and not forward to backends
    JIGASI_TRANSCRIBER_LIBRETRANSLATE_URLURL for libretranslate services
    JIGASI_TRANSCRIBER_OCI_COMPARTMENTOCI compartment for use with Oracle Cloud Speech AI services
    JIGASI_TRANSCRIBER_OCI_REGIONOCI region name for use with Oracle Cloud Speech AI services
    JIGASI_TRANSCRIBER_RECORD_AUDIOJigasi will record audio when transcriber is ontrue
    JIGASI_TRANSCRIBER_REMOTE_CONFIG_URLURL to control transcriber custom service based on conference details
    JIGASI_TRANSCRIBER_SEND_TXTJigasi will send transcribed text to the chat when transcriber is ontrue
    JIGASI_TRANSCRIBER_USERJigasi XMPP user
    JIGASI_TRANSCRIBER_VOSK_URLURL for use with vosk backend
    JIGASI_TRANSCRIBER_WHISPER_URLURL for use with whisper backend
    JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEY_NAMEPrivate Key ID of the private key to use with whisper
    JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEYPrivate Key material to use with whisper, without newlines or START/END delimiters
    -

    For setting the Google Cloud Credentials please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol> section "Before you begin" paragraph 1 to 5.

    +

    For setting the Google Cloud Credentials please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol > section "Before you begin" paragraph 1 to 5.

    Sentry logging configuration​

    VariableDescriptionDefault value
    JVB_SENTRY_DSNSentry Data Source Name (Endpoint for Sentry project)https://public:private@host:port/1
    JICOFO_SENTRY_DSNSentry Data Source Name (Endpoint for Sentry project)https://public:private@host:port/1
    JIGASI_SENTRY_DSNSentry Data Source Name (Endpoint for Sentry project)https://public:private@host:port/1
    SENTRY_ENVIRONMENTOptional environment info to filter eventsproduction
    SENTRY_RELEASEOptional release info to filter events1.0.0

    TURN server configuration​

    @@ -320,7 +320,7 @@

    Disable HTTPS<

    Do not expose the Jitsi Meet's ports publicly​

    By default, the HTTP_PORT and HTTPS_PORT are binding to any ip address, so are publicly open unless a firewall blocks them. When using a reverse proxy, this is not necessary. This can be changed by updating the web container's ports configuration:

                - '127.0.0.1:${HTTP_PORT}:80'
                - '127.0.0.1:${HTTPS_PORT}:443'
    -

    insteaf of

    +

    instead of

                - '${HTTP_PORT}:80'
                - '${HTTPS_PORT}:443'

    Reverse proxy configuration​

    By default this setup is using WebSocket connections for 2 core components:

    @@ -345,6 +345,6 @@

    ApacheDisabling WebSocket connections​

    note

    This is not the recommended setup.

    If using WebSockets is not an option, these environment variables can be set to fallback to HTTP polling and WebRTC datachannels:

    -
    ENABLE_SCTP=1
    ENABLE_COLIBRI_WEBSOCKET=0
    ENABLE_XMPP_WEBSOCKET=0
    +
    ENABLE_SCTP=1
    ENABLE_COLIBRI_WEBSOCKET=0
    ENABLE_XMPP_WEBSOCKET=0
    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-log-analyser/index.html b/docs/devops-guide/devops-guide-log-analyser/index.html index 0008bd64e..c4f2b2d46 100644 --- a/docs/devops-guide/devops-guide-log-analyser/index.html +++ b/docs/devops-guide/devops-guide-log-analyser/index.html @@ -4,8 +4,8 @@ Self-Hosting Guide - Log Analyser | Jitsi Meet - - + +

    Self-Hosting Guide - Log Analyser

    Welcome to the Jitsi Meet Log Analyser project! This integration leverages Grafana Loki and OpenTelemetry to enable effective log management and analysis for Jitsi Meet components.

    @@ -238,6 +238,6 @@

    Troubleshoot

    Acknowledgements​

    -

    We appreciate your interest in the Jitsi Meet Log Analyser project! If you encounter any issues or have questions, feel free to reach out to the project maintainers or contribute to the repository.

    +

    We appreciate your interest in the Jitsi Meet Log Analyser project! If you encounter any issues or have questions, feel free to reach out to the project maintainers or contribute to the repository.

    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-opensuse/index.html b/docs/devops-guide/devops-guide-opensuse/index.html index 169c6af8d..a1a4b7f4b 100644 --- a/docs/devops-guide/devops-guide-opensuse/index.html +++ b/docs/devops-guide/devops-guide-opensuse/index.html @@ -4,8 +4,8 @@ Self-Hosting Guide - openSUSE | Jitsi Meet - - + +
    +
    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-quickstart/index.html b/docs/devops-guide/devops-guide-quickstart/index.html index aa00af1bf..18590a702 100644 --- a/docs/devops-guide/devops-guide-quickstart/index.html +++ b/docs/devops-guide/devops-guide-quickstart/index.html @@ -4,8 +4,8 @@ Self-Hosting Guide - Debian/Ubuntu server | Jitsi Meet - - + +

    Self-Hosting Guide - Debian/Ubuntu server

    Follow these steps for a quick Jitsi-Meet installation on a Debian-based GNU/Linux system. @@ -193,6 +193,6 @@

    Install Jigas

    During the installation, you will be asked to enter your SIP account and password. This account will be used to invite the other SIP participants.

    Reload Jitsi Meet​

    Launch again a browser with the Jitsi Meet URL and you'll see a telephone icon on the right end of the toolbar. Use it to invite SIP accounts to join the current conference.

    -

    Enjoy!

    +

    Enjoy!

    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-requirements/index.html b/docs/devops-guide/devops-guide-requirements/index.html index 82042ed8b..90362ebe6 100644 --- a/docs/devops-guide/devops-guide-requirements/index.html +++ b/docs/devops-guide/devops-guide-requirements/index.html @@ -4,8 +4,8 @@ Requirements | Jitsi Meet - - + +
    note

    Jitsi Meet is a real-time system. @@ -50,6 +50,6 @@

    Recording

    For 1080x720 you currently need at least 8 GB RAM, for 1280x1024 12 GB (this is for recording a single meeting). For cloud storage you will need at least SSD drives. If memory is not sufficient, CPU can't encode fast enough or hard disk is not fast enough, recordings will fail.

    -

    While Jibri and Jitsi Meet can technically be hosted in a single server, it's not recommended because Jibri is a resource drain and it can harm Jitsi Meet performance, and can exhaust disk space and stop Jitsi Meet function altogether.

    +

    While Jibri and Jitsi Meet can technically be hosted in a single server, it's not recommended because Jibri is a resource drain and it can harm Jitsi Meet performance, and can exhaust disk space and stop Jitsi Meet function altogether.

    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-scalable/index.html b/docs/devops-guide/devops-guide-scalable/index.html index 6c024f262..b14d97c3d 100644 --- a/docs/devops-guide/devops-guide-scalable/index.html +++ b/docs/devops-guide/devops-guide-scalable/index.html @@ -4,8 +4,8 @@ DevOps Guide (scalable setup) | Jitsi Meet - - + +

    DevOps Guide (scalable setup)

    A single server Jitsi installation is good for a limited size of concurrent conferences. @@ -85,6 +85,6 @@

    Testing
    Edit this page
    Last updated on

    +

    When a new conference starts, Jicofo picks a videobridge and schedules the conference on it.

    \ No newline at end of file diff --git a/docs/devops-guide/devops-guide-videotutorials/index.html b/docs/devops-guide/devops-guide-videotutorials/index.html index 4681f2e34..c9f7654c8 100644 --- a/docs/devops-guide/devops-guide-videotutorials/index.html +++ b/docs/devops-guide/devops-guide-videotutorials/index.html @@ -4,8 +4,8 @@ Video Tutorials | Jitsi Meet - - + +
    +
    \ No newline at end of file diff --git a/docs/devops-guide/faq/index.html b/docs/devops-guide/faq/index.html index 160d8fc4f..aaa139aef 100644 --- a/docs/devops-guide/faq/index.html +++ b/docs/devops-guide/faq/index.html @@ -4,8 +4,8 @@ FAQ | Jitsi Meet - - + +

    FAQ

    How to migrate away from multiplexing and enable bridge websockets​

    @@ -36,6 +36,6 @@ 
    videobridge {
      http-servers {
          public {
              port = 9090
          }
      }
      websockets {
          enabled = true
          domain = "your-domain:443"
          tls = true
      }
    }

    Make sure you replace your-domain with the DNS of your deployment. -5. After restarting the bridge (systemctl restart jitsi-videobridge2) and nginx (systemctl restart nginx) you are good to go!

    +5. After restarting the bridge (systemctl restart jitsi-videobridge2) and nginx (systemctl restart nginx) you are good to go!

    \ No newline at end of file diff --git a/docs/devops-guide/index.html b/docs/devops-guide/index.html index 800d43ae8..831f87c8c 100644 --- a/docs/devops-guide/index.html +++ b/docs/devops-guide/index.html @@ -4,8 +4,8 @@ Self-Hosting Guide - Overview | Jitsi Meet - - + +
    +
    \ No newline at end of file diff --git a/docs/devops-guide/ldap-authentication/index.html b/docs/devops-guide/ldap-authentication/index.html index 1aa995a82..7bfceec69 100644 --- a/docs/devops-guide/ldap-authentication/index.html +++ b/docs/devops-guide/ldap-authentication/index.html @@ -4,8 +4,8 @@ LDAP authentication | Jitsi Meet - - + +

    LDAP authentication

    note

    This is a first draft and might not work on your system. It has been tested on Debian 11 installation with prosody 0.11 and authenticates against an OpenLDAP directory, and on Ubuntu 24.04 with Prosody 0.12 against an Active Directory.

    @@ -78,6 +78,6 @@

    Set Permissi runs as the system user/group prosody.

    The easiest solution is to add the sasl group to the prosody user and restart the service.

    -
    sudo adduser prosody sasl
    sudo service prosody restart

    +
    sudo adduser prosody sasl
    sudo service prosody restart
    \ No newline at end of file diff --git a/docs/devops-guide/reservation/index.html b/docs/devops-guide/reservation/index.html index 6f3c3612b..bb887eefc 100644 --- a/docs/devops-guide/reservation/index.html +++ b/docs/devops-guide/reservation/index.html @@ -4,8 +4,8 @@ Reservation System setup | Jitsi Meet - - + +

    Reservation System setup

    Support for a reservation system over REST API​

    @@ -127,6 +127,6 @@
    Deleting conference identifier assigned by the reservation system.

    DELETE /conference/364758328 HTTP/1.1
    host: http://reservation.example.com
    ...

    Implementation diagram​

    -

    +

    \ No newline at end of file diff --git a/docs/devops-guide/secure-domain/index.html b/docs/devops-guide/secure-domain/index.html index f41907ca1..db0bad310 100644 --- a/docs/devops-guide/secure-domain/index.html +++ b/docs/devops-guide/secure-domain/index.html @@ -4,8 +4,8 @@ Secure Domain setup | Jitsi Meet - - + +

    Secure Domain setup

    It is possible to allow only authenticated users to create new conference @@ -47,6 +47,6 @@

    Enab

    Debugging​

    If you experience problems with a certificate chain, you may need to uncomment the following line, also in sip-communicator.properties:

    net.java.sip.communicator.service.gui.ALWAYS_TRUST_MODE_ENABLED=true
    -
    note

    This should only be used for testing/debugging purposes, or in controlled environments. If you confirm that this is the problem, you should then solve it in another way (e.g. get a signed certificate for Prosody, or add the particular certificate to Jigasi’s trust store).

    +
    note

    This should only be used for testing/debugging purposes, or in controlled environments. If you confirm that this is the problem, you should then solve it in another way (e.g. get a signed certificate for Prosody, or add the particular certificate to Jigasi’s trust store).

    \ No newline at end of file diff --git a/docs/devops-guide/speakerstats/index.html b/docs/devops-guide/speakerstats/index.html index 7c7030ddb..ee52e3a76 100644 --- a/docs/devops-guide/speakerstats/index.html +++ b/docs/devops-guide/speakerstats/index.html @@ -4,8 +4,8 @@ Enabling Speaker Stats | Jitsi Meet - - + +

    Enabling Speaker Stats

    To enable the speaker stats we need to enable speakerstats module under the main @@ -14,6 +14,6 @@

    We need to also enable the component with the address specified in speakerstats_component. The component needs also to have the option with the muc component address in muc_component option.

    -
    VirtualHost "jitsi.example.com"
        speakerstats_component = "speakerstats.jitsi.example.com"
        modules_enabled = {
            "speakerstats";
        }

    Component "speakerstats.jitsi.example.com" "speakerstats_component"
        muc_component = "conference.jitsi.example.com"

    Component "conference.jitsi.example.com" "muc"
    +
    VirtualHost "jitsi.example.com"
        speakerstats_component = "speakerstats.jitsi.example.com"
        modules_enabled = {
            "speakerstats";
        }

    Component "speakerstats.jitsi.example.com" "speakerstats_component"
        muc_component = "conference.jitsi.example.com"

    Component "conference.jitsi.example.com" "muc"
    \ No newline at end of file diff --git a/docs/devops-guide/turn/index.html b/docs/devops-guide/turn/index.html index eb6b3513e..3c9ccb762 100644 --- a/docs/devops-guide/turn/index.html +++ b/docs/devops-guide/turn/index.html @@ -4,8 +4,8 @@ Setting up TURN | Jitsi Meet - - + +

    Setting up TURN

    One-to-one calls should avoid going through the JVB for optimal performance and for optimal resource usage. This is why we've added the peer-to-peer mode where the two participants connect directly to each other. Unfortunately, a direct connection is not always possible between the participants. In those cases you can use a TURN server to relay the traffic (n.b. the JVB does much more than just relay the traffic, so this is not the same as using the JVB to "relay" the traffic).

    @@ -43,6 +43,6 @@ 

    systemctl stop nginx
    DOMAIN="turn-jitsi-meet.example.com"
    apt install socat
    /opt/acmesh/.acme.sh/acme.sh -f --issue -d ${DOMAIN} --standalone --server letsencrypt
    /opt/acmesh/.acme.sh/acme.sh -f --install-cert \
        -d ${DOMAIN} \
        --key-file /etc/jitsi/meet/${DOMAIN}.key \
        --fullchain-file /etc/jitsi/meet/${DOMAIN}.crt \
        --reloadcmd "/usr/share/jitsi-meet/scripts/coturn-le-update.sh ${DOMAIN}"
    systemctl start nginx
    • After restarting prosody (systemctl restart prosody) you are good to go!
      • -

    +
    \ No newline at end of file diff --git a/docs/devops-guide/videosipgw/index.html b/docs/devops-guide/videosipgw/index.html index 849a59186..9f3e93910 100644 --- a/docs/devops-guide/videosipgw/index.html +++ b/docs/devops-guide/videosipgw/index.html @@ -4,8 +4,8 @@ Configuring a video SIP gateway | Jitsi Meet - - + +

    Configuring a video SIP gateway

    This document describes how you can configure jitsi-meet to use sipgw jibri and enable rooms in 'Add people dialog' @@ -36,6 +36,6 @@

    People

    The response of the service is a json in the following format:

    [
       {
           "id": "address@sip.domain.com",
           "name": "Some room name",
           "type": "videosipgw"
       },
      {
          "id": "address2@sip.domain.com",
          "name": "Some room name2",
          "type": "videosipgw"
      }
    ]
    -

    Type should be videosipgw, name is the name shown to the user and id is the sip address to be called by the sipgw jibri.

    +

    Type should be videosipgw, name is the name shown to the user and id is the sip address to be called by the sipgw jibri.

    \ No newline at end of file diff --git a/docs/faq/index.html b/docs/faq/index.html index 55bee5da6..f0a3d554e 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -4,8 +4,8 @@ FAQ | Jitsi Meet - - + +

    FAQ

    How to tell if my server instance is behind NAT?​

    @@ -89,6 +89,6 @@

    Other participants complain my screen sharing is very bright and appears washed out?​

    -

    You might have HDR streaming enabled in your OS display or graphic card settings. If you are on Windows, you can quickly toggle HDR on/off using Win + Alt + B for all your HDR-capable screens at any time, even while screen sharing.

    +

    You might have HDR streaming enabled in your OS display or graphic card settings. If you are on Windows, you can quickly toggle HDR on/off using Win + Alt + B for all your HDR-capable screens at any time, even while screen sharing.

    \ No newline at end of file diff --git a/docs/intro/index.html b/docs/intro/index.html index 3a58589bf..449c86059 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -4,8 +4,8 @@ Introduction | Jitsi Meet - - + +

    Introduction

    What is Jitsi?​

    @@ -31,6 +31,6 @@

    About th

    JaaS customers​

    -

    Are you a JaaS customer? If so, please start here.

    +

    Are you a JaaS customer? If so, please start here.

    \ No newline at end of file diff --git a/docs/releases/index.html b/docs/releases/index.html index de4067790..337f790cf 100644 --- a/docs/releases/index.html +++ b/docs/releases/index.html @@ -4,8 +4,8 @@ Releases | Jitsi Meet - - + +
    +

    Web frontend​

    Latest stable releaserelease

    Prebuilt source builds are also available.

    note

    Generally, you won't need to download this, as it's part of the Debian packages and Docker images already.

    \ No newline at end of file diff --git a/docs/security/index.html b/docs/security/index.html index efb0970c7..f7c553fa7 100644 --- a/docs/security/index.html +++ b/docs/security/index.html @@ -4,11 +4,11 @@ Security | Jitsi Meet - - + +
    +more broadly here: https://jitsi.org/security

    \ No newline at end of file diff --git a/docs/user-guide/client connection status indicators/index.html b/docs/user-guide/client connection status indicators/index.html index 816e815ec..7cbd48e15 100644 --- a/docs/user-guide/client connection status indicators/index.html +++ b/docs/user-guide/client connection status indicators/index.html @@ -4,8 +4,8 @@ Client Connection Status Indicators | Jitsi Meet - - + +

    Client Connection Status Indicators

    This document explains what the different connection quality indicators on the video thumbnails actually mean.

    @@ -34,6 +34,6 @@

    GHOST/NINJAWhen the user stops receiving video for the remote endpoint even when the endpoint is not video muted and it is not in LastN as indicated by the bridge’s LastNEndpointChangeEvent. This means that the bridge decided to suspend the video for this user. Bridge takes into consideration the available downlink bandwidth for the receiving endpoint and the number of video streams requested using the channelLast setting.

    Target bitrates expected for the video streams​

    -
    CodecType180p (in Kbps)360p (in Kbps)720p (in Kbps)
    VP82005001500
    VP91003001200

    +
    CodecType180p (in Kbps)360p (in Kbps)720p (in Kbps)
    VP82005001500
    VP91003001200
    \ No newline at end of file diff --git a/docs/user-guide/keyboard-shortcuts/index.html b/docs/user-guide/keyboard-shortcuts/index.html index 9bd9da163..a6b47e0df 100644 --- a/docs/user-guide/keyboard-shortcuts/index.html +++ b/docs/user-guide/keyboard-shortcuts/index.html @@ -4,8 +4,8 @@ Keyboard shortcuts | Jitsi Meet - - + +

    Keyboard shortcuts

      @@ -31,6 +31,6 @@
    • SPACE - Push to talk
    • 0 - Focus on your video
    • 1-9 - Focus on another person's video
      • -
    + \ No newline at end of file diff --git a/docs/user-guide/supported-browsers/index.html b/docs/user-guide/supported-browsers/index.html index dcb1f8040..dd80c2ed3 100644 --- a/docs/user-guide/supported-browsers/index.html +++ b/docs/user-guide/supported-browsers/index.html @@ -4,8 +4,8 @@ Supported Browsers | Jitsi Meet - - + +
    +
    \ No newline at end of file diff --git a/docs/user-guide/user-guide-advanced/index.html b/docs/user-guide/user-guide-advanced/index.html index 2e9ff397f..d3419d432 100644 --- a/docs/user-guide/user-guide-advanced/index.html +++ b/docs/user-guide/user-guide-advanced/index.html @@ -4,8 +4,8 @@ User Guide (advanced) | Jitsi Meet - - + +

    User Guide (advanced)

    There are some options to tweak the invitation link to unlock more features in @@ -24,6 +24,6 @@

    VideoKeyValueEffectdesktopSharingFrameRate.min5override the minimum framerate for desktop sharingdesktopSharingFrameRate.max5override the maximum framerate for desktop sharingstartWithVideoMutedtruedisable video when joining

    Audio​

    Use these parameters to influence the audio of a session.

    -
    KeyValueEffect
    disableAudioLevelstruedisable audio statistics polling (thereby perhaps improving performance)
    disableRemoteMutetruedisable all muting operations of remote participants
    startWithAudioMutedtrueturn off audio input when joining
    startSilenttruemute audio input and output

    +
    KeyValueEffect
    disableAudioLevelstruedisable audio statistics polling (thereby perhaps improving performance)
    disableRemoteMutetruedisable all muting operations of remote participants
    startWithAudioMutedtrueturn off audio input when joining
    startSilenttruemute audio input and output
    \ No newline at end of file diff --git a/docs/user-guide/user-guide-basic/index.html b/docs/user-guide/user-guide-basic/index.html index 33e8b5f6e..f70db9031 100644 --- a/docs/user-guide/user-guide-basic/index.html +++ b/docs/user-guide/user-guide-basic/index.html @@ -4,11 +4,11 @@ User Guide (basic) | Jitsi Meet - - + +

    User Guide (basic)

    Welcome to the user guide!

    -

    Check back soon!

    +

    Check back soon!

    \ No newline at end of file diff --git a/docs/user-guide/user-guide-jitsi-meet-for-google-calendar/index.html b/docs/user-guide/user-guide-jitsi-meet-for-google-calendar/index.html index e49139b86..de810e380 100644 --- a/docs/user-guide/user-guide-jitsi-meet-for-google-calendar/index.html +++ b/docs/user-guide/user-guide-jitsi-meet-for-google-calendar/index.html @@ -4,11 +4,11 @@ Jitsi Meet for Google Calendar | Jitsi Meet - - + +

    Jitsi Meet for Google Calendar

    Welcome to the user guide!

    -

    Check back soon!

    +

    Check back soon!

    \ No newline at end of file diff --git a/docs/user-guide/user-guide-jitsi-meet-on-mobile/index.html b/docs/user-guide/user-guide-jitsi-meet-on-mobile/index.html index 93696c796..c1dd2ae47 100644 --- a/docs/user-guide/user-guide-jitsi-meet-on-mobile/index.html +++ b/docs/user-guide/user-guide-jitsi-meet-on-mobile/index.html @@ -4,8 +4,8 @@ Use Jitsi Meet on Mobile | Jitsi Meet - - + +

    Use Jitsi Meet on Mobile

    When you Join a Jitsi Meeting using a Mobile Phone, there are always options to join the meeting using the Jitsi Meet App or Continue on the web. The most convenient option is to Join using the Jitsi Meet App.

    @@ -14,6 +14,6 @@
  • Download the Jitsi Meet App for Android / iOS / F-Droid
  • Open the app.
  • Join / Create a Meeting.
    • -
    + \ No newline at end of file diff --git a/docs/user-guide/user-guide-join-jitsi-meeting/index.html b/docs/user-guide/user-guide-join-jitsi-meeting/index.html index 929ceb4e6..15c17ca4f 100644 --- a/docs/user-guide/user-guide-join-jitsi-meeting/index.html +++ b/docs/user-guide/user-guide-join-jitsi-meeting/index.html @@ -4,8 +4,8 @@ Join a Jitsi Meeting | Jitsi Meet - - + +

    Join by using a Jitsi link

    @@ -22,6 +22,6 @@
  • (Optional) Adjust the camera and/or microphone settings via the v dropdown menu items.
  • Click on Join meeting.
  • If your meeing is taking place on https://meet.jit.si and you are the first to join you will be asked to authenticate or wait for a moderator. You can authenticate with a Google, Facebook or GitHub account.
    • -
    + \ No newline at end of file diff --git a/docs/user-guide/user-guide-share-a-jitsi-meeting/index.html b/docs/user-guide/user-guide-share-a-jitsi-meeting/index.html index 06b9db1a9..f22c25c4b 100644 --- a/docs/user-guide/user-guide-share-a-jitsi-meeting/index.html +++ b/docs/user-guide/user-guide-share-a-jitsi-meeting/index.html @@ -4,8 +4,8 @@ Share a Jitsi Meeting | Jitsi Meet - - + +

    Share a Jitsi Meeting

    First, you need to Join / Start a Jitsi Meeting.

    @@ -14,6 +14,6 @@
  • Click on the More actions "..." Button.
  • Click on Invite people.
  • Select the desired option using which you want to share the meeting.
    • -
    + \ No newline at end of file diff --git a/docs/user-guide/user-guide-start-a-jitsi-meeting/index.html b/docs/user-guide/user-guide-start-a-jitsi-meeting/index.html index 8843f3c4d..c26f7ccaf 100644 --- a/docs/user-guide/user-guide-start-a-jitsi-meeting/index.html +++ b/docs/user-guide/user-guide-start-a-jitsi-meeting/index.html @@ -4,8 +4,8 @@ Start a Jitsi Meeting | Jitsi Meet - - + +

    Start a Jitsi Meeting

    Desktop or Mobile Browser​

    @@ -43,6 +43,6 @@
  • activated (on some laptops with an integrated microphone or headsets there is a switch to activate / deactivate the microphone),
  • plugged in (only necessary for external microphones),
  • installed (on some old computers the microphone must be installed).
    • -
    +
    \ No newline at end of file diff --git a/help/index.html b/help/index.html index 4447cee22..75d3973d1 100644 --- a/help/index.html +++ b/help/index.html @@ -4,8 +4,8 @@ Getting help | Jitsi Meet - - + +

    Getting help

    diff --git a/index.html b/index.html index 9200bd927..360658379 100644 --- a/index.html +++ b/index.html @@ -4,8 +4,8 @@ Jitsi Meet | Jitsi Meet - - + +

    Jitsi Meet

    State-of-the-art video conferencing you can self-host.

    Get started!

    What is Jitsi?

    [object Object]

    Hey there Fellow Jitster!

    Jitsi Meet is a set of Open Source projects which empower users to deploy secure, scalable and easy to use video conferencing platforms with state-of-the-art video quality and features.

    On This site you'll find documentation for all your Jitsi needs.

    Get started here.

    [object Object]

    Batteries included

    Jitsi Meet supports all common browsers and also mobile devices.

    Our APIs allow developers to easily integrate Jitsi Meet into existing applications, whether those are web based or native mobile apps.

    You can use our freely available instance at meet.jit.si or self-host it yourself using our readily available Debian packages or comprehensive Docker setup.

    [object Object]

    JaaS: Jitsi as a Service

    Looking for configuration flexibility without the complexity of self-hosting and scalability management?

    Look no further than JaaS. 8x8 Jitsi as a Service (JaaS) is an enterprise-ready video meeting platform that allows developers, organizations and businesses to easily build and deploy video solutions. With Jitsi as a Service we now give you all the power of Jitsi running on our global platform so you can focus on building secure and branded video experiences.

    Check JaaS out here.

    diff --git a/search/index.html b/search/index.html index 9f59bce74..b6a4aea0e 100644 --- a/search/index.html +++ b/search/index.html @@ -4,8 +4,8 @@ Search the documentation | Jitsi Meet - - + +

    Search the documentation