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 insignificant, so
  21 -- can
  22 -- be placed anywhere that      you deem fitting.
  23 --
  24 -- Tip: You can check that the syntax of this file is correct when you have finished
  25 -- by running: luac -p prosody.cfg.lua
  26 -- If there are any errors, it will let you know what and where they are, otherwise it
  27 -- will keep quiet.
  28 --
  29 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the
  30 -- blanks. Good luck, and happy Jabbering!
  31
  32 -- Server-wide settings go in this section
  33 Host "*"
  34
  35         -- This is a (by default, empty) list of accounts that are admins
  36         -- for the server. Note that you must create the accounts separately
  37         -- (see http://prosody.im/doc/creating_accounts for info)
  38         -- Example: admins = { "user1@example.com", "user2@example.net" }
  39         admins = { }
  40
  41         -- This is the list of modules Prosody will load on startup.
  42         -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
  43         modules_enabled = {
  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                                 "private"; -- Private XML storage (for room bookmarks, etc.)
  53                                 "vcard"; -- Allow users to set vCards
  54
  55                         -- Nice to have
  56                                 "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
  57                                 "version"; -- Replies to server version requests
  58                                 "uptime"; -- Report how long server has been running
  59                                 "time"; -- Let others know the time here on this server
  60                                 "ping"; -- Replies to XMPP pings with pongs
  61                                 "pep"; -- Enables users to publish their mood, activity, playing music and more
  62                                 "register"; -- Allow users to register on this server using a client and change passwords
  63
  64                         -- Other specific functionality
  65                                 --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
  66                                 --"console"; -- telnet to port 5582 (needs console_enabled = true)
  67                                 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
  68                                 --"httpserver"; -- Serve static files from a directory over HTTP
  69                           };
  70
  71         -- These modules are auto-loaded, should you
  72         -- for (for some mad reason) want to disable
  73         -- them then uncomment them below
  74         modules_disabled = {
  75                         -- "presence";
  76                         -- "message";
  77                         -- "iq";
  78         };
  79
  80         -- Disable account creation by default, for security
  81         -- For more information see http://prosody.im/doc/creating_accounts
  82         allow_registration = false;
  83
  84         -- These are the SSL/TLS-related settings. If you don't want
  85         -- to use SSL/TLS, you may comment or remove this
  86         ssl = {
  87                 key = "certs/localhost.key";
  88                 certificate = "certs/localhost.cert";
  89                 }
  90
  91 -- This allows clients to connect to localhost. No harm in it.
  92 Host "localhost"
  93
  94 -- Section for example.com
  95 -- (replace example.com with your domain name)
  96 Host "example.com"
  97
  98         enabled = false -- This will disable the host, preserving the config, but denying connections
  99
 100         -- Assign this host a certificate for TLS, otherwise it would use the one
 101         -- set in the global section (if any).
 102         -- Note that old-style SSL on port 5223 only supports one certificate, and will always
 103         -- use the global one.
 104         ssl = {
 105                 key = "certs/example.com.key";
 106                 certificate = "certs/example.com.crt";
 107                 }
 108
 109 -- Set up a MUC (multi-user chat) room server on conference.example.com:
 110 Component "conference.example.com" "muc"