prosody.cfg.lua 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433
  1. {{ $C2S_REQUIRE_ENCRYPTION := .Env.PROSODY_C2S_REQUIRE_ENCRYPTION | default "1" | toBool -}}
  2. {{ $DISABLE_C2S_LIMIT := .Env.PROSODY_DISABLE_C2S_LIMIT | default "0" | toBool -}}
  3. {{ $DISABLE_S2S_LIMIT := .Env.PROSODY_DISABLE_S2S_LIMIT | default "0" | toBool -}}
  4. {{ $ENABLE_AUTH := .Env.ENABLE_AUTH | default "0" | toBool -}}
  5. {{ $ENABLE_GUEST_DOMAIN := and $ENABLE_AUTH (.Env.ENABLE_GUESTS | default "0" | toBool) -}}
  6. {{ $ENABLE_IPV6 := .Env.ENABLE_IPV6 | default "true" | toBool -}}
  7. {{ $ENABLE_RECORDING := .Env.ENABLE_RECORDING | default "0" | toBool -}}
  8. {{ $ENABLE_TRANSCRIPTIONS := .Env.ENABLE_TRANSCRIPTIONS | default "0" | toBool -}}
  9. {{ $ENABLE_VISITORS := .Env.ENABLE_VISITORS | default "0" | toBool -}}
  10. {{ $ENABLE_S2S := or $ENABLE_VISITORS ( .Env.PROSODY_ENABLE_S2S | default "0" | toBool ) }}
  11. {{ $GC_TYPE := .Env.GC_TYPE | default "incremental" -}}
  12. {{ $GC_INC_TH := .Env.GC_INC_TH | default 400 -}}
  13. {{ $GC_INC_SPEED := .Env.GC_INC_SPEED | default 250 -}}
  14. {{ $GC_INC_STEP_SIZE := .Env.GC_INC_STEP_SIZE | default 13 -}}
  15. {{ $GC_GEN_MIN_TH := .Env.GC_GEN_MIN_TH | default 20 -}}
  16. {{ $GC_GEN_MAX_TH := .Env.GC_GEN_MAX_TH | default 100 -}}
  17. {{ $LOG_LEVEL := .Env.LOG_LEVEL | default "info" }}
  18. {{ $PROSODY_C2S_LIMIT := .Env.PROSODY_C2S_LIMIT | default "10kb/s" -}}
  19. {{ $PROSODY_METRICS_ALLOWED_CIDR := .Env.PROSODY_METRICS_ALLOWED_CIDR | default "172.16.0.0/12" -}}
  20. {{ $PROSODY_HTTP_PORT := .Env.PROSODY_HTTP_PORT | default "5280" -}}
  21. {{ $PROSODY_ENABLE_METRICS := .Env.PROSODY_ENABLE_METRICS | default "false" | toBool -}}
  22. {{ $PROSODY_ENABLE_STANZA_COUNTS := .Env.PROSODY_ENABLE_STANZA_COUNTS | default "false" | toBool -}}
  23. {{ $PROSODY_ADMINS := .Env.PROSODY_ADMINS | default "" -}}
  24. {{ $PROSODY_ADMIN_LIST := splitList "," $PROSODY_ADMINS | compact -}}
  25. {{ $PROSODY_MODE := .Env.PROSODY_MODE | default "client" -}}
  26. {{ $TRUSTED_PROXIES := .Env.PROSODY_TRUSTED_PROXIES | default "127.0.0.1,::1" -}}
  27. {{ $TRUSTED_PROXY_LIST := splitList "," $TRUSTED_PROXIES | compact -}}
  28. {{ $PROSODY_S2S_LIMIT := .Env.PROSODY_S2S_LIMIT | default "30kb/s" -}}
  29. {{ $S2S_PORT := .Env.PROSODY_S2S_PORT | default "5269" }}
  30. {{ $STUN_HOST := .Env.STUN_HOST | default "" -}}
  31. {{ $STUN_PORT := .Env.STUN_PORT | default "443" -}}
  32. {{ $TURNS_HOST := .Env.TURNS_HOST | default "" -}}
  33. {{ $TURNS_HOSTS := splitList "," $TURNS_HOST | compact -}}
  34. {{ $TURNS_PORT := .Env.TURNS_PORT | default "443" -}}
  35. {{ $TURN_HOST := .Env.TURN_HOST | default "" -}}
  36. {{ $TURN_HOSTS := splitList "," $TURN_HOST | compact -}}
  37. {{ $TURN_PORT := .Env.TURN_PORT | default "443" -}}
  38. {{ $TURN_TRANSPORT := .Env.TURN_TRANSPORT | default "tcp" -}}
  39. {{ $TURN_TRANSPORTS := splitList "," $TURN_TRANSPORT | compact -}}
  40. {{ $TURN_TTL := .Env.TURN_TTL | default "86400" -}}
  41. {{ $VISITORS_MUC_PREFIX := .Env.PROSODY_VISITORS_MUC_PREFIX | default "muc" -}}
  42. {{ $VISITORS_XMPP_DOMAIN := .Env.VISITORS_XMPP_DOMAIN | default "meet.jitsi" -}}
  43. {{ $VISITORS_XMPP_SERVER := .Env.VISITORS_XMPP_SERVER | default "" -}}
  44. {{ $VISITORS_XMPP_SERVERS := splitList "," $VISITORS_XMPP_SERVER | compact -}}
  45. {{ $VISITORS_XMPP_PORT := .Env.VISITORS_XMPP_PORT | default 52220 }}
  46. {{ $XMPP_DOMAIN := .Env.XMPP_DOMAIN | default "meet.jitsi" -}}
  47. {{ $XMPP_GUEST_DOMAIN := .Env.XMPP_GUEST_DOMAIN | default "guest.meet.jitsi" -}}
  48. {{ $XMPP_MUC_DOMAIN := .Env.XMPP_MUC_DOMAIN | default "muc.meet.jitsi" -}}
  49. {{ $XMPP_PORT := .Env.XMPP_PORT | default "5222" -}}
  50. {{ $XMPP_HIDDEN_DOMAIN := .Env.XMPP_HIDDEN_DOMAIN | default "hidden.meet.jitsi" -}}
  51. -- Prosody Example Configuration File
  52. --
  53. -- Information on configuring Prosody can be found on our
  54. -- website at http://prosody.im/doc/configure
  55. --
  56. -- Tip: You can check that the syntax of this file is correct
  57. -- when you have finished by running: luac -p prosody.cfg.lua
  58. -- If there are any errors, it will let you know what and where
  59. -- they are, otherwise it will keep quiet.
  60. --
  61. -- The only thing left to do is rename this file to remove the .dist ending, and fill in the
  62. -- blanks. Good luck, and happy Jabbering!
  63. ---------- Server-wide settings ----------
  64. -- Settings in this section apply to the whole server and are the default settings
  65. -- for any virtual hosts
  66. -- This is a (by default, empty) list of accounts that are admins
  67. -- for the server. Note that you must create the accounts separately
  68. -- (see http://prosody.im/doc/creating_accounts for info)
  69. -- Example: admins = { "user1@example.com", "user2@example.net" }
  70. admins = { {{ if .Env.PROSODY_ADMINS }}{{ range $index, $element := $PROSODY_ADMIN_LIST -}}{{ if $index }}, {{ end }}"{{ $element }}"{{ end }}{{ end }} }
  71. component_admins_as_room_owners = true
  72. -- Enable use of libevent for better performance under high load
  73. -- For more information see: http://prosody.im/doc/libevent
  74. --use_libevent = true;
  75. -- This is the list of modules Prosody will load on startup.
  76. -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
  77. -- Documentation on modules can be found at: http://prosody.im/doc/modules
  78. modules_enabled = {
  79. -- Generally required
  80. "roster"; -- Allow users to have a roster. Recommended ;)
  81. "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
  82. "tls"; -- Add support for secure TLS on c2s/s2s connections
  83. "disco"; -- Service discovery
  84. {{- if eq $PROSODY_MODE "client" }}
  85. -- Not essential, but recommended
  86. "private"; -- Private XML storage (for room bookmarks, etc.)
  87. "limits"; -- Enable bandwidth limiting for XMPP connections
  88. -- These are commented by default as they have a performance impact
  89. --"privacy"; -- Support privacy lists
  90. --"compression"; -- Stream compression (Debian: requires lua-zlib module to work)
  91. -- Admin interfaces
  92. -- "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
  93. --"admin_telnet"; -- Opens telnet console interface on localhost port 5582
  94. -- Nice to have
  95. "version"; -- Replies to server version requests
  96. {{- end }}
  97. "ping"; -- Replies to XMPP pings with pongs
  98. {{- if eq $PROSODY_MODE "visitors" }}
  99. "limits"; -- Enable bandwidth limiting for XMPP connections
  100. {{- end }}
  101. -- HTTP modules
  102. --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
  103. --"http_files"; -- Serve static files from a directory over HTTP
  104. -- Other specific functionality
  105. "posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
  106. --"groups"; -- Shared roster support
  107. --"announce"; -- Send announcement to all online users
  108. --"welcome"; -- Welcome users who register accounts
  109. --"watchregistrations"; -- Alert admins of registrations
  110. --"motd"; -- Send a message to users when they log in
  111. --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
  112. "http_health";
  113. {{ if eq $PROSODY_MODE "brewery" -}}
  114. "firewall"; -- Enable firewalling
  115. "secure_interfaces";
  116. {{ end -}}
  117. {{ if $ENABLE_S2S -}}
  118. "s2s_bidi";
  119. "certs_s2soutinjection";
  120. "s2sout_override";
  121. "s2s_whitelist";
  122. {{ end -}}
  123. {{- if or .Env.TURN_HOST .Env.TURNS_HOST }}
  124. "external_services";
  125. {{- end }}
  126. {{ if $PROSODY_ENABLE_METRICS }}
  127. -- metrics collection functionality
  128. "http_openmetrics";
  129. {{ end -}}
  130. {{ if $PROSODY_ENABLE_STANZA_COUNTS }}
  131. -- Stanza count metrics for monitoring
  132. "measure_stanza_counts";
  133. {{ end -}}
  134. {{ if .Env.GLOBAL_MODULES }}
  135. "{{ join "\";\n\"" (splitList "," .Env.GLOBAL_MODULES | compact) }}";
  136. {{ end }}
  137. };
  138. component_ports = { }
  139. https_ports = { }
  140. trusted_proxies = {
  141. {{ range $index, $proxy := $TRUSTED_PROXY_LIST }}
  142. "{{ $proxy }}";
  143. {{ end }}
  144. }
  145. {{ if eq $PROSODY_MODE "brewery" -}}
  146. firewall_scripts = {
  147. "/config/rules.d/jvb_muc_presence_filter.pfw";
  148. };
  149. {{ end -}}
  150. -- These modules are auto-loaded, but should you want
  151. -- to disable them then uncomment them here:
  152. modules_disabled = {
  153. "offline"; -- Store offline messages
  154. "register";
  155. -- "c2s"; -- Handle client connections
  156. {{ if not $ENABLE_S2S -}}
  157. "s2s"; -- Handle server-to-server connections
  158. {{ end -}}
  159. };
  160. -- Disable account creation by default, for security
  161. -- For more information see http://prosody.im/doc/creating_accounts
  162. allow_registration = false;
  163. {{ if and (ne $PROSODY_MODE "brewery") (or (not $DISABLE_C2S_LIMIT) (not $DISABLE_S2S_LIMIT)) -}}
  164. -- Enable rate limits for incoming connections
  165. limits = {
  166. {{ if not $DISABLE_C2S_LIMIT }}
  167. -- Limit incoming client connections
  168. c2s = {
  169. rate = "{{ $PROSODY_C2S_LIMIT }}";
  170. };
  171. {{ end }}
  172. {{ if not $DISABLE_S2S_LIMIT }}
  173. -- Limit incoming server connections
  174. s2sin = {
  175. rate = "{{ $PROSODY_S2S_LIMIT }}";
  176. };
  177. {{ end }}
  178. }
  179. {{ end -}}
  180. --Prosody garbage collector settings
  181. --For more information see https://prosody.im/doc/advanced_gc
  182. {{ if eq $GC_TYPE "generational" }}
  183. gc = {
  184. mode = "generational";
  185. minor_threshold = {{ $GC_GEN_MIN_TH }};
  186. major_threshold = {{ $GC_GEN_MAX_TH }};
  187. }
  188. {{ else }}
  189. gc = {
  190. mode = "incremental";
  191. threshold = {{ $GC_INC_TH }};
  192. speed = {{ $GC_INC_SPEED }};
  193. step_size = {{ $GC_INC_STEP_SIZE }};
  194. }
  195. {{ end }}
  196. pidfile = "/config/data/prosody.pid";
  197. -- Force clients to use encrypted connections? This option will
  198. -- prevent clients from authenticating unless they are using encryption.
  199. c2s_require_encryption = {{ $C2S_REQUIRE_ENCRYPTION }};
  200. -- set c2s port
  201. c2s_ports = { {{ $XMPP_PORT }} } -- Listen on specific c2s port
  202. {{ if $ENABLE_IPV6 }}
  203. c2s_interfaces = { "*", "::" }
  204. {{ else }}
  205. c2s_interfaces = { "*" }
  206. {{ end }}
  207. {{ if $ENABLE_S2S -}}
  208. -- set s2s port
  209. s2s_ports = { {{ $S2S_PORT }} } -- Listen on specific s2s port
  210. {{ if eq $PROSODY_MODE "visitors" -}}
  211. s2s_whitelist = {
  212. {{- if $ENABLE_VISITORS }}
  213. '{{ $XMPP_MUC_DOMAIN }}'; -- needed for visitors to send messages to main room
  214. 'visitors.{{ $XMPP_DOMAIN }}'; -- needed for sending promotion request to visitors.{{ $XMPP_DOMAIN }} component
  215. '{{ $XMPP_DOMAIN }}'; -- unavailable presences back to main room
  216. {{- end }}
  217. {{- if $ENABLE_GUEST_DOMAIN }}
  218. '{{ $XMPP_GUEST_DOMAIN }}';
  219. {{- end }}
  220. {{ if or $ENABLE_RECORDING $ENABLE_TRANSCRIPTIONS -}}
  221. '{{ $XMPP_HIDDEN_DOMAIN }}';
  222. {{- end }}
  223. {{- if .Env.PROSODY_VISITORS_S2S_VHOSTS }}
  224. '{{ join "';\n '" (splitList "," .Env.PROSODY_VISITORS_S2S_VHOSTS | compact) }}';
  225. {{- end }}
  226. }
  227. {{ end -}}
  228. {{ end -}}
  229. {{ if $ENABLE_VISITORS -}}
  230. {{ if $.Env.VISITORS_XMPP_SERVER -}}
  231. s2sout_override = {
  232. {{ range $index, $element := $VISITORS_XMPP_SERVERS -}}
  233. {{ $SERVER := splitn ":" 2 $element }}
  234. {{ $DEFAULT_PORT := add $VISITORS_XMPP_PORT $index }}
  235. ["{{ $VISITORS_MUC_PREFIX }}.v{{ $index }}.{{ $VISITORS_XMPP_DOMAIN }}"] = "tcp://{{ $SERVER._0 }}:{{ $SERVER._1 | default $DEFAULT_PORT }}";
  236. ["v{{ $index }}.{{ $VISITORS_XMPP_DOMAIN }}"] = "tcp://{{ $SERVER._0 }}:{{ $SERVER._1 | default $DEFAULT_PORT }}";
  237. {{ end -}}
  238. };
  239. {{ if ne $PROSODY_MODE "visitors" -}}
  240. s2s_whitelist = {
  241. {{ range $index, $element := $VISITORS_XMPP_SERVERS -}}
  242. "{{ $VISITORS_MUC_PREFIX }}.v{{ $index }}.{{ $VISITORS_XMPP_DOMAIN }}";
  243. {{ end -}}
  244. };
  245. {{ end -}}
  246. {{ end -}}
  247. {{ end -}}
  248. -- Force certificate authentication for server-to-server connections?
  249. -- This provides ideal security, but requires servers you communicate
  250. -- with to support encryption AND present valid, trusted certificates.
  251. -- NOTE: Your version of LuaSec must support certificate verification!
  252. -- For more information see http://prosody.im/doc/s2s#security
  253. s2s_secure_auth = false
  254. -- Many servers don't support encryption or have invalid or self-signed
  255. -- certificates. You can list domains here that will not be required to
  256. -- authenticate using certificates. They will be authenticated using DNS.
  257. --s2s_insecure_domains = { "gmail.com" }
  258. -- Even if you leave s2s_secure_auth disabled, you can still require valid
  259. -- certificates for some domains by specifying a list here.
  260. --s2s_secure_domains = { "jabber.org" }
  261. -- Select the authentication backend to use. The 'internal' providers
  262. -- use Prosody's configured data storage to store the authentication data.
  263. -- To allow Prosody to offer secure authentication mechanisms to clients, the
  264. -- default provider stores passwords in plaintext. If you do not trust your
  265. -- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed
  266. -- for information about using the hashed backend.
  267. authentication = "internal_hashed"
  268. -- Select the storage backend to use. By default Prosody uses flat files
  269. -- in its configured data directory, but it also supports more backends
  270. -- through modules. An "sql" backend is included by default, but requires
  271. -- additional dependencies. See http://prosody.im/doc/storage for more info.
  272. --storage = "sql" -- Default is "internal" (Debian: "sql" requires one of the
  273. -- lua-dbi-sqlite3, lua-dbi-mysql or lua-dbi-postgresql packages to work)
  274. -- For the "sql" backend, you can uncomment *one* of the below to configure:
  275. --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
  276. --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
  277. --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
  278. -- Logging configuration
  279. -- For advanced logging see http://prosody.im/doc/logging
  280. --
  281. -- Debian:
  282. -- Logs info and higher to /var/log
  283. -- Logs errors to syslog also
  284. log = {
  285. { levels = {min = "{{ $LOG_LEVEL }}"}, timestamps = "%Y-%m-%d %X", to = "console"};
  286. {{ if .Env.PROSODY_LOG_CONFIG }}
  287. {{ join "\n" (splitList "\\n" .Env.PROSODY_LOG_CONFIG | compact) }}
  288. {{ end }}
  289. }
  290. {{ if $PROSODY_ENABLE_METRICS }}
  291. -- Statistics Provider configuration
  292. statistics = "internal"
  293. statistics_interval = "manual"
  294. openmetrics_allow_cidr = "{{ $PROSODY_METRICS_ALLOWED_CIDR }}"
  295. {{ end }}
  296. {{ if .Env.TURN_CREDENTIALS -}}
  297. external_service_secret = "{{.Env.TURN_CREDENTIALS}}";
  298. {{- end }}
  299. {{ if or .Env.STUN_HOST .Env.TURN_HOST .Env.TURNS_HOST -}}
  300. external_services = {
  301. {{- if $STUN_HOST }}
  302. { type = "stun", host = "{{ $STUN_HOST }}", port = {{ $STUN_PORT }}, transport = "udp" }
  303. {{- end }}
  304. {{- if $TURN_HOST -}}
  305. {{- range $idx1, $host := $TURN_HOSTS -}}
  306. {{- range $idx2, $transport := $TURN_TRANSPORTS -}}
  307. {{- if or $STUN_HOST $idx1 $idx2 -}},{{- end }}
  308. {
  309. type = "turn",
  310. host = "{{ $host }}",
  311. port = {{ $TURN_PORT }},
  312. transport = "{{ $transport }}",
  313. ttl = {{ $TURN_TTL }},
  314. {{ if $.Env.TURN_CREDENTIALS -}}
  315. secret = true,
  316. algorithm = "turn",
  317. {{- end }}
  318. {{ if $.Env.TURN_USERNAME -}}
  319. username = "{{$.Env.TURN_USERNAME}}",
  320. {{- end }}
  321. {{ if $.Env.TURN_PASSWORD -}}
  322. password = "{{$.Env.TURN_PASSWORD}}",
  323. {{- end }}
  324. }
  325. {{- end -}}
  326. {{- end -}}
  327. {{- end -}}
  328. {{- if $TURNS_HOST -}}
  329. {{- range $idx, $host := $TURNS_HOSTS -}}
  330. {{- if or $STUN_HOST $TURN_HOST $idx -}},{{- end }}
  331. {
  332. type = "turns",
  333. host = "{{ $host }}",
  334. port = {{ $TURNS_PORT }},
  335. transport = "tcp",
  336. ttl = {{ $TURN_TTL }},
  337. {{ if $.Env.TURN_CREDENTIALS -}}
  338. secret = true,
  339. algorithm = "turn",
  340. {{- end }}
  341. {{ if $.Env.TURN_USERNAME -}}
  342. username = "{{$.Env.TURN_USERNAME}}",
  343. {{- end }}
  344. {{ if $.Env.TURN_PASSWORD -}}
  345. password = "{{$.Env.TURN_PASSWORD}}",
  346. {{- end }}
  347. }
  348. {{- end }}
  349. {{- end }}
  350. };
  351. {{- end }}
  352. {{ if .Env.GLOBAL_CONFIG }}
  353. {{ join "\n" (splitList "\\n" .Env.GLOBAL_CONFIG | compact) }}
  354. {{ end }}
  355. -- Enable use of native prosody 0.11 support for epoll over select
  356. network_backend = "epoll";
  357. -- Set the TCP backlog to 511 since the kernel rounds it up to the next power of 2: 512.
  358. network_settings = {
  359. tcp_backlog = 511;
  360. }
  361. unbound = {
  362. resolvconf = true
  363. }
  364. http_ports = { {{ $PROSODY_HTTP_PORT }} }
  365. {{ if $ENABLE_IPV6 }}
  366. http_interfaces = { "*", "::" }
  367. {{ else }}
  368. http_interfaces = { "*" }
  369. {{ end }}
  370. data_path = "/config/data"
  371. Include "conf.d/*.cfg.lua"