prosody.cfg.lua.dist

   1 -- Prosody Example Configuration File
   2 --
   3 -- Information on configuring Prosody can be found on our
   4 -- website at http://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: luac -p prosody.cfg.lua
   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 http://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: http://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: http://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                 --"privacy"; -- Support privacy lists
  45                 --"compression"; -- Stream compression
  46
  47         -- Nice to have
  48                 "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
  49                 "version"; -- Replies to server version requests
  50                 "uptime"; -- Report how long server has been running
  51                 "time"; -- Let others know the time here on this server
  52                 "ping"; -- Replies to XMPP pings with pongs
  53                 "pep"; -- Enables users to publish their mood, activity, playing music and more
  54                 "register"; -- Allow users to register on this server using a client and change passwords
  55                 "adhoc"; -- Support for "ad-hoc commands" that can be executed with an XMPP client
  56                 "admin_adhoc"; -- Offer a range of administrative ad-hoc commands to server admins
  57
  58         -- Other specific functionality
  59                 --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
  60                 --"console"; -- Opens admin telnet interface on localhost port 5582
  61                 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
  62                 --"httpserver"; -- Serve static files from a directory over HTTP
  63                 --"groups"; -- Shared roster support
  64                 --"announce"; -- Send announcement to all online users
  65                 --"welcome"; -- Welcome users who register accounts
  66                 --"watchregistrations"; -- Alert admins of registrations
  67 };
  68
  69 -- These modules are auto-loaded, should you
  70 -- (for some mad reason) want to disable
  71 -- them then uncomment them below
  72 modules_disabled = {
  73         -- "presence";
  74         -- "message";
  75         -- "iq";
  76 };
  77
  78 -- Disable account creation by default, for security
  79 -- For more information see http://prosody.im/doc/creating_accounts
  80 allow_registration = false;
  81
  82 -- These are the SSL/TLS-related settings. If you don't want
  83 -- to use SSL/TLS, you may comment or remove this
  84 ssl = {
  85         key = "certs/localhost.key";
  86         certificate = "certs/localhost.cert";
  87 }
  88
  89 -- Require encryption on client/server connections?
  90 --c2s_require_encryption = false
  91 --s2s_require_encryption = false
  92
  93 -- Logging configuration
  94 -- For advanced logging see http://prosody.im/doc/logging
  95 log = "prosody.log";
  96 debug = false; -- Log debug messages?
  97
  98 ----------- Virtual hosts -----------
  99 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
 100 -- Settings under each VirtualHost entry apply *only* to that host.
 101
 102 VirtualHost "localhost"
 103
 104 VirtualHost "example.com"
 105         enabled = false -- Remove this line to enable this host
 106
 107         -- Assign this host a certificate for TLS, otherwise it would use the one
 108         -- set in the global section (if any).
 109         -- Note that old-style SSL on port 5223 only supports one certificate, and will always
 110         -- use the global one.
 111         ssl = {
 112                 key = "certs/example.com.key";
 113                 certificate = "certs/example.com.crt";
 114         }
 115
 116 ------ Components ------
 117 -- You can specify components to add hosts that provide special services,
 118 -- like multi-user conferences, and transports.
 119 -- For more information on components, see http://prosody.im/doc/components
 120
 121 ---Set up a MUC (multi-user chat) room server on conference.example.com:
 122 --Component "conference.example.com" "muc"
 123
 124 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
 125 --Component "proxy.example.com" "proxy65"
 126
 127 ---Set up an external component (default component port is 5347)
 128 --Component "gateway.example.com"
 129 --      component_secret = "password"