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 -- This is the list of modules Prosody will load on startup.
  26 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
  27 modules_enabled = {
  28
  29         -- Generally required
  30                 "roster"; -- Allow users to have a roster. Recommended ;)
  31                 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
  32                 "tls"; -- Add support for secure TLS on c2s/s2s connections
  33                 "dialback"; -- s2s dialback support
  34                 "disco"; -- Service discovery
  35
  36         -- Not essential, but recommended
  37                 "private"; -- Private XML storage (for room bookmarks, etc.)
  38                 "vcard"; -- Allow users to set vCards
  39
  40         -- Nice to have
  41                 "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
  42                 "version"; -- Replies to server version requests
  43                 "uptime"; -- Report how long server has been running
  44                 "time"; -- Let others know the time here on this server
  45                 "ping"; -- Replies to XMPP pings with pongs
  46                 "pep"; -- Enables users to publish their mood, activity, playing music and more
  47                 "register"; -- Allow users to register on this server using a client and change passwords
  48
  49         -- Other specific functionality
  50                 --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
  51                 --"console"; -- Opens admin telnet interface on localhost port 5582
  52                 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
  53                 --"httpserver"; -- Serve static files from a directory over HTTP
  54 };
  55
  56 -- These modules are auto-loaded, should you
  57 -- for (for some mad reason) want to disable
  58 -- them then uncomment them below
  59 modules_disabled = {
  60         -- "presence";
  61         -- "message";
  62         -- "iq";
  63 };
  64
  65 -- Disable account creation by default, for security
  66 -- For more information see http://prosody.im/doc/creating_accounts
  67 allow_registration = false;
  68
  69 -- These are the SSL/TLS-related settings. If you don't want
  70 -- to use SSL/TLS, you may comment or remove this
  71 ssl = {
  72         key = "certs/localhost.key";
  73         certificate = "certs/localhost.cert";
  74 }
  75
  76 ----------- Virtual hosts -----------
  77 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
  78 -- Settings under each VirtualHost entry apply *only* to that host.
  79
  80 VirtualHost "localhost"
  81
  82 VirtualHost "example.com"
  83         enabled = false -- Remove this line to enable this host
  84
  85         -- Assign this host a certificate for TLS, otherwise it would use the one
  86         -- set in the global section (if any).
  87         -- Note that old-style SSL on port 5223 only supports one certificate, and will always
  88         -- use the global one.
  89         ssl = {
  90                 key = "certs/example.com.key";
  91                 certificate = "certs/example.com.crt";
  92                 }
  93
  94 ------ Components ------
  95 -- You can specify components to add hosts that provide special services,
  96 -- like multi-user conferences, and transports.
  97 -- For more information on components, see http://prosody.im/doc/components
  98
  99 ---Set up a MUC (multi-user chat) room server on conference.example.com:
 100 --Component "conference.example.com" "muc"
 101
 102 ---Set up an external component (default component port is 5347)
 103 --Component "gateway.example.com"
 104 --      component_secret = "password"