env.example 8.8 KB

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