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 this command:
   8 --     prosodyctl check config
   9 -- If there are any errors, it will let you know what and where
  10 -- they are, otherwise it will keep quiet.
  11 --
  12 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the
  13 -- blanks. Good luck, and happy Jabbering!
  14
  15
  16 ---------- Server-wide settings ----------
  17 -- Settings in this section apply to the whole server and are the default settings
  18 -- for any virtual hosts
  19
  20 -- This is a (by default, empty) list of accounts that are admins
  21 -- for the server. Note that you must create the accounts separately
  22 -- (see https://prosody.im/doc/creating_accounts for info)
  23 -- Example: admins = { "user1@example.com", "user2@example.net" }
  24 admins = { }
  25
  26 -- Enable use of libevent for better performance under high load
  27 -- For more information see: https://prosody.im/doc/libevent
  28 --use_libevent = true
  29
  30 -- Prosody will always look in its source directory for modules, but
  31 -- this option allows you to specify additional locations where Prosody
  32 -- will look for modules first. For community modules, see https://modules.prosody.im/
  33 --plugin_paths = {}
  34
  35 -- Single directory for custom prosody plugins and/or Lua libraries installation
  36 -- This path takes priority over plugin_paths, when prosody is searching for modules
  37 --installer_plugin_path = ""
  38
  39 -- This is the list of modules Prosody will load on startup.
  40 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
  41 -- Documentation for bundled modules can be found at: https://prosody.im/doc/modules
  42 modules_enabled = {
  43
  44         -- Generally required
  45                 "roster"; -- Allow users to have a roster. Recommended ;)
  46                 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
  47                 "tls"; -- Add support for secure TLS on c2s/s2s connections
  48                 "dialback"; -- s2s dialback support
  49                 "disco"; -- Service discovery
  50
  51         -- Not essential, but recommended
  52                 "carbons"; -- Keep multiple clients in sync
  53                 "pep"; -- Enables users to publish their avatar, mood, activity, playing music and more
  54                 "private"; -- Private XML storage (for room bookmarks, etc.)
  55                 "blocklist"; -- Allow users to block communications with other users
  56                 "vcard4"; -- User profiles (stored in PEP)
  57                 "vcard_legacy"; -- Conversion between legacy vCard and PEP Avatar, vcard
  58
  59         -- Nice to have
  60                 "version"; -- Replies to server version requests
  61                 "uptime"; -- Report how long server has been running
  62                 "time"; -- Let others know the time here on this server
  63                 "ping"; -- Replies to XMPP pings with pongs
  64                 "register"; -- Allow users to register on this server using a client and change passwords
  65                 --"mam"; -- Store messages in an archive and allow users to access it
  66                 --"csi_simple"; -- Simple Mobile optimizations
  67
  68         -- Admin interfaces
  69                 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
  70                 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582
  71
  72         -- HTTP modules
  73                 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
  74                 --"websocket"; -- XMPP over WebSockets
  75                 --"http_files"; -- Serve static files from a directory over HTTP
  76
  77         -- Other specific functionality
  78                 --"limits"; -- Enable bandwidth limiting for XMPP connections
  79                 --"groups"; -- Shared roster support
  80                 --"server_contact_info"; -- Publish contact information for this service
  81                 --"announce"; -- Send announcement to all online users
  82                 --"welcome"; -- Welcome users who register accounts
  83                 --"watchregistrations"; -- Alert admins of registrations
  84                 --"motd"; -- Send a message to users when they log in
  85                 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
  86                 --"proxy65"; -- Enables a file transfer proxy service which clients behind NAT can use
  87 }
  88
  89 -- These modules are auto-loaded, but should you want
  90 -- to disable them then uncomment them here:
  91 modules_disabled = {
  92         -- "offline"; -- Store offline messages
  93         -- "c2s"; -- Handle client connections
  94         -- "s2s"; -- Handle server-to-server connections
  95         -- "posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
  96 }
  97
  98 -- Disable account creation by default, for security
  99 -- For more information see https://prosody.im/doc/creating_accounts
 100 allow_registration = false
 101
 102 -- Force clients to use encrypted connections? This option will
 103 -- prevent clients from authenticating unless they are using encryption.
 104
 105 c2s_require_encryption = true
 106
 107 -- Force servers to use encrypted connections? This option will
 108 -- prevent servers from authenticating unless they are using encryption.
 109
 110 s2s_require_encryption = true
 111
 112 -- Force certificate authentication for server-to-server connections?
 113
 114 s2s_secure_auth = false
 115
 116 -- Some servers have invalid or self-signed certificates. You can list
 117 -- remote domains here that will not be required to authenticate using
 118 -- certificates. They will be authenticated using DNS instead, even
 119 -- when s2s_secure_auth is enabled.
 120
 121 --s2s_insecure_domains = { "insecure.example" }
 122
 123 -- Even if you disable s2s_secure_auth, you can still require valid
 124 -- certificates for some domains by specifying a list here.
 125
 126 --s2s_secure_domains = { "jabber.org" }
 127
 128 -- Select the authentication backend to use. The 'internal' providers
 129 -- use Prosody's configured data storage to store the authentication data.
 130
 131 authentication = "internal_hashed"
 132
 133 -- Select the storage backend to use. By default Prosody uses flat files
 134 -- in its configured data directory, but it also supports more backends
 135 -- through modules. An "sql" backend is included by default, but requires
 136 -- additional dependencies. See https://prosody.im/doc/storage for more info.
 137
 138 --storage = "sql" -- Default is "internal"
 139
 140 -- For the "sql" backend, you can uncomment *one* of the below to configure:
 141 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
 142 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
 143 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
 144
 145
 146 -- Archiving configuration
 147 -- If mod_mam is enabled, Prosody will store a copy of every message. This
 148 -- is used to synchronize conversations between multiple clients, even if
 149 -- they are offline. This setting controls how long Prosody will keep
 150 -- messages in the archive before removing them.
 151
 152 archive_expires_after = "1w" -- Remove archived messages after 1 week
 153
 154 -- You can also configure messages to be stored in-memory only. For more
 155 -- archiving options, see https://prosody.im/doc/modules/mod_mam
 156
 157 -- Logging configuration
 158 -- For advanced logging see https://prosody.im/doc/logging
 159 log = {
 160         info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging
 161         error = "prosody.err";
 162         -- "*syslog"; -- Uncomment this for logging to syslog
 163         -- "*console"; -- Log to the console, useful for debugging with daemonize=false
 164 }
 165
 166 -- Uncomment to enable statistics
 167 -- For more info see https://prosody.im/doc/statistics
 168 -- statistics = "internal"
 169
 170 -- Certificates
 171 -- Every virtual host and component needs a certificate so that clients and
 172 -- servers can securely verify its identity. Prosody will automatically load
 173 -- certificates/keys from the directory specified here.
 174 -- For more information, including how to use 'prosodyctl' to auto-import certificates
 175 -- (from e.g. Let's Encrypt) see https://prosody.im/doc/certificates
 176
 177 -- Location of directory to find certificates in (relative to main config file):
 178 certificates = "certs"
 179
 180 -- HTTPS currently only supports a single certificate, specify it here:
 181 --https_certificate = "certs/localhost.crt"
 182
 183 ----------- Virtual hosts -----------
 184 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
 185 -- Settings under each VirtualHost entry apply *only* to that host.
 186
 187 VirtualHost "localhost"
 188
 189 --VirtualHost "example.com"
 190 --      certificate = "/path/to/example.crt"
 191
 192 ------ Components ------
 193 -- You can specify components to add hosts that provide special services,
 194 -- like multi-user conferences, and transports.
 195 -- For more information on components, see https://prosody.im/doc/components
 196
 197 ---Set up a MUC (multi-user chat) room server on conference.example.com:
 198 --Component "conference.example.com" "muc"
 199 --- Store MUC messages in an archive and allow users to access it
 200 --modules_enabled = { "muc_mam" }
 201
 202 ---Set up an external component (default component port is 5347)
 203 --
 204 -- External components allow adding various services, such as gateways/
 205 -- transports to other networks like ICQ, MSN and Yahoo. For more info
 206 -- see: https://prosody.im/doc/components#adding_an_external_component
 207 --
 208 --Component "gateway.example.com"
 209 --      component_secret = "password"