prosody
a5a080c12c96
prosody.cfg.lua.dist

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Comparison

prosody.cfg.lua.dist @ 7359:a5a080c12c96

Update every link to the documentation to use HTTPS
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Sat, 16 Apr 2016 21:08:05 +0100
parent 6345:8e006348d0e5
child 7517:e81ceca529c5
comparison
equal deleted inserted replaced
7358:d0390bc9c5d1 7359:a5a080c12c96
1 -- Prosody Example Configuration File 1 -- Prosody Example Configuration File
2 -- 2 --
3 -- Information on configuring Prosody can be found on our 3 -- Information on configuring Prosody can be found on our
4 -- website at http://prosody.im/doc/configure 4 -- website at https://prosody.im/doc/configure
5 -- 5 --
6 -- Tip: You can check that the syntax of this file is correct 6 -- Tip: You can check that the syntax of this file is correct
7 -- when you have finished by running: prosodyctl check config 7 -- when you have finished by running: prosodyctl check config
8 -- If there are any errors, it will let you know what and where 8 -- If there are any errors, it will let you know what and where
9 -- they are, otherwise it will keep quiet. 9 -- they are, otherwise it will keep quiet.
16 -- Settings in this section apply to the whole server and are the default settings 16 -- Settings in this section apply to the whole server and are the default settings
17 -- for any virtual hosts 17 -- for any virtual hosts
18 18
19 -- This is a (by default, empty) list of accounts that are admins 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 20 -- for the server. Note that you must create the accounts separately
21 -- (see http://prosody.im/doc/creating_accounts for info) 21 -- (see https://prosody.im/doc/creating_accounts for info)
22 -- Example: admins = { "user1@example.com", "user2@example.net" } 22 -- Example: admins = { "user1@example.com", "user2@example.net" }
23 admins = { } 23 admins = { }
24 24
25 -- Enable use of libevent for better performance under high load 25 -- Enable use of libevent for better performance under high load
26 -- For more information see: http://prosody.im/doc/libevent 26 -- For more information see: https://prosody.im/doc/libevent
27 --use_libevent = true 27 --use_libevent = true
28 28
29 -- This is the list of modules Prosody will load on startup. 29 -- This is the list of modules Prosody will load on startup.
30 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too. 30 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
31 -- Documentation on modules can be found at: http://prosody.im/doc/modules 31 -- Documentation on modules can be found at: https://prosody.im/doc/modules
32 modules_enabled = { 32 modules_enabled = {
33 33
34 -- Generally required 34 -- Generally required
35 "roster"; -- Allow users to have a roster. Recommended ;) 35 "roster"; -- Allow users to have a roster. Recommended ;)
36 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in. 36 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
79 -- "s2s"; -- Handle server-to-server connections 79 -- "s2s"; -- Handle server-to-server connections
80 -- "posix"; -- POSIX functionality, sends server to background, enables syslog, etc. 80 -- "posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
81 } 81 }
82 82
83 -- Disable account creation by default, for security 83 -- Disable account creation by default, for security
84 -- For more information see http://prosody.im/doc/creating_accounts 84 -- For more information see https://prosody.im/doc/creating_accounts
85 allow_registration = false 85 allow_registration = false
86 86
87 -- These are the SSL/TLS-related settings. If you don't want 87 -- These are the SSL/TLS-related settings. If you don't want
88 -- to use SSL/TLS, you may comment or remove this 88 -- to use SSL/TLS, you may comment or remove this
89 ssl = { 89 ssl = {
98 98
99 -- Force certificate authentication for server-to-server connections? 99 -- Force certificate authentication for server-to-server connections?
100 -- This provides ideal security, but requires servers you communicate 100 -- This provides ideal security, but requires servers you communicate
101 -- with to support encryption AND present valid, trusted certificates. 101 -- with to support encryption AND present valid, trusted certificates.
102 -- NOTE: Your version of LuaSec must support certificate verification! 102 -- NOTE: Your version of LuaSec must support certificate verification!
103 -- For more information see http://prosody.im/doc/s2s#security 103 -- For more information see https://prosody.im/doc/s2s#security
104 104
105 s2s_secure_auth = false 105 s2s_secure_auth = false
106 106
107 -- Many servers don't support encryption or have invalid or self-signed 107 -- Many servers don't support encryption or have invalid or self-signed
108 -- certificates. You can list domains here that will not be required to 108 -- certificates. You can list domains here that will not be required to
117 117
118 -- Select the authentication backend to use. The 'internal' providers 118 -- Select the authentication backend to use. The 'internal' providers
119 -- use Prosody's configured data storage to store the authentication data. 119 -- use Prosody's configured data storage to store the authentication data.
120 -- To allow Prosody to offer secure authentication mechanisms to clients, the 120 -- To allow Prosody to offer secure authentication mechanisms to clients, the
121 -- default provider stores passwords in plaintext. If you do not trust your 121 -- default provider stores passwords in plaintext. If you do not trust your
122 -- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed 122 -- server please see https://prosody.im/doc/modules/mod_auth_internal_hashed
123 -- for information about using the hashed backend. 123 -- for information about using the hashed backend.
124 124
125 authentication = "internal_plain" 125 authentication = "internal_plain"
126 126
127 -- Select the storage backend to use. By default Prosody uses flat files 127 -- Select the storage backend to use. By default Prosody uses flat files
128 -- in its configured data directory, but it also supports more backends 128 -- in its configured data directory, but it also supports more backends
129 -- through modules. An "sql" backend is included by default, but requires 129 -- through modules. An "sql" backend is included by default, but requires
130 -- additional dependencies. See http://prosody.im/doc/storage for more info. 130 -- additional dependencies. See https://prosody.im/doc/storage for more info.
131 131
132 --storage = "sql" -- Default is "internal" 132 --storage = "sql" -- Default is "internal"
133 133
134 -- For the "sql" backend, you can uncomment *one* of the below to configure: 134 -- For the "sql" backend, you can uncomment *one* of the below to configure:
135 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename. 135 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
136 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } 136 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
137 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } 137 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
138 138
139 -- Logging configuration 139 -- Logging configuration
140 -- For advanced logging see http://prosody.im/doc/logging 140 -- For advanced logging see https://prosody.im/doc/logging
141 log = { 141 log = {
142 info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging 142 info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging
143 error = "prosody.err"; 143 error = "prosody.err";
144 -- "*syslog"; -- Uncomment this for logging to syslog 144 -- "*syslog"; -- Uncomment this for logging to syslog
145 -- "*console"; -- Log to the console, useful for debugging with daemonize=false 145 -- "*console"; -- Log to the console, useful for debugging with daemonize=false
164 } 164 }
165 165
166 ------ Components ------ 166 ------ Components ------
167 -- You can specify components to add hosts that provide special services, 167 -- You can specify components to add hosts that provide special services,
168 -- like multi-user conferences, and transports. 168 -- like multi-user conferences, and transports.
169 -- For more information on components, see http://prosody.im/doc/components 169 -- For more information on components, see https://prosody.im/doc/components
170 170
171 ---Set up a MUC (multi-user chat) room server on conference.example.com: 171 ---Set up a MUC (multi-user chat) room server on conference.example.com:
172 --Component "conference.example.com" "muc" 172 --Component "conference.example.com" "muc"
173 173
174 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers: 174 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
176 176
177 ---Set up an external component (default component port is 5347) 177 ---Set up an external component (default component port is 5347)
178 -- 178 --
179 -- External components allow adding various services, such as gateways/ 179 -- External components allow adding various services, such as gateways/
180 -- transports to other networks like ICQ, MSN and Yahoo. For more info 180 -- transports to other networks like ICQ, MSN and Yahoo. For more info
181 -- see: http://prosody.im/doc/components#adding_an_external_component 181 -- see: https://prosody.im/doc/components#adding_an_external_component
182 -- 182 --
183 --Component "gateway.example.com" 183 --Component "gateway.example.com"
184 -- component_secret = "password" 184 -- component_secret = "password"