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 -- This is the list of modules Prosody will load on startup.
  36 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
  37 -- Documentation for bundled modules can be found at: https://prosody.im/doc/modules
  38 modules_enabled = {
  39
  40         -- Generally required
  41                 "roster"; -- Allow users to have a roster. Recommended ;)
  42                 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
  43                 "tls"; -- Add support for secure TLS on c2s/s2s connections
  44                 "dialback"; -- s2s dialback support
  45                 "disco"; -- Service discovery
  46
  47         -- Not essential, but recommended
  48                 "carbons"; -- Keep multiple clients in sync
  49                 "pep"; -- Enables users to publish their mood, activity, playing music and more
  50                 "private"; -- Private XML storage (for room bookmarks, etc.)
  51                 "blocklist"; -- Allow users to block communications with other users
  52                 "vcard"; -- Allow users to set vCards
  53
  54         -- Nice to have
  55                 "version"; -- Replies to server version requests
  56                 "uptime"; -- Report how long server has been running
  57                 "time"; -- Let others know the time here on this server
  58                 "ping"; -- Replies to XMPP pings with pongs
  59                 "register"; -- Allow users to register on this server using a client and change passwords
  60                 --"mam"; -- Store messages in an archive and allow users to access it
  61
  62         -- Admin interfaces
  63                 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
  64                 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582
  65
  66         -- HTTP modules
  67                 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
  68                 --"websocket"; -- XMPP over WebSockets
  69                 --"http_files"; -- Serve static files from a directory over HTTP
  70
  71         -- Other specific functionality
  72                 --"limits"; -- Enable bandwidth limiting for XMPP connections
  73                 --"groups"; -- Shared roster support
  74                 --"server_contact_info"; -- Publish contact information for this service
  75                 --"announce"; -- Send announcement to all online users
  76                 --"welcome"; -- Welcome users who register accounts
  77                 --"watchregistrations"; -- Alert admins of registrations
  78                 --"motd"; -- Send a message to users when they log in
  79                 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
  80                 --"proxy65"; -- Enables a file transfer proxy service which clients behind NAT can use
  81 }
  82
  83 -- These modules are auto-loaded, but should you want
  84 -- to disable them then uncomment them here:
  85 modules_disabled = {
  86         -- "offline"; -- Store offline messages
  87         -- "c2s"; -- Handle client connections
  88         -- "s2s"; -- Handle server-to-server connections
  89         -- "posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
  90 }
  91
  92 -- Disable account creation by default, for security
  93 -- For more information see https://prosody.im/doc/creating_accounts
  94 allow_registration = false
  95
  96 -- Force clients to use encrypted connections? This option will
  97 -- prevent clients from authenticating unless they are using encryption.
  98
  99 c2s_require_encryption = true
 100
 101 -- Force servers to use encrypted connections? This option will
 102 -- prevent servers from authenticating unless they are using encryption.
 103 -- Note that this is different from authentication
 104
 105 s2s_require_encryption = true
 106
 107
 108 -- Force certificate authentication for server-to-server connections?
 109 -- This provides ideal security, but requires servers you communicate
 110 -- with to support encryption AND present valid, trusted certificates.
 111 -- NOTE: Your version of LuaSec must support certificate verification!
 112 -- For more information see https://prosody.im/doc/s2s#security
 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 leave s2s_secure_auth disabled, 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 -- To allow Prosody to offer secure authentication mechanisms to clients, the
 131 -- default provider stores passwords in plaintext. If you do not trust your
 132 -- server please see https://prosody.im/doc/modules/mod_auth_internal_hashed
 133 -- for information about using the hashed backend.
 134
 135 authentication = "internal_hashed"
 136
 137 -- Select the storage backend to use. By default Prosody uses flat files
 138 -- in its configured data directory, but it also supports more backends
 139 -- through modules. An "sql" backend is included by default, but requires
 140 -- additional dependencies. See https://prosody.im/doc/storage for more info.
 141
 142 --storage = "sql" -- Default is "internal"
 143
 144 -- For the "sql" backend, you can uncomment *one* of the below to configure:
 145 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
 146 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
 147 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
 148
 149
 150 -- Archiving configuration
 151 -- If mod_mam is enabled, Prosody will store a copy of every message. This
 152 -- is used to synchronize conversations between multiple clients, even if
 153 -- they are offline. This setting controls how long Prosody will keep
 154 -- messages in the archive before removing them.
 155
 156 archive_expires_after = "1w" -- Remove archived messages after 1 week
 157
 158 -- You can also configure messages to be stored in-memory only. For more
 159 -- archiving options, see https://prosody.im/doc/modules/mod_mam
 160
 161 -- Logging configuration
 162 -- For advanced logging see https://prosody.im/doc/logging
 163 log = {
 164         info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging
 165         error = "prosody.err";
 166         -- "*syslog"; -- Uncomment this for logging to syslog
 167         -- "*console"; -- Log to the console, useful for debugging with daemonize=false
 168 }
 169
 170 -- Uncomment to enable statistics
 171 -- For more info see https://prosody.im/doc/statistics
 172 -- statistics = "internal"
 173
 174 -- Certificates
 175 -- Every virtual host and component needs a certificate so that clients and
 176 -- servers can securely verify its identity. Prosody will automatically load
 177 -- certificates/keys from the directory specified here.
 178 -- For more information, including how to use 'prosodyctl' to auto-import certificates
 179 -- (from e.g. Let's Encrypt) see https://prosody.im/doc/certificates
 180
 181 -- Location of directory to find certificates in (relative to main config file):
 182 certificates = "certs"
 183
 184 ----------- Virtual hosts -----------
 185 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
 186 -- Settings under each VirtualHost entry apply *only* to that host.
 187
 188 VirtualHost "localhost"
 189
 190 --VirtualHost "example.com"
 191 --      certificate = "/path/to/example.crt"
 192
 193 ------ Components ------
 194 -- You can specify components to add hosts that provide special services,
 195 -- like multi-user conferences, and transports.
 196 -- For more information on components, see https://prosody.im/doc/components
 197
 198 ---Set up a MUC (multi-user chat) room server on conference.example.com:
 199 --Component "conference.example.com" "muc"
 200
 201 ---Set up an external component (default component port is 5347)
 202 --
 203 -- External components allow adding various services, such as gateways/
 204 -- transports to other networks like ICQ, MSN and Yahoo. For more info
 205 -- see: https://prosody.im/doc/components#adding_an_external_component
 206 --
 207 --Component "gateway.example.com"
 208 --      component_secret = "password"