Tue, 18 May 2010 23:28:36 +0100
configure: Fix to allow option values containing '=' (thanks Jakub)
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
1 | -- Prosody Example Configuration File |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
2 | -- |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
3 | -- Information on configuring Prosody can be found on our |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
4 | -- website at http://prosody.im/doc/configure |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
5 | -- |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
6 | -- Tip: You can check that the syntax of this file is correct |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
7 | -- when you have finished by running: luac -p prosody.cfg.lua |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
8 | -- If there are any errors, it will let you know what and where |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
9 | -- they are, otherwise it will keep quiet. |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
10 | -- |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
11 | -- The only thing left to do is rename this file to remove the .dist ending, and fill in the |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
12 | -- blanks. Good luck, and happy Jabbering! |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
13 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
14 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
15 | ---------- Server-wide settings ---------- |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
16 | -- Settings in this section apply to the whole server and are the default settings |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
17 | -- for any virtual hosts |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
18 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
19 | -- This is a (by default, empty) list of accounts that are admins |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
20 | -- for the server. Note that you must create the accounts separately |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
21 | -- (see http://prosody.im/doc/creating_accounts for info) |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
22 | -- Example: admins = { "user1@example.com", "user2@example.net" } |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
23 | admins = { } |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
24 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
25 | -- This is the list of modules Prosody will load on startup. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
26 | -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
27 | modules_enabled = { |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
28 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
29 | -- Generally required |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
30 | "roster"; -- Allow users to have a roster. Recommended ;) |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
31 | "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
32 | "tls"; -- Add support for secure TLS on c2s/s2s connections |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
33 | "dialback"; -- s2s dialback support |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
34 | "disco"; -- Service discovery |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
35 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
36 | -- Not essential, but recommended |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
37 | "private"; -- Private XML storage (for room bookmarks, etc.) |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
38 | "vcard"; -- Allow users to set vCards |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
39 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
40 | -- Nice to have |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
41 | "legacyauth"; -- Legacy authentication. Only used by some old clients and bots. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
42 | "version"; -- Replies to server version requests |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
43 | "uptime"; -- Report how long server has been running |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
44 | "time"; -- Let others know the time here on this server |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
45 | "ping"; -- Replies to XMPP pings with pongs |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
46 | "pep"; -- Enables users to publish their mood, activity, playing music and more |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
47 | "register"; -- Allow users to register on this server using a client and change passwords |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
48 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
49 | -- Other specific functionality |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
50 | --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
51 | --"console"; -- Opens admin telnet interface on localhost port 5582 |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
52 | --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP" |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
53 | --"httpserver"; -- Serve static files from a directory over HTTP |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
54 | }; |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
55 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
56 | -- These modules are auto-loaded, should you |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
57 | -- for (for some mad reason) want to disable |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
58 | -- them then uncomment them below |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
59 | modules_disabled = { |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
60 | -- "presence"; |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
61 | -- "message"; |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
62 | -- "iq"; |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
63 | }; |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
64 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
65 | -- Disable account creation by default, for security |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
66 | -- For more information see http://prosody.im/doc/creating_accounts |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
67 | allow_registration = false; |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
68 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
69 | -- These are the SSL/TLS-related settings. If you don't want |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
70 | -- to use SSL/TLS, you may comment or remove this |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
71 | ssl = { |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
72 | key = "certs/localhost.key"; |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
73 | certificate = "certs/localhost.cert"; |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
74 | } |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
75 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
76 | ----------- Virtual hosts ----------- |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
77 | -- You need to add a VirtualHost entry for each domain you wish Prosody to serve. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
78 | -- Settings under each VirtualHost entry apply *only* to that host. |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
79 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
80 | VirtualHost "localhost" |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
81 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
82 | VirtualHost "example.com" |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
83 | enabled = false -- Remove this line to enable this host |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
84 | |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
85 | -- Assign this host a certificate for TLS, otherwise it would use the one |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
86 | -- set in the global section (if any). |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
87 | -- Note that old-style SSL on port 5223 only supports one certificate, and will always |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
88 | -- use the global one. |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
89 | ssl = { |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
90 | key = "certs/example.com.key"; |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
91 | certificate = "certs/example.com.crt"; |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
92 | } |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1809
diff
changeset
|
93 | |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
94 | ------ Components ------ |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
95 | -- You can specify components to add hosts that provide special services, |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
96 | -- like multi-user conferences, and transports. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
97 | -- For more information on components, see http://prosody.im/doc/components |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
98 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
99 | ---Set up a MUC (multi-user chat) room server on conference.example.com: |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
100 | --Component "conference.example.com" "muc" |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
101 | |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
102 | ---Set up an external component (default component port is 5347) |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
103 | --Component "gateway.example.com" |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
104 | -- component_secret = "password" |