From the AWS console, select the region to which you want to deploy your Jitsi server, and make sure it matches where you have the key pair. Go to the EC2 console, and select Instances. Click on Launch InstanceE. In the search box type Ubuntu and hit return.
- I wrote a blog post about deploying Jitsi Meet to AWS with Terraform. Maybe some of you are challenged with the task of providing videoconferencing infrastructure and this will help. I would really appreciate some feedback!:) Terraform: Deploy Jitsi Meet to AWS. Stay at home and healthy!
- This is a starter package of infrastructure automation to deploy your own Jitsi Meet instance with SFUs in multiple geographic regions.
- Do you happen to use the statistics part of jitsi-meet (the colibri thing) The documentation seems to be written in ancient greek to my eyes and all I see is fellow nerds temporarily destroying their instance of jitsi-meet by trying to enable this feature, and I can't risk that at the moment.
In order to quickly run Jitsi Meet on a machine running Docker and Docker Compose,follow these steps:
Download and extract the latest release. DO NOT clone the git repository. See below if you are interested in running test images.
.envfile by copying and adjusting
Set strong passwords in the security section options of
.envfile by running the following bash script
- For linux:
- For Windows:
docker-compose up -d
Access the web UI at
https://localhost:8443(or a different port, in case you edited the compose file).
Note that HTTP (not HTTPS) is also available (on port 8000, by default), but that's e.g. for a reverse proxy setup;direct access via HTTP instead HTTPS leads to WebRTC errors such as Failed to access your microphone/camera: Cannot use microphone/camera for an unknown reason. Cannot read property 'getUserMedia' of undefined or navigator.mediaDevices is undefined.
If you want to use jigasi too, first configure your env file with SIP credentialsand then run Docker Compose as follows:
If you want to enable document sharing via Etherpad, configure it and run Docker Compose asfollows:
If you want to use jibri too, first configure a host as described in JItsi BRoadcasting Infrastructure configuration sectionand then run Docker Compose as follows:
or to use jigasi too:
Testing development builds
Download the latest code:
The code in
master is designed to work with the unstable images. Do not run it with release images.
Build your own images:
Running unstable images
Every day a new 'unstable' image build is uploaded. You can test them by getting the YAML files from the repository and changing
ustable-YYYY-MM-DD for the unstable images of a specific day.
This setup used to have default passwords for internal accounts used across components. In order to make the default setupsecure by default these have been removed and the respective containers won't start without having a password set.
Strong passwords may be generated as follows:
./gen-passwords.shThis will modify your
.env file (a backup is saved in
.env.bak) and set strong passwords for each of therequired options. Passwords are generated using
openssl rand -hex 16 .
DO NOT reuse any of the passwords.
A Jitsi Meet installation can be broken down into the following components:
- A web interface
- An XMPP server
- A conference focus component
- A video router (could be more than one)
- A SIP gateway for audio calls
- A Broadcasting Infrastructure for recording or streaming a conference.
The diagram shows a typical deployment in a host running Docker. This projectseparates each of the components above into interlinked containers. To this end,several container images are provided.
The following external ports must be opened on a firewall:
80/tcpfor Web UI HTTP (really just to redirect, after uncommenting
443/tcpfor Web UI HTTPS
4443/tcpfor RTP media over TCP
10000/udpfor RTP media over UDP
20000-20050/udp for jigasi, in case you choose to deploy that to facilitate SIP access.
E.g. on a CentOS/Fedora server this would be done like this (without SIP access):
- base: Debian stable base image with the S6 Overlay for process control and theJitsi repositories enabled. All other images are based on this one.
- base-java: Same as the above, plus Java (OpenJDK).
- web: Jitsi Meet web UI, served with nginx.
- prosody: Prosody, the XMPP server.
- jicofo: Jicofo, the XMPP focus component.
- jvb: Jitsi Videobridge, the video router.
- jigasi: Jigasi, the SIP (audio only) gateway.
- etherpad: Etherpad, shared document editing addon.
- jibri: Jibri, the broadcasting infrastructure.
Jitsi Meet uses XMPP for signaling, thus the need for the XMPP server. The setup providedby these containers does not expose the XMPP server to the outside world. Instead, it's keptcompletely sealed, and routing of XMPP traffic only happens on a user-defined network.
The XMPP server can be exposed to the outside world, but that's out of the scope of thisproject.
The configuration is performed via environment variables contained in a
.env file. Youcan copy the provided
env.example file as a reference.
|Directory where all configuration will be stored||/opt/jitsi-meet-cfg|
|System Time Zone||Europe/Amsterdam|
|Exposed port for HTTP traffic||8000|
|Exposed port for HTTPS traffic||8443|
|IP address of the Docker host, needed for LAN environments||192.168.1.1|
|Public URL for the web service||https://meet.example.com|
NOTE: The mobile apps won't work with self-signed certificates (the default).See below for instructions on how to obtain a proper certificate with Let's Encrypt.
Let's Encrypt configuration
If you plan on exposing this container setup to the outside traffic directly andwant a proper TLS certificate, you are in luck because Let's Encrypt support isbuilt right in. Here are the required options:
|Enable Let's Encrypt certificate generation||1|
|Domain for which to generate the certificate||meet.example.com|
|E-Mail for receiving important account notifications (mandatory)||[email protected]|
In addition, you will need to set
HTTP_PORT to 80 and
HTTPS_PORT to 443. You might also consider to redirect HTTP traffic to HTTPS by setting
Let's Encrypt rate limit warning: Let's Encrypt has a limit to how many times you can submit a requestfor a new certificate for your domain name. At the time of writing, the current limit is five new (duplicate)certificates for the same domain name every seven days. Because of this, it is recommended that you disable theLet's Encrypt enviroment variables from
.env if you plan on deleting the
.jitsi-meet-cfg folder. Otherwise, youmight want to consider moving the
.jitsi-meet-cfg folder to a different location so you have a safe place to findthe certificate that already Let's Encrypt issued. Or do initial testing with Let's Encrypt disalbed, then re-enableLet's Encrypt once you are done testing.
For more information on Let's Encrypt's rate limits, visit:https://letsencrypt.org/docs/rate-limits/
SIP gateway configuration
If you want to enable the SIP gateway, these options are required:
|SIP URI for incoming / outgoing calls||[email protected]|
|Password for the specified SIP account||passw0rd|
|SIP server (use the SIP account domain if in doubt)||sip2sip.info|
|SIP server port||5060|
Display Dial-In information
|URL to the JSON with all Dial-In numbers||https://meet.example.com/dialin.json|
|URL to the API for checking/generating Dial-In codes||https://jitsi-api.jitsi.net/conferenceMapper|
The JSON with the Dial-In numbers should look like this:
JItsi BRoadcasting Infrastructure (Jibri) configuration
Before running Jibri, you need to set up an ALSA loopback device on the host. This will notwork on a non-Linux host.
For CentOS 7, the module is already compiled with the kernel, so just run:
NOTE: If you are running on AWS you may need to reboot your machine to use the generic kernel insteadof 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:
If you want to enable Jibri these options are required:
|Enable recording conference to local disk||1|
Extended Jibri configuration:
|Internal recorder user for Jibri client connections||recorder|
|Internal recorder password for Jibri client connections||passw0rd|
|Directory for recordings inside Jibri container||/config/recordings|
|The finalizing script. Will run after recording is complete||/config/finalize.sh|
|Internal user for Jibri client connections.||jibri|
|Prefix domain for strip inside Jibri (please see env.example for details)||muc|
|MUC name for the Jibri pool||jibribrewery|
|MUC connection timeout||90|
|Directory for logs inside Jibri container||/config/logs|
For using multiple Jibri instances, you have to select different loopback interfaces for each instance manually.
/home/jibri/.asoundrcinside a docker container.
Default the first instance has:
To setup the second instance, run container with changed
Also you can use numbering id for set loopback interface. The third instance will have
.asoundrc that looks like:
Authentication can be controlled with the environment variables below. If guestaccess is enabled, unauthenticated users will need to wait until a user authenticatesbefore they can join a room. If guest access is not enabled, every user will needto authenticate before they can join.
|Enable guest access||1|
|Select authentication type (internal, jwt or ldap)||internal|
Utc time zone converter excel. The default authentication mode (
internal) uses XMPP credentials to authenticate users.To enable it you have to enable authentication with
ENABLE_AUTH and set
internal,then configure the settings you can see below.
Internal users must be created with the
prosodyctl utility in the
prosody container.In order to do that, first, execute a shell in the corresponding container:
Once in the container, run the following command to create a user:
Note that the command produces no output.
To delete a user, run the following command in the container:
To list all users, run the following command in the container:
Authentication using LDAP
You can use LDAP to authenticate users. To enable it you have to enable authentication with
ldap, then configure the settings you can see below.
|URL for ldap connection||ldaps://ldap.domain.com/|
|LDAP base DN. Can be empty.||DC=example,DC=domain,DC=com|
|LDAP user DN. Do not specify this parameter for the anonymous bind.||CN=binduser,OU=users,DC=example,DC=domain,DC=com|
|LDAP user password. Do not specify this parameter for the anonymous bind.||LdapUserPassw0rd|
|LDAP authentication method.||bind|
|LDAP protocol version||3|
|Enable LDAP TLS||1|
|Set TLS ciphers list to allow||SECURE256:SECURE128|
|Require and verify LDAP server certificate||1|
|Path to CA cert file. Used when server certificate verification is enabled||/etc/ssl/certs/ca-certificates.crt|
|Path to CA certs directory. Used when server certificate verification is enabled.||/etc/ssl/certs|
|Enable START_TLS, requires LDAPv3, URL must be ldap:// not ldaps://||0|
Authentication using JWT tokens
You can use JWT tokens to authenticate users. To enable it you have to enable authentication with
jwt, then configure the settings you can see below.
|Application secret known only to your token||my_jitsi_app_secret|
|(Optional) Set asap_accepted_issuers as a comma separated list||my_web_client,my_app_client|
|(Optional) Set asap_accepted_audiences as a comma separated list||my_server1,my_server2|
|(Optional) Set asap_keyserver to a url where public keys can be found||https://example.com/asap|
|(Optional) Allow anonymous users with no JWT while validating JWTs when provided||0|
|(Optional) Controls which module is used for processing incoming JWTs||token|
|(Optional) Controls which module is used for validating JWTs||token_verification|
This can be tested using the jwt.io debugger. Use the following sample payload:
Shared document editing using Etherpad
You can collaboratively edit a document via Etherpad. In order to enable it, set the config options below and runDocker Compose with the additional config file
Here are the required options:
|Set etherpad-lite URL||http://etherpad.meet.jitsi:9001|
If you want to enable the Transcribing function, these options are required:
|Enable Jigasi transcription in a conference||1|
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.
These configuration options are already set and generally don't need to be changed.
|Internal XMPP domain||meet.jitsi|
|Internal XMPP domain for authenticated services||auth.meet.jitsi|
|Internal XMPP server name xmpp.meet.jitsi||xmpp.meet.jitsi|
|Internal XMPP server URL for BOSH module||http://xmpp.meet.jitsi:5280|
|XMPP domain for the MUC||muc.meet.jitsi|
|XMPP domain for the internal MUC||internal-muc.meet.jitsi|
|XMPP domain for unauthenticated users||guest.meet.jitsi|
|Domain for the jibri recorder||recorder.meet.jitsi|
|Custom Prosody modules for XMPP_DOMAIN (comma separated)||info,alert|
|Custom Prosody modules for MUC component (comma separated)||info,alert|
|Custom Prosody modules for internal MUC component (comma separated)||info,alert|
|Custom prosody modules to load in global configuration (comma separated)||statistics,alert|
|Custom configuration string with escaped newlines||foo = bar;nkey = val;|
|Container restart policy||defaults to |
|XMPP component password for Jicofo||s3cr37|
|XMPP user for Jicofo client connections||focus|
|XMPP password for Jicofo client connections||passw0rd|
|Enable health checks inside Jicofo, allowing the use of the REST api to check Jicofo's status||false|
|XMPP user for JVB MUC client connections||jvb|
|XMPP password for JVB MUC client connections||passw0rd|
|STUN servers used to discover the server's public IP||stun.l.google.com:19302, stun1.l.google.com:19302, stun2.l.google.com:19302|
|UDP port for media used by Jitsi Videobridge||10000|
|Disable the additional harvester which allows video over TCP (rather than just UDP)||true|
|TCP port for media used by Jitsi Videobridge when the TCP Harvester is enabled||4443|
|TCP port advertised by Jitsi Videobridge||4443|
|MUC name for the JVB pool||jvbbrewery|
|Comma separated list of JVB APIs to enable||none|
|XMPP user for Jigasi MUC client connections||jigasi|
|XMPP password for Jigasi MUC client connections||passw0rd|
|MUC name for the Jigasi pool||jigasibrewery|
|Minimum port for media used by Jigasi||20000|
|Maximum port for media used by Jigasi||20050|
|Enable SDES srtp||1|
|Health-check extension. Jigasi will call it for health check||keepalive|
|Interval of health check in milliseconds||300000|
|Jigasi will record audio when transcriber is on||true|
|Jigasi will send a transcribed text to the chat when transcriber is on||true|
|Jigasi will post an URL to the chat with transcription file||true|
|Handle TLS connections outside of this setup||1|
|Redirect HTTP traffic to HTTPS (necessary for Let's Encrypt)||1|
|Controls which logs are output from prosody and associated modules||info|
Running behind NAT or on a LAN environment
If running in a LAN environment (as well as on the public Internet, via NAT) is a requirement,the
DOCKER_HOST_ADDRESS should be set. This way, the Videobridge will advertise the IP addressof the host running Docker instead of the internal IP address that Docker assigned it, thus making ICEsucceed. 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.
The public IP address is discovered via STUN. STUN servers can be specified with the
Jitsi Meet Aws Tutorial
Building your images allows you to edit the configuration files of each image individually, providing more customization for your deployment.
The docker images can be built by running the
make command in the main repository folder. If you need to overwrite existing images from the remote source, use
If you are on the unstable branch, build the images with
FORCE_REBUILD=1 JITSI_RELEASE=unstable make.
You are now able to run
docker-compose up as usual.
Running behind a reverse proxy
By default this setup is using WebSocket connections for 2 core components:
- Sinalling (XMPP)
- Bridge channel (colibri)
Apa Itu Jitsi Meet
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:
With nginx, these routes can be forwarded using the following config snippet:
https://localhost:8443/ is the url of the web service's ingress.
TODO: Add Apache example.
Disabling WebSocket connections
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: