env.example 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. # Security
  2. #
  3. # Set these to strong passwords to avoid intruders from impersonating a service account
  4. # The service(s) won't start unless these are specified
  5. # Running ./gen-passwords.sh will update .env with strong passwords
  6. # You may skip the Jigasi and Jibri passwords if you are not using those
  7. # DO NOT reuse passwords
  8. #
  9. # XMPP component password for Jicofo
  10. JICOFO_COMPONENT_SECRET=
  11. # XMPP password for Jicofo client connections
  12. JICOFO_AUTH_PASSWORD=
  13. # XMPP password for JVB client connections
  14. JVB_AUTH_PASSWORD=
  15. # XMPP password for Jigasi MUC client connections
  16. JIGASI_XMPP_PASSWORD=
  17. # XMPP recorder password for Jibri client connections
  18. JIBRI_RECORDER_PASSWORD=
  19. # XMPP password for Jibri client connections
  20. JIBRI_XMPP_PASSWORD=
  21. #
  22. # Basic configuration options
  23. #
  24. # Directory where all configuration will be stored
  25. CONFIG=~/.jitsi-meet-cfg
  26. # Exposed HTTP port
  27. HTTP_PORT=8000
  28. # Exposed HTTPS port
  29. HTTPS_PORT=8443
  30. # System time zone
  31. TZ=Europe/Amsterdam
  32. # Public URL for the web service
  33. #PUBLIC_URL=https://meet.example.com
  34. # IP address of the Docker host
  35. # See the "Running behind NAT or on a LAN environment" section in the README
  36. #DOCKER_HOST_ADDRESS=192.168.1.1
  37. #
  38. # Let's Encrypt configuration
  39. #
  40. # Enable Let's Encrypt certificate generation
  41. #ENABLE_LETSENCRYPT=1
  42. # Domain for which to generate the certificate
  43. #LETSENCRYPT_DOMAIN=meet.example.com
  44. # E-Mail for receiving important account notifications (mandatory)
  45. #LETSENCRYPT_EMAIL=alice@atlanta.net
  46. #
  47. # Etherpad integration (for document sharing)
  48. #
  49. # Set etherpad-lite URL (uncomment to enable)
  50. #ETHERPAD_URL_BASE=http://etherpad.meet.jitsi:9001
  51. #
  52. # Basic Jigasi configuration options (needed for SIP gateway support)
  53. #
  54. # SIP URI for incoming / outgoing calls
  55. #JIGASI_SIP_URI=test@sip2sip.info
  56. # Password for the specified SIP account as a clear text
  57. #JIGASI_SIP_PASSWORD=passw0rd
  58. # SIP server (use the SIP account domain if in doubt)
  59. #JIGASI_SIP_SERVER=sip2sip.info
  60. # SIP server port
  61. #JIGASI_SIP_PORT=5060
  62. # SIP server transport
  63. #JIGASI_SIP_TRANSPORT=UDP
  64. #
  65. # Authentication configuration (see README for details)
  66. #
  67. # Enable authentication
  68. #ENABLE_AUTH=1
  69. # Enable guest access
  70. #ENABLE_GUESTS=1
  71. # Select authentication type: internal, jwt or ldap
  72. #AUTH_TYPE=internal
  73. # JWT authentication
  74. #
  75. # Application identifier
  76. #JWT_APP_ID=my_jitsi_app_id
  77. # Application secret known only to your token
  78. #JWT_APP_SECRET=my_jitsi_app_secret
  79. # (Optional) Set asap_accepted_issuers as a comma separated list
  80. #JWT_ACCEPTED_ISSUERS=my_web_client,my_app_client
  81. # (Optional) Set asap_accepted_audiences as a comma separated list
  82. #JWT_ACCEPTED_AUDIENCES=my_server1,my_server2
  83. # LDAP authentication (for more information see the Cyrus SASL saslauthd.conf man page)
  84. #
  85. # LDAP url for connection
  86. #LDAP_URL=ldaps://ldap.domain.com/
  87. # LDAP base DN. Can be empty
  88. #LDAP_BASE=DC=example,DC=domain,DC=com
  89. # LDAP user DN. Do not specify this parameter for the anonymous bind
  90. #LDAP_BINDDN=CN=binduser,OU=users,DC=example,DC=domain,DC=com
  91. # LDAP user password. Do not specify this parameter for the anonymous bind
  92. #LDAP_BINDPW=LdapUserPassw0rd
  93. # LDAP filter. Tokens example:
  94. # %1-9 - if the input key is user@mail.domain.com, then %1 is com, %2 is domain and %3 is mail
  95. # %s - %s is replaced by the complete service string
  96. # %r - %r is replaced by the complete realm string
  97. #LDAP_FILTER=(sAMAccountName=%u)
  98. # LDAP authentication method
  99. #LDAP_AUTH_METHOD=bind
  100. # LDAP version
  101. #LDAP_VERSION=3
  102. # LDAP TLS using
  103. #LDAP_USE_TLS=1
  104. # List of SSL/TLS ciphers to allow
  105. #LDAP_TLS_CIPHERS=SECURE256:SECURE128:!AES-128-CBC:!ARCFOUR-128:!CAMELLIA-128-CBC:!3DES-CBC:!CAMELLIA-128-CBC
  106. # Require and verify server certificate
  107. #LDAP_TLS_CHECK_PEER=1
  108. # Path to CA cert file. Used when server sertificate verify is enabled
  109. #LDAP_TLS_CACERT_FILE=/etc/ssl/certs/ca-certificates.crt
  110. # Path to CA certs directory. Used when server sertificate verify is enabled
  111. #LDAP_TLS_CACERT_DIR=/etc/ssl/certs
  112. # Wether to use starttls, implies LDAPv3 and requires ldap:// instead of ldaps://
  113. # LDAP_START_TLS=1
  114. #
  115. # Advanced configuration options (you generally don't need to change these)
  116. #
  117. # Internal XMPP domain
  118. XMPP_DOMAIN=meet.jitsi
  119. # Internal XMPP server
  120. XMPP_SERVER=xmpp.meet.jitsi
  121. # Internal XMPP server URL
  122. XMPP_BOSH_URL_BASE=http://xmpp.meet.jitsi:5280
  123. # Internal XMPP domain for authenticated services
  124. XMPP_AUTH_DOMAIN=auth.meet.jitsi
  125. # XMPP domain for the MUC
  126. XMPP_MUC_DOMAIN=muc.meet.jitsi
  127. # XMPP domain for the internal MUC used for jibri, jigasi and jvb pools
  128. XMPP_INTERNAL_MUC_DOMAIN=internal-muc.meet.jitsi
  129. # XMPP domain for unauthenticated users
  130. XMPP_GUEST_DOMAIN=guest.meet.jitsi
  131. # Custom Prosody modules for XMPP_DOMAIN (comma separated)
  132. XMPP_MODULES=
  133. # Custom Prosody modules for MUC component (comma separated)
  134. XMPP_MUC_MODULES=
  135. # Custom Prosody modules for internal MUC component (comma separated)
  136. XMPP_INTERNAL_MUC_MODULES=
  137. # MUC for the JVB pool
  138. JVB_BREWERY_MUC=jvbbrewery
  139. # XMPP user for JVB client connections
  140. JVB_AUTH_USER=jvb
  141. # STUN servers used to discover the server's public IP
  142. JVB_STUN_SERVERS=meet-jit-si-turnrelay.jitsi.net:443
  143. # Media port for the Jitsi Videobridge
  144. JVB_PORT=10000
  145. # TCP Fallback for Jitsi Videobridge for when UDP isn't available
  146. JVB_TCP_HARVESTER_DISABLED=true
  147. JVB_TCP_PORT=4443
  148. # A comma separated list of APIs to enable when the JVB is started [default: none]
  149. # See https://github.com/jitsi/jitsi-videobridge/blob/master/doc/rest.md for more information
  150. #JVB_ENABLE_APIS=rest,colibri
  151. # XMPP user for Jicofo client connections.
  152. # NOTE: this option doesn't currently work due to a bug
  153. JICOFO_AUTH_USER=focus
  154. # Base URL of Jicofo's reservation REST API
  155. #JICOFO_RESERVATION_REST_BASE_URL=http://reservation.example.com
  156. # XMPP user for Jigasi MUC client connections
  157. JIGASI_XMPP_USER=jigasi
  158. # MUC name for the Jigasi pool
  159. JIGASI_BREWERY_MUC=jigasibrewery
  160. # Minimum port for media used by Jigasi
  161. JIGASI_PORT_MIN=20000
  162. # Maximum port for media used by Jigasi
  163. JIGASI_PORT_MAX=20050
  164. # Enable SDES srtp
  165. #JIGASI_ENABLE_SDES_SRTP=1
  166. # Keepalive method
  167. #JIGASI_SIP_KEEP_ALIVE_METHOD=OPTIONS
  168. # Health-check extension
  169. #JIGASI_HEALTH_CHECK_SIP_URI=keepalive
  170. # Health-check interval
  171. #JIGASI_HEALTH_CHECK_INTERVAL=300000
  172. #
  173. # Enable Jigasi transcription
  174. #ENABLE_TRANSCRIPTIONS=1
  175. # Jigasi will record audio when transcriber is on [default: false]
  176. #JIGASI_TRANSCRIBER_RECORD_AUDIO=true
  177. # Jigasi will send transcribed text to the chat when transcriber is on [default: false]
  178. #JIGASI_TRANSCRIBER_SEND_TXT=true
  179. # Jigasi will post an url to the chat with transcription file [default: false]
  180. #JIGASI_TRANSCRIBER_ADVERTISE_URL=true
  181. # Credentials for connect to Cloud Google API from Jigasi
  182. # Please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol
  183. # section "Before you begin" paragraph 1 to 5
  184. # Copy the values from the json to the related env vars
  185. #GC_PROJECT_ID=
  186. #GC_PRIVATE_KEY_ID=
  187. #GC_PRIVATE_KEY=
  188. #GC_CLIENT_EMAIL=
  189. #GC_CLIENT_ID=
  190. #GC_CLIENT_CERT_URL=
  191. # Enable recording
  192. #ENABLE_RECORDING=1
  193. # XMPP domain for the jibri recorder
  194. XMPP_RECORDER_DOMAIN=recorder.meet.jitsi
  195. # XMPP recorder user for Jibri client connections
  196. JIBRI_RECORDER_USER=recorder
  197. # Directory for recordings inside Jibri container
  198. JIBRI_RECORDING_DIR=/config/recordings
  199. # The finalizing script. Will run after recording is complete
  200. JIBRI_FINALIZE_RECORDING_SCRIPT_PATH=/config/finalize.sh
  201. # XMPP user for Jibri client connections
  202. JIBRI_XMPP_USER=jibri
  203. # MUC name for the Jibri pool
  204. JIBRI_BREWERY_MUC=jibribrewery
  205. # MUC connection timeout
  206. JIBRI_PENDING_TIMEOUT=90
  207. # When jibri gets a request to start a service for a room, the room
  208. # jid will look like: roomName@optional.prefixes.subdomain.xmpp_domain
  209. # We'll build the url for the call by transforming that into:
  210. # https://xmpp_domain/subdomain/roomName
  211. # So if there are any prefixes in the jid (like jitsi meet, which
  212. # has its participants join a muc at conference.xmpp_domain) then
  213. # list that prefix here so it can be stripped out to generate
  214. # the call url correctly
  215. JIBRI_STRIP_DOMAIN_JID=muc
  216. # Directory for logs inside Jibri container
  217. JIBRI_LOGS_DIR=/config/logs
  218. # Disable HTTPS: handle TLS connections outside of this setup
  219. #DISABLE_HTTPS=1
  220. # Redirect HTTP traffic to HTTPS
  221. # Necessary for Let's Encrypt, relies on standard HTTPS port (443)
  222. #ENABLE_HTTP_REDIRECT=1