Saúl Ibarra Corretgé
720f36c0fd
|
6 years ago | |
---|---|---|
base | 6 years ago | |
base-java | 7 years ago | |
jicofo | 6 years ago | |
jigasi | 6 years ago | |
jvb | 6 years ago | |
prosody | 6 years ago | |
resources | 6 years ago | |
web | 6 years ago | |
.gitignore | 7 years ago | |
LICENSE | 6 years ago | |
Makefile | 6 years ago | |
README.md | 6 years ago | |
docker-compose.yml | 6 years ago | |
env.example | 6 years ago | |
jigasi.yml | 6 years ago |
README.md
Jitsi Meet on Docker
Jitsi is a set of Open Source projects that allows you to easily build and deploy secure videoconferencing solutions.
Jitsi Meet is a fully encrypted, 100% Open Source videoconferencing solution that you can use all day, every day, for free — with no account needed.
This repository contains the necessary tools to run a Jitsi Meet stack on Docker using Docker Compose.
NOTE: This setup is experimental.
Table of contents
Quick start
In order to quickly run Jitsi Meet on a machine running Docker and Docker Compose, follow these steps:
- Create a
.env
file by copying and adjustingenv.example
. - Run
docker-compose up -d
. - Access the web UI at
https://localhost:8443
(orhttp://localhost:8000
for HTTP, or a different port, in case you edited the compose file).
If you want to use jigasi too, first configure your env file with SIP credentials
and then run Docker Compose as follows: docker-compose -f docker-compose.yml -f jigasi.yml up -d
Architecture
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
The diagram shows a typical deployment in a host running Docker, with a separate container (not included in this project) which acts as a reverse proxy and SSL terminator, then passing the traffic to the web container serving Jitsi Meet.
This project separates each of the components above into interlinked containers. To this end, several container images are provided.
Images
- base: Debian stable base image with the S6 Overlay for process control and the Jitsi repositories enabled. All other images are based off 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.
Design considerations
Jitsi Meet uses XMPP for signalling, thus the need for the XMPP server. The setup provided by these containers does not expose the XMPP server to the outside world. Instead, it's kept completely 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 this project.
Configuration
The configuration is performed via environment variables contained in a .env
file. You
can copy the provided env.example
file as a reference.
Variable | Description | Example |
---|---|---|
CONFIG |
Directory where all configuration will be stored | /opt/jitsi-meet-cfg |
TZ |
System Time Zone | Europe/Amsterdam |
HTTP_PORT |
Exposed port for HTTP traffic | 8000 |
HTTPS_PORT |
Exposed port for HTTPS traffic | 8443 |
DOCKER_HOST_ADDRESS |
IP address of the Docker host, needed for LAN environments | 192.168.1.1 |
SIP gateway configuration
If you want to enable the SIP gateway, these options are required:
Variable | Description | Example |
---|---|---|
JIGASI_SIP_URI |
SIP URI for incoming / outgoing calls | test@sip2sip.info |
JIGASI_SIP_PASSWORD |
Password for the specified SIP account | passw0rd |
JIGASI_SIP_SERVER |
SIP server (use the SIP account domain if in doubt) | sip2sip.info |
Authentication
Authentication can be controlled with the environment variables below. If guest access is enabled, unauthenticated users will need to wait until a user authenticates before they can join a room. If guest access is not enabled, every user will need to authenticate before they can join.
Variable | Description | Example |
---|---|---|
ENABLE_AUTH |
Enable authentication | 1 |
ENABLE_GUESTS |
Enable guest access | 1 |
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:
docker-compose exec prosody /bin/bash
Once in the container, run the following command to create a user:
prosodyctl --config /config/prosody.cfg.lua register user meet.jitsi password
Advanced configuration
These configuration options are already set and generally don't need to be changed.
Variable | Description | Default value |
---|---|---|
XMPP_DOMAIN |
Internal XMPP domain | meet.jitsi |
XMPP_AUTH_DOMAIN |
Internal XMPP domain for authenticated services | auth.meet.jitsi |
XMPP_MUC_DOMAIN |
XMPP domain for the MUC | muc.meet.jitsi |
XMPP_INTERNAL_MUC_DOMAIN |
XMPP domain for the internal MUC | internal-muc.meet.jitsi |
JICOFO_COMPONENT_SECRET |
XMPP component password for Jicofo | s3cr37 |
JICOFO_AUTH_USER |
XMPP user for Jicofo client connections | focus |
JICOFO_AUTH_PASSWORD |
XMPP password for Jicofo client connections | passw0rd |
JVB_AUTH_USER |
XMPP user for JVB MUC client connections | jvb |
JVB_AUTH_PASSWORD |
XMPP password for JVB MUC client connections | passw0rd |
JVB_STUN_SERVERS |
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 |
JVB_PORT |
Port for media used by Jitsi Videobridge | 10000 |
JVB_BREWERY_MUC |
MUC name for the JVB pool | jvbbrewery |
JVB_ENABLE_APIS |
Comma separated list of JVB APIs to enable | none |
JIGASI_XMPP_USER |
XMPP user for Jigasi MUC client connections | jigasi |
JIGASI_XMPP_PASSWORD |
XMPP password for Jigasi MUC client connections | passw0rd |
JIGASI_BREWERY_MUC |
MUC name for the Jigasi pool | jigasibrewery |
JIGASI_PORT_MIN |
Minimum port for media used by Jigasi | 20000 |
JIGASI_PORT_MAX |
Maximum port for media used by Jigasi | 20050 |
Running 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 address
of the host running Docker instead of the internal IP address that Docker assigned it, thus making ICE
succeed.
The public IP address is discovered via STUN. STUN servers can be specified with the JVB_STUN_SERVERS
option.
TODO
- Support multiple Jitsi Videobridge containers.
- Support container replicas (where applicable).
- Docker Swarm mode.
- Native Let's Encrypt support.
- More services:
- Jibri.
- TURN server.