env.example 10 KB

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