datenspuren/jitsi-deployment
datenspuren
/
jitsi-deployment
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: update documentation and sample env file

This commit is contained in:
Saúl Ibarra Corretgé 2018-04-28 17:24:50 +02:00
parent 45a6ac1e6d
commit 9aa8fb7551
2 changed files with 32 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -16,10 +16,11 @@ This repository contains the necessary tools to run a Jitsi Meet stack on [Docke
In order to quickly run Jitsi Meet on a machine running Docker and Docker Compose,
follow these steps:
* Build all images by running ``make``.
* Create a ``.env`` file by copying and adjusting ``env.example``.
* Run ``docker-compose up -d``.
* Access the web UI at ``https://localhost:8443`` (or a different port, in case you edited
the compose file yourself.
* Access the web UI at ``https://localhost:8443`` (or ``http://localhost:8000 for HTTP, or
a different port, in case you edited the compose file).
## Architecture
@ -64,29 +65,13 @@ project.
## Configuration
The following variables can be set in the ``.env`` file to customize the installation:
* ``CONFIG=/opt/jitsi-meet-cfg`` - Volume where the configuration of all the containers will
be stored.
* ``DOCKER_HOST_ADDRESS=192.168.1.1`` - IP address of the host running Docker. See the "Running
on a LAN environment" section for more details.
* ``TZ=Europe/Amsterdam`` - System time zone.
* ``XMPP_DOMAIN=meet.jitsi`` - Domain for the XMPP server. The default works fine, since
the server is only accessible via the internal container network.
* ``JVB_COMPONENT_SECRET=s3cr3t`` - Password used by the Jitsi Videobridge when connecting
to the XMPP server as a component.
* ``JVB_STUN_SERVERS=stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302`` - STUN
servers used to harvest the public IP address.
* ``JICOFO_COMPONENT_SECRET=s3cr37`` - Password used by Jicodo when connecting to the XMPP server
as a component.
* ``JICOFO_AUTH_USER=focus`` - Username used by Jocofo when connecting to the XMPP server
as a client.
* ``JICOFO_AUTH_PASSWORD=passw0rd`` - Password used by Jicofo when connecting to the XMPP
server as a client.
The configuration is performed via environment variables contained in a ``.env`` file. You
can copy the provided ``env.example`` file as a reference, which contains documentation
for all options.
### Running on a LAN environment
If running in a LAN environment (as well as on the public Internet, via NAT-es ports) is a requirement,
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.

26
env.example
View File

@ -1,11 +1,35 @@
CONFIG=~/tmp-cfg
# Directory where all configuration will be stored.
CONFIG=~/.jitsi-meet-cfg
# System time zone.
TZ=Europe/Amsterdam
# Internal XMPP domain. You generally don't need to change this.
XMPP_DOMAIN=meet.jitsi
# Internal XMPP domain for authenticated services. You generally don't need to
# change this.
XMPP_AUTH_DOMAIN=auth.meet.jitsi
# XMPP BOSH URL base. You generally don't need to change this.
XMPP_BOSH_URL_BASE=http://xmpp.meet.jitsi:5280
# XMPP component password for Jitsi Videobridge.
JVB_COMPONENT_SECRET=s3cr3t
# STUN servers used to discover the server's public IP.
JVB_STUN_SERVERS=stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302
# XMPP component password for Jicofo.
JICOFO_COMPONENT_SECRET=s3cr37
# XMPP user for Jicofo client connections. You generally don't need to change
# this. NOTE: this option doesn't currently work due to a bug.
JICOFO_AUTH_USER=focus
# XMPP password for Jicofo client connections.
JICOFO_AUTH_PASSWORD=passw0rd
# IP addrss of the Docker host. See the "Running on a LAN environment" section
# in the README.
#DOCKER_HOST_ADDRESS=192.168.1.1