prosody.cfg.lua.dist

   1 -- Prosody Example Configuration File
   2 --
   3 -- Information on configuring Prosody can be found on our
   4 -- website at https://prosody.im/doc/configure
   5 --
   6 -- Tip: You can check that the syntax of this file is correct
   7 -- when you have finished by running: prosodyctl check config
   8 -- If there are any errors, it will let you know what and where
   9 -- they are, otherwise it will keep quiet.
  10 --
  11 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the
  12 -- blanks. Good luck, and happy Jabbering!
  13
  14
  15 ---------- Server-wide settings ----------
  16 -- Settings in this section apply to the whole server and are the default settings
  17 -- for any virtual hosts
  18
  19 -- This is a (by default, empty) list of accounts that are admins
  20 -- for the server. Note that you must create the accounts separately
  21 -- (see https://prosody.im/doc/creating_accounts for info)
  22 -- Example: admins = { "user1@example.com", "user2@example.net" }
  23 admins = { }
  24
  25 -- Enable use of libevent for better performance under high load
  26 -- For more information see: https://prosody.im/doc/libevent
  27 --use_libevent = true
  28
  29 -- This is the list of modules Prosody will load on startup.
  30 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
  31 -- Documentation on modules can be found at: https://prosody.im/doc/modules
  32 modules_enabled = {
  33
  34         -- Generally required
  35                 "roster"; -- Allow users to have a roster. Recommended ;)
  36                 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
  37                 "tls"; -- Add support for secure TLS on c2s/s2s connections
  38                 "dialback"; -- s2s dialback support
  39                 "disco"; -- Service discovery
  40
  41         -- Not essential, but recommended
  42                 "private"; -- Private XML storage (for room bookmarks, etc.)
  43                 "vcard"; -- Allow users to set vCards
  44
  45         -- These are commented by default as they have a performance impact
  46                 --"blocklist"; -- Allow users to block communications with other users
  47                 --"compression"; -- Stream compression
  48
  49         -- Nice to have
  50                 "version"; -- Replies to server version requests
  51                 "uptime"; -- Report how long server has been running
  52                 "time"; -- Let others know the time here on this server
  53                 "ping"; -- Replies to XMPP pings with pongs
  54                 "pep"; -- Enables users to publish their mood, activity, playing music and more
  55                 "register"; -- Allow users to register on this server using a client and change passwords
  56
  57         -- Admin interfaces
  58                 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
  59                 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582
  60
  61         -- HTTP modules
  62                 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
  63                 --"http_files"; -- Serve static files from a directory over HTTP
  64
  65         -- Other specific functionality
  66                 --"groups"; -- Shared roster support
  67                 --"announce"; -- Send announcement to all online users
  68                 --"welcome"; -- Welcome users who register accounts
  69                 --"watchregistrations"; -- Alert admins of registrations
  70                 --"motd"; -- Send a message to users when they log in
  71                 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
  72 }
  73
  74 -- These modules are auto-loaded, but should you want
  75 -- to disable them then uncomment them here:
  76 modules_disabled = {
  77         -- "offline"; -- Store offline messages
  78         -- "c2s"; -- Handle client connections
  79         -- "s2s"; -- Handle server-to-server connections
  80         -- "posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
  81 }
  82
  83 -- Disable account creation by default, for security
  84 -- For more information see https://prosody.im/doc/creating_accounts
  85 allow_registration = false
  86
  87 -- These are the SSL/TLS-related settings. If you don't want
  88 -- to use SSL/TLS, you may comment or remove this
  89 ssl = {
  90         key = "certs/localhost.key";
  91         certificate = "certs/localhost.crt";
  92 }
  93
  94 -- Force clients to use encrypted connections? This option will
  95 -- prevent clients from authenticating unless they are using encryption.
  96
  97 c2s_require_encryption = true
  98
  99 -- Force certificate authentication for server-to-server connections?
 100 -- This provides ideal security, but requires servers you communicate
 101 -- with to support encryption AND present valid, trusted certificates.
 102 -- NOTE: Your version of LuaSec must support certificate verification!
 103 -- For more information see https://prosody.im/doc/s2s#security
 104
 105 s2s_secure_auth = false
 106
 107 -- Many servers don't support encryption or have invalid or self-signed
 108 -- certificates. You can list domains here that will not be required to
 109 -- authenticate using certificates. They will be authenticated using DNS.
 110
 111 --s2s_insecure_domains = { "gmail.com" }
 112
 113 -- Even if you leave s2s_secure_auth disabled, you can still require valid
 114 -- certificates for some domains by specifying a list here.
 115
 116 --s2s_secure_domains = { "jabber.org" }
 117
 118 -- Select the authentication backend to use. The 'internal' providers
 119 -- use Prosody's configured data storage to store the authentication data.
 120 -- To allow Prosody to offer secure authentication mechanisms to clients, the
 121 -- default provider stores passwords in plaintext. If you do not trust your
 122 -- server please see https://prosody.im/doc/modules/mod_auth_internal_hashed
 123 -- for information about using the hashed backend.
 124
 125 authentication = "internal_plain"
 126
 127 -- Select the storage backend to use. By default Prosody uses flat files
 128 -- in its configured data directory, but it also supports more backends
 129 -- through modules. An "sql" backend is included by default, but requires
 130 -- additional dependencies. See https://prosody.im/doc/storage for more info.
 131
 132 --storage = "sql" -- Default is "internal"
 133
 134 -- For the "sql" backend, you can uncomment *one* of the below to configure:
 135 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
 136 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
 137 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
 138
 139 -- Logging configuration
 140 -- For advanced logging see https://prosody.im/doc/logging
 141 log = {
 142         info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging
 143         error = "prosody.err";
 144         -- "*syslog"; -- Uncomment this for logging to syslog
 145         -- "*console"; -- Log to the console, useful for debugging with daemonize=false
 146 }
 147
 148 ----------- Virtual hosts -----------
 149 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
 150 -- Settings under each VirtualHost entry apply *only* to that host.
 151
 152 VirtualHost "localhost"
 153
 154 VirtualHost "example.com"
 155         enabled = false -- Remove this line to enable this host
 156
 157         -- Assign this host a certificate for TLS, otherwise it would use the one
 158         -- set in the global section (if any).
 159         -- Note that old-style SSL on port 5223 only supports one certificate, and will always
 160         -- use the global one.
 161         ssl = {
 162                 key = "certs/example.com.key";
 163                 certificate = "certs/example.com.crt";
 164         }
 165
 166 ------ Components ------
 167 -- You can specify components to add hosts that provide special services,
 168 -- like multi-user conferences, and transports.
 169 -- For more information on components, see https://prosody.im/doc/components
 170
 171 ---Set up a MUC (multi-user chat) room server on conference.example.com:
 172 --Component "conference.example.com" "muc"
 173
 174 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
 175 --Component "proxy.example.com" "proxy65"
 176
 177 ---Set up an external component (default component port is 5347)
 178 --
 179 -- External components allow adding various services, such as gateways/
 180 -- transports to other networks like ICQ, MSN and Yahoo. For more info
 181 -- see: https://prosody.im/doc/components#adding_an_external_component
 182 --
 183 --Component "gateway.example.com"
 184 --      component_secret = "password"