prosody.cfg.lua.dist

   1 -- Prosody Example Configuration File
   2 --
   3 -- If it wasn't already obvious, -- starts a comment, and all
   4 -- text after it on a line is ignored by Prosody.
   5 --
   6 -- The config is split into sections, a global section, and one
   7 -- for each defined host that we serve. You can add as many host
   8 -- sections as you like.
   9 --
  10 -- Lists are written { "like", "this", "one" }
  11 -- Lists can also be of { 1, 2, 3 } numbers, and other things.
  12 -- Either commas, or semi-colons; may be used
  13 -- as seperators.
  14 --
  15 -- A table is a list of values, except each value has a name. An
  16 -- example table would be:
  17 --
  18 -- ssl = { key = "keyfile.key", certificate = "certificate.cert" }
  19 --
  20 -- Whitespace (that is tabs, spaces, line breaks) is mostly
  21 -- insignificant, so
  22 -- can
  23 -- be placed anywhere that      you deem fitting.
  24 --
  25 -- Tip: You can check that the syntax of this file is correct when you
  26 -- have finished by running: luac -p prosody.cfg.lua
  27 -- If there are any errors, it will let you know what and where they
  28 -- are, otherwise it will keep quiet.
  29 --
  30 -- The only thing left to do is rename this file to remove the .dist
  31 -- ending, and fill in the
  32 -- blanks. Good luck, and happy Jabbering!
  33
  34 -- Server-wide settings go in this section
  35 Host "*"
  36
  37     -- This is a (by default, empty) list of accounts that are admins for the
  38     -- server. Note that you must create the accounts separately (see
  39     -- http://prosody.im/doc/creating_accounts)
  40     -- Example: admins = { "user1@example.com", "user2@example.net" }
  41     admins = { }
  42
  43     -- Enable use of libevent for better performance under high load
  44     -- For more information see: http://prosody.im/doc/libevent
  45     --use_libevent = true;
  46
  47     -- This is the list of modules Prosody will load on startup. It looks for
  48     -- mod_modulename.lua in the plugins folder, so make sure that exists too.
  49     -- Documentation on modules can be found at: http://prosody.im/doc/modules
  50     modules_enabled = {
  51         -- Generally required
  52         "roster";   -- Allow users to have a roster. Recommended ;)
  53         "saslauth"; -- Authentication for clients and servers. Recommended if
  54                     -- you want to log in.
  55         "dialback"; -- s2s dialback support
  56         "disco";    -- Service discovery
  57         "posix";    -- POSIX functionality, daemonizes, enables syslog, etc.
  58
  59         -- Not essential, but recommended
  60         "private";       -- Private XML storage (for room bookmarks, etc.)
  61         "vcard";         -- Allow users to set vCards
  62         "privacy";       -- Support privacy lists
  63         "tls";           -- Support for secure TLS on c2s/s2s connections
  64         --"compression"; -- Stream compression for client-to-server streams
  65
  66         -- Nice to have
  67         "legacyauth"; -- Legacy authentication. Only used by some old
  68                       -- clients and bots.
  69         "version";    -- Replies to server version requests
  70         "uptime";     -- Report how long server has been running
  71         "time";       -- Let others know the time here on this server
  72         "ping";       -- Replies to XMPP pings with pongs
  73         "pep";        -- Enables users to publish their mood, activity, playing
  74                       -- music and more
  75         "register";   -- Allow users to register on this server using a client
  76                       -- and change passwords
  77
  78         -- Other specific functionality
  79         --"console";            -- telnet to port 5582
  80                                 -- (needs console_enabled = true)
  81         --"bosh";               -- Enable BOSH clients, aka "Jabber over HTTP"
  82         --"httpserver";         -- Serve static files from a directory over
  83                                 -- HTTP
  84         --"groups";             -- Shared roster support
  85         --"announce";           -- Send announcement to all online users
  86         --"welcome";            -- Welcome users who register accounts
  87         --"watchregistrations"; -- Alert admins of registrations
  88     }
  89
  90     -- These modules are auto-loaded, should you for (for some mad
  91     -- reason) want to disable them then uncomment them below.
  92     modules_disabled = {
  93         --"presence";
  94         --"message";
  95         --"iq";
  96     }
  97
  98     -- Disable account creation by default, for security
  99     -- For more information see http://prosody.im/doc/creating_accounts
 100     allow_registration = false;
 101
 102     --These are the SSL/TLS-related settings.
 103     --ssl = {
 104     --    key = "certs/localhost.key";
 105     --    certificate = "certs/localhost.cert";
 106     --}
 107
 108     -- Require encryption on client/server connections?
 109     --c2s_require_encryption = false
 110     --s2s_require_encryption = false
 111
 112     -- Logging configuration
 113     -- For advanced logging see http://prosody.im/doc/logging
 114     log = "prosody.log";
 115     debug = false; -- Log debug messages?
 116
 117 -- This allows clients to connect to localhost. No harm in it.
 118 Host "localhost"
 119
 120 -- Section for example.com
 121 -- (replace example.com with your domain name)
 122 Host "example.com"
 123     enabled = false -- This will disable the host, preserving the config, but
 124                     -- denying connections (remove to enable!)
 125
 126     -- Assign this host a certificate for TLS, otherwise it would use the one
 127     -- set in the global section (if any). Note that old-style SSL on port 5223
 128     -- only supports one certificate, and will always use the global one.
 129     --ssl = {
 130     --    key = "certs/example.com.key";
 131     --    certificate = "certs/example.com.crt";
 132     --}
 133
 134 -- Set up a MUC (multi-user chat) room server on conference.example.com:
 135 --Component "conference.example.com" "muc"
 136
 137 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
 138 --Component "proxy.example.com "proxy65"