Annotate

lxmppd.cfg.lua.dist @ 409:2269e9cbe153

Add MD5 to the list of checked dependencies
author Matthew Wild <mwild1@gmail.com>
date Tue, 25 Nov 2008 02:30:25 +0000
parent 377:12f483fe534b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
377
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 -- lxmppd Example Configuration File
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 -- If it wasn't already obvious, -- starts a comment, and all
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 -- text after it is ignored by lxmppd.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6 -- The config is split into sections, a global section, and one
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 -- for each defined host that we serve. You can add as many host
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 -- sections as you like.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 -- Lists are written { "like", "this", "one" }
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 -- Lists can also be of { 1, 2, 3 } numbers, etc.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 -- Either commas, or semi-colons; may be used
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 -- as seperators.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 -- A table is a list of values, except each value has a name. An
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 -- example would be:
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 -- logging = { type = "html", directory = "/var/logs", rotate = "daily" }
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20 -- Whitespace (that is tabs, spaces, line breaks) is insignificant, so can
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 -- be placed anywhere
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22 -- that you deem fitting. Youcouldalsoremoveitentirely,butforobviousrea
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23 --sonsIdon'trecommendit.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25 -- Tip: You can check that the syntax of this file is correct when you have finished
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 -- by running: luac -p lxmppd.cfg.lua
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 -- If there are any errors, it will let you know what and where they are, otherwise it
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28 -- will keep quiet.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29 --
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 -- blanks. Good luck, and happy Jabbering!
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
33 -- Global settings go in this section
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
34 Host "*"
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
35
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
36 -- This is the list of modules lxmppd will load on startup.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
37 -- It looks for plugins/mod_modulename.lua, so make sure that exists too.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
38 modules_enabled = {
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
39 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
40 "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
41 "roster"; -- Allow users to have a roster. Recommended ;)
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
42 "register"; -- Allow users to register on this server using a client
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
43 "tls"; -- Add support for secure TLS on c2s/s2s connections
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
44 "vcard"; -- Allow users to set vCards
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
45 "private"; -- Private XML storage (for room bookmarks, etc.)
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
46 "version"; -- Replies to server version requests
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
47 "dialback"; -- s2s dialback support
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
48 };
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
49
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
50 -- These are the SSL/TLS-related settings. If you don't want
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
51 -- to use SSL/TLS, you may comment or remove this
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
52 ssl = {
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
53 key = "certs/server.key";
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
54 certificate = "certs/server.crt";
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
55 }
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
56
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
57 -- This allows clients to connect to localhost. No harm in it.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
58 Host "localhost"
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
59
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
60 -- Section for example.com
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
61 -- (replace example.com with your domain name)
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
62 Host "example.com"
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
63 -- Assign this host a certificate for TLS, otherwise it would use the one
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
64 -- set in the global section (if any).
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
65 -- Note that old-style SSL on port 5223 only supports one certificate, and will always
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
66 -- use the global one.
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
67 ssl = {
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
68 key = "certs/example.com.key";
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
69 certificate = "certs/example.com.crt";
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
70 }
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
71
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
72 Host "example.org"
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
73 enabled = false -- This will disable the host, preserving the config, but denying connections
12f483fe534b Add new lxmppd.cfg.lua.dist example config file
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
74