Переглянути джерело

doc: update example env file and documentation

Saúl Ibarra Corretgé 6 роки тому
батько
коміт
f34ebbb435
2 змінених файлів з 43 додано та 33 видалено
  1. 4 4
      README.md
  2. 39 29
      env.example

+ 4 - 4
README.md

@@ -87,10 +87,6 @@ Variable | Description | Example
 `TZ` | System Time Zone | Europe/Amsterdam
 `HTTP_PORT` | Exposed port for HTTP traffic | 8000
 `HTTPS_PORT` | Exposed port for HTTPS traffic | 8443
-`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
-`JICOFO_COMPONENT_SECRET` | XMPP component password for Jicofo | s3cr37
-`JICOFO_AUTH_PASSWORD` | XMPP password for Jicofo client connections | passw0rd
 `DOCKER_HOST_ADDRESS` | IP addrss of the Docker host, needed for LAN environments | 192.168.1.1
 
 If you want to enable the SIP gateway, these options are required:
@@ -112,8 +108,12 @@ Variable | Description | Default value
 `XMPP_BOSH_URL_BASE` | Base URL for XMPP BOSH connections | http://xmpp.meet.jitsi:5280
 `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
 `JIGASI_XMPP_USER` | XMPP user for Jigasi MUC client connections | jigasi

+ 39 - 29
env.example

@@ -1,3 +1,7 @@
+#
+# Basic configuration options
+#
+
 # Directory where all configuration will be stored.
 CONFIG=~/.jitsi-meet-cfg
 
@@ -10,28 +14,48 @@ HTTPS_PORT=8443
 # System time zone.
 TZ=Europe/Amsterdam
 
-# Internal XMPP domain. You generally don't need to change this.
+# IP address of the Docker host. See the "Running on a LAN environment" section
+# in the README.
+#DOCKER_HOST_ADDRESS=192.168.1.1
+
+
+#
+# Basic Jigasi configuration options (needed for SIP gateway support)
+#
+
+# SIP URI for incoming / outgoing calls
+#JIGASI_SIP_URI=test@sip2sip.info
+
+# Password for the specified SIP account
+#JIGASI_SIP_PASSWORD=passw0rd
+
+# SIP server (use the SIP account domain if in doubt)
+#JIGASI_SIP_SERVER=sip2sip.info
+
+
+#
+# Advanced configuration options (you generally don't need to change these)
+#
+
+# Internal XMPP domain.
 XMPP_DOMAIN=meet.jitsi
 
-# Internal XMPP domain for authenticated services. You generally don't need to
-# change this.
+# Internal XMPP domain for authenticated services.
 XMPP_AUTH_DOMAIN=auth.meet.jitsi
 
-# XMPP BOSH URL base. You generally don't need to change this.
+# XMPP BOSH URL base.
 XMPP_BOSH_URL_BASE=http://xmpp.meet.jitsi:5280
 
-# XMPP domain for the MUC. You generally don't need to change this.
+# XMPP domain for the MUC.
 XMPP_MUC_DOMAIN=muc.meet.jitsi
 
 # XMPP domain for the internal MUC used for jibri, jigasi and jvb pools.
-# You generally don't need to change this.
 XMPP_INTERNAL_MUC_DOMAIN=internal-muc.meet.jitsi
 
-# MUC for the JVB pool. You generally don't need to change this.
+# MUC for the JVB pool.
 JVB_BREWERY_MUC=jvbbrewery
 
-# XMPP user for JVB client connections. You generally don't need to change
-# this.
+# XMPP user for JVB client connections.
 JVB_AUTH_USER=jvb
 
 # XMPP password for JVB client connections.
@@ -46,37 +70,23 @@ JVB_PORT=10000
 # 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.
+# XMPP user for Jicofo client connections. 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
 
-# SIP URI for incoming / outgoing calls
-#JIGASI_SIP_URI=test@sip2sip.info
-
-# Password for the specified SIP account
-#JIGASI_SIP_PASSWORD=passw0rd
-
-# SIP server (use the SIP account domain if in doubt)
-#JIGASI_SIP_SERVER=sip2sip.info
-
-# XMPP user for Jigasi MUC client connections
+# XMPP user for Jigasi MUC client connections.
 JIGASI_XMPP_USER=jigasi
 
-# XMPP password for Jigasi MUC client connections
+# XMPP password for Jigasi MUC client connections.
 JIGASI_XMPP_PASSWORD=passw0rd
 
-# MUC name for the Jigasi pool
+# MUC name for the Jigasi pool.
 JIGASI_BREWERY_MUC=jigasibrewery
 
-# Minimum port for media used by Jigasi
+# Minimum port for media used by Jigasi.
 JIGASI_PORT_MIN=20000
 
-# Maximum port for media used by Jigasi
+# Maximum port for media used by Jigasi.
 JIGASI_PORT_MAX=20050
-
-# IP address of the Docker host. See the "Running on a LAN environment" section
-# in the README.
-#DOCKER_HOST_ADDRESS=192.168.1.1