env.example 8.6 KB

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