env.example 11 KB

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