bincimap.conf.5 (7388B)
1 .TH bincimap.conf 5 2 .SH "NAME" 3 bincimap.conf \- Global configuration file for 4 .B Binc IMAP 5 6 .SH "EXAMPLE" 7 A section of a bincimap.conf file might look something like this: 8 9 .RS 10 .nf 11 Authentication { 12 allow plain auth in non ssl = "no", 13 auth penalty = 4, 14 disable starttls = "no" 15 } 16 .fi 17 .RE 18 19 20 .SH "INTRODUCTION" 21 22 This manual page describes the format and content of the 23 file 24 .I bincimap.conf. 25 First comes a summary of sections of options that users can set, then 26 we describe the bincimap.conf structure more in detail. 27 28 All 29 .B Binc IMAP's 30 configuration files use the same 31 .B Binc::Storage 32 format. It's basically a sequence of named 33 .B sections 34 enclosed in 35 .B {braces}, 36 each containing a set of comma separated 37 .B key=value 38 pairs. The 39 .B keys 40 must be alphanumeric, and the values can contain 41 any character if it's 42 .B quoted. 43 44 .SH "SUMMARY" 45 46 Options are presented in the format 47 .B Section::name. 48 To set the option, enter the name with no quotes in the section 49 as described in 50 .B FORMAT 51 below. 52 53 The following options can be set in 54 .I bincimap.conf. 55 56 .TP 57 \fBAuthentication::allow plain auth in non ssl = [yes|no] \fR 58 If yes, allows plain text authentication in an unencrypted (SSL/TLS) 59 IMAP session. 60 61 .TP 62 \fBAuthentication::auth penalty = <n>\fR 63 Server will sleep for <n> seconds if the client issues a 64 username/password pair that fails to authenticate. 65 66 .TP 67 \fBLog::environment ip variable = <var>\fR 68 Which environment variable bincimapd should search for the 69 remote host IP in. 70 71 .TP 72 \fBLog::syslog facility = <var>\fR 73 If syslog mode is used, sets the facility to log to. Default 74 is LOG_DAEMON. Allowed values are LOG_USER and LOG_LOCAL0-LOG_LOCAL7. 75 76 .TP 77 \fBLog::syslog facility number = <nr>\fR 78 If syslog mode is used, sets the facility number to log to. Default 79 is the value of LOG_DAEMON. 80 81 .TP 82 \fBLog::type = <type>\fR 83 Which method 84 .B Binc IMAP 85 should use to log. 86 .I syslog 87 means to connect to syslog. 88 .I multilog 89 means to log to stderr(2). Typically used together with 90 the 91 .I multilog 92 utility. For xinetd, use 93 .I syslog. 94 For daemontools/supervise, use 95 .I multilog. 96 97 .TP 98 \fBMailbox::type = <type>\fR 99 Which type of mailbox should the server use? By default, only supports only 100 .B Maildir. 101 102 .TP 103 \fBMailbox::depot = <type>\fR 104 Which type of depot should the server use? By default, supports only 105 .B IMAPdir 106 and 107 .B Maildir++. 108 109 .TP 110 \fBMailbox::path = <path>\fR 111 Path to depot relative from user's home area. Typically 112 .B Maildir 113 for Maildir mailboxes, or the empty string "" if the home area is 114 the same as the Maildir directory. 115 116 .TP 117 \fBMailbox::auto create inbox = [yes|no]\fR 118 If yes, server will create the default mailbox 119 .B INBOX 120 on first login if it does not exist. 121 122 .TP 123 \fBMailbox::auto subscribe mailboxes = <mailboxes>\fR 124 If present, server will 125 automatically subscribe client to the given list of mailboxes on first 126 login. Mailbox list is given as a comma separated list with the 127 mailbox' full path, for example 128 .I INBOX,INBOX.Sent-Mail,INBOX.Trash 129 . 130 131 .TP 132 \fBMailbox::umask = <umask>\fR 133 Server will use this umask throughout session. Defaults to user's 134 default umask. 135 136 .TP 137 \fBSecurity::jail path = <path>\fR 138 Which path bincimap-up should chroot to after starting bincimapd. 139 140 .TP 141 \fBSecurity::jail user = <userid>\fR 142 Which user bincimap-up should become after starting bincimapd. 143 144 .TP 145 \fBSecurity::jail group = <groupid>\fR 146 Which group bincimap-up should enter after starting bincimapd. 147 148 .TP 149 \fBSecurity::version in greeting = [yes|no]\fR 150 When set to "yes", Binc IMAP will display its version number in the 151 greeting displayed to clients when they connect; otherwise no version 152 number is displayed. This version number is useful for debugging and 153 identifying the service, but it is also useful for malicious users who 154 wish to identify versions to exploit known security holes. 155 156 .TP 157 \fBSession::idle timeout = <n>\fR 158 When the server is in authenticated mode, and does not detect any 159 client activity, it will wait <n> seconds before closing (t/o) the 160 connection. <n> can not be less than 1800 seconds. 161 162 .TP 163 \fBSession::auth timeout = <n>\fR 164 When the server is in unauthenticated mode, and does not detect any 165 client activity, it will wait <n> seconds before closing (t/o) the 166 connection. <n> can not be less than 30 seconds. 167 168 .TP 169 \fBSession::transfer timeout = <n>\fR 170 The server writes data to the client in bulks. Each bulk gets <n> 171 seconds to complete before the server times out. 172 173 .TP 174 \fBSession::transfer buffer size = <n>\fR 175 The server will buffer up to <n> bytes of data before sending it off 176 to the client. A lower value will give smoother response from the 177 server, but is a bad idea for clients with a big RTT (for example 178 dial-ins). A high value gives better throughput, but a more bulky 179 transfer. 180 181 .TP 182 \fBSSL::pem file = <file>\fR 183 The path to the SSL certificate file, in PEM format. 184 185 .TP 186 \fBSSL::ca file = <file>\fR 187 A file with one or more certificate authority certificates. It is used 188 to help the client verify the SSL certificate. 189 190 .TP 191 \fBSSL::ca path = <path>\fR 192 A path with lists of certificate authorities' cerficates. It is used 193 to help the client verify the SSL certificate. 194 195 .TP 196 \fBSSL::cipher list = <cipherlist>\fR 197 Sets the list of available SSL ciphers. 198 199 .TP 200 \fBSSL::verify peer = [yes|no]\fR 201 If yes, server will attempt to verify peer certificate. 202 203 .SH "FORMAT" 204 205 This file format is named 206 .B Binc::Storage, 207 after its C++ class name. 208 209 The file starts with an optional list of aliases. These aliases start 210 with a question mark '?', followed by the alias, a colon ':', the 211 replacement text, and finally a semicolon ';'. This example defines 212 the alias "m" to represent the text "myfirstsection": 213 214 .RS 215 .nf 216 ?m:MyFirstSection; 217 .fi 218 .RE 219 220 A section starts with an identifier, or a name. The name contains only 221 alphanumeric characters, and it's case sensitive. The section itself 222 is enclosed in braces. 223 224 .RS 225 .nf 226 MyFirstSection { 227 228 } 229 .fi 230 .RE 231 232 Inside a section, we have a comma separated list of 233 .B key=value 234 pairs. The key consists of a sequence of one or more alphanumeric 235 words. The value can also contain quoted strings. 236 237 .RS 238 .nf 239 MyFirstSection { 240 certificate path = "/etc/path/certificate.txt", 241 optional argument = "yes" 242 } 243 .fi 244 .RE 245 246 The 247 .B aliases 248 that we could define at the start of the 249 .B bincimap.conf 250 file are useful if we wish to abbreviate long words in a key 251 or section name, to save space. Normally this is only used 252 in generated files, but they can also make a manually edited 253 conf file more compact: 254 255 .RS 256 .nf 257 m { 258 certificate path = "/etc/path/certificate.txt", 259 optional argument = "yes" 260 } 261 .fi 262 .RE 263 264 .SH "COPYRIGHT" 265 Copyright (C) 2002-2005 Andreas Aardal Hanssen 266 267 This is free software; see the source for copying conditions. There is 268 NO warranty. 269 270 .SH "NOTE" 271 Please report any bugs to the 272 .B Binc IMAP 273 mailing list. Before posting your bug, check out the 274 .B Binc IMAP 275 official home page for a list of mailing list archives 276 to browse. 277 278 .RS 279 .nf 280 Mailing list: <binc@bincimap.org> 281 Developers' mailing list: <binc-dev@bincimap.org> 282 Announcements list: <binc-news@bincimap.org> 283 284 Subscribing to a mailing list: <binc-subscribe@bincimap.org> 285 Home page: http://www.bincimap.org/ 286 .fi 287 .RE 288 289 .SH "AUTHOR" 290 Andreas Aardal Hanssen <andreas-binc@bincimap.org> 291 292 .RE 293 .SH "SEE ALSO" 294 multilog(8) supervise(8) tcpserver(1) bincimapd(1) bincimap.conf(5) xinetd(8) xinetd.conf(5) 295 296 .B Note: 297 The first three man pages are available for download from 298 .I http://www.qmail.org/.