Thu, 30 Apr 2009 14:35:43 +0100
loggingmanager: Add a comment about 'nowhere' sink type
522
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
1 | -- Prosody Example Configuration File |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
2 | -- |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
3 | -- If it wasn't already obvious, -- starts a comment, and all |
911
39133bca5938
prosody.cfg.lua.dist: Remove some factual inaccuracies
Matthew Wild <mwild1@gmail.com>
parents:
525
diff
changeset
|
4 | -- text after it on a line is ignored by Prosody. |
522
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
5 | -- |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
6 | -- The config is split into sections, a global section, and one |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
7 | -- for each defined host that we serve. You can add as many host |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
8 | -- sections as you like. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
9 | -- |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
10 | -- Lists are written { "like", "this", "one" } |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
11 | -- Lists can also be of { 1, 2, 3 } numbers, etc. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
12 | -- Either commas, or semi-colons; may be used |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
13 | -- as seperators. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
14 | -- |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
15 | -- A table is a list of values, except each value has a name. An |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
16 | -- example would be: |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
17 | -- |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
18 | -- logging = { type = "html", directory = "/var/logs", rotate = "daily" } |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
19 | -- |
911
39133bca5938
prosody.cfg.lua.dist: Remove some factual inaccuracies
Matthew Wild <mwild1@gmail.com>
parents:
525
diff
changeset
|
20 | -- Whitespace (that is tabs, spaces, line breaks) is mostly insignificant, so |
39133bca5938
prosody.cfg.lua.dist: Remove some factual inaccuracies
Matthew Wild <mwild1@gmail.com>
parents:
525
diff
changeset
|
21 | -- can |
522
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
22 | -- be placed anywhere |
911
39133bca5938
prosody.cfg.lua.dist: Remove some factual inaccuracies
Matthew Wild <mwild1@gmail.com>
parents:
525
diff
changeset
|
23 | -- that you deem fitting. |
522
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
24 | -- |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
25 | -- Tip: You can check that the syntax of this file is correct when you have finished |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
26 | -- by running: luac -p prosody.cfg.lua |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
27 | -- If there are any errors, it will let you know what and where they are, otherwise it |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
28 | -- will keep quiet. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
29 | -- |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
30 | -- The only thing left to do is rename this file to remove the .dist ending, and fill in the |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
31 | -- blanks. Good luck, and happy Jabbering! |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
32 | |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
33 | -- Global settings go in this section |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
34 | Host "*" |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
35 | |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
36 | -- This is the list of modules Prosody will load on startup. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
37 | -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
38 | modules_enabled = { |
912
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
39 | -- Generally required |
522
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
40 | "roster"; -- Allow users to have a roster. Recommended ;) |
912
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
41 | "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in. |
522
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
42 | "tls"; -- Add support for secure TLS on c2s/s2s connections |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
43 | "dialback"; -- s2s dialback support |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
44 | "disco"; -- Service discovery |
912
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
45 | |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
46 | -- Not essential, but recommended |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
47 | "private"; -- Private XML storage (for room bookmarks, etc.) |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
48 | "vcard"; -- Allow users to set vCards |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
49 | |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
50 | -- Nice to have |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
51 | "legacyauth"; -- Legacy authentication. Only used by some old clients and bots. |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
52 | "version"; -- Replies to server version requests |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
53 | "uptime"; -- Report how long server has been running |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
54 | "time"; -- Let others know the time here on this server |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
55 | "ping"; -- Replies to XMPP pings with pongs |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
56 | |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
57 | -- Other specific functionality |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
58 | --"register"; -- Allow users to register on this server using a client |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
59 | --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc. |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
60 | --"console"; -- telnet to port 5582 (needs console_enabled = true) |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
61 | --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP" |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
62 | --"httpserver"; -- Serve static files from a directory over HTTP |
522
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
63 | }; |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
64 | |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
65 | -- These are the SSL/TLS-related settings. If you don't want |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
66 | -- to use SSL/TLS, you may comment or remove this |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
67 | ssl = { |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
68 | key = "certs/localhost.key"; |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
69 | certificate = "certs/localhost.cert"; |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
70 | } |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
71 | |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
72 | -- This allows clients to connect to localhost. No harm in it. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
73 | Host "localhost" |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
74 | |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
75 | -- Section for example.com |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
76 | -- (replace example.com with your domain name) |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
77 | Host "example.com" |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
78 | -- Assign this host a certificate for TLS, otherwise it would use the one |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
79 | -- set in the global section (if any). |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
80 | -- Note that old-style SSL on port 5223 only supports one certificate, and will always |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
81 | -- use the global one. |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
82 | ssl = { |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
83 | key = "certs/example.com.key"; |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
84 | certificate = "certs/example.com.crt"; |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
85 | } |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
86 | |
fc3df507afa2
Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents:
479
diff
changeset
|
87 | enabled = false -- This will disable the host, preserving the config, but denying connections |
912
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
88 | |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
89 | -- Set up a MUC (multi-user chat) room server on conference.example.com: |
62dd71870ee3
Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents:
911
diff
changeset
|
90 | Component "conference.example.com" "muc" |