Browse Source

README: attributes split in multiple sections by files

Xabier de Zuazo 10 years ago
parent
commit
75d653f3b4
1 changed files with 159 additions and 1 deletions
  1. 159 1
      README.md

+ 159 - 1
README.md

@@ -160,6 +160,18 @@ Attributes
     <td>Dovecot default enabled mail_plugins.</td>
     <td><code>[]</code></td>
   </tr>
+</table>
+
+## Main configuration attributes
+
+* Configuration file: `dovecot.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['listen']</code></td>
     <td>A comma separated list of IPs or hosts where to listen in for connections.</td>
@@ -187,7 +199,7 @@ Attributes
   </tr>
   <tr>
     <td><code>node['dovecot']['conf']['login_access_sockets']</code></td>
-    <td>login access sockets</td>
+    <td>Space separated list of login access check sockets.</td>
     <td><em>nil</em></td>
   </tr>
   <tr>
@@ -220,6 +232,18 @@ Attributes
     <td>Dictionary server settings as a hash.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## Authentication processes attributes
+
+* Configuration file: `conf.d/10-auth.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['disable_plaintext_auth']</code></td>
     <td>Disable LOGIN command and all other plaintext authentications unless SSL/TLS is used.</td>
@@ -315,6 +339,18 @@ Attributes
     <td>Space separated list of wanted authentication mechanisms: plain, login, digest-md5, cram-md5, ntlm, rpa, apop, anonymous, gssapi, otp, skey, gss-spnego</td>
     <td><code>"plain"</code></td>
   </tr>
+</table>
+
+## Director-specific attributes
+
+* Configuration file: `conf.d/10-director.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['director_servers']</code></td>
     <td>List of IPs or hostnames to all director servers, including ourself (as a string or as an array).</td>
@@ -335,6 +371,18 @@ Attributes
     <td>TCP/IP port that accepts doveadm connections (instead of director connections).</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## Log destination attributes
+
+* Configuration file: `conf.d/10-logging.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['log_path']</code></td>
     <td>Log file to use for error messages. "syslog" logs to syslog, /dev/stderr logs to stderr.</td>
@@ -410,6 +458,18 @@ Attributes
     <td>Format to use for logging mail deliveries.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## Mailbox locations and namespaces attributes
+
+* Configuration file: `conf.d/10-mail.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['mail_location']</code></td>
     <td>Location for user's mailboxes.</td>
@@ -620,6 +680,18 @@ Attributes
     <td>Hash format to use in attachment filenames.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## Master configuration file attributes
+
+* Configuration file: `conf.d/10-master.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['default_process_limit']</code></td>
     <td>Default process limit.</td>
@@ -645,6 +717,18 @@ Attributes
     <td>Internal user is used by unprivileged processes.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## SSL attributes
+
+* Configuration file: `conf.d/10-ssl.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['ssl']</code></td>
     <td>SSL/TLS support: true or false</td>
@@ -690,6 +774,20 @@ Attributes
     <td>SSL ciphers to use</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## LDA specific attributes
+
+Also used by LMTP.
+
+* Configuration files: `conf.d/15-lda.conf`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['postmaster_address']</code></td>
     <td>Address to use when sending rejection mails.</td>
@@ -745,6 +843,18 @@ Attributes
     <td>Should automatically created mailboxes be also automatically subscribed?</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## LMTP specific attributes
+
+* Configuration file: `conf.d/20-lmtp.conf`
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['lmtp_proxy']</code></td>
     <td>Support proxying to other LMTP/SMTP servers by performing passdb lookups.</td>
@@ -755,11 +865,35 @@ Attributes
     <td>When recipient address includes the detail (e.g. user+detail), try to save the mail to the detail mailbox.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## DB_CONFIG attributes for Berkeley DB
+
+* Configuration file: `dovecot-db.conf.ext`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['db']</code></td>
     <td>DB_CONFIG for Berkeley DB as a hash.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## Dictionary quota SQL attributes
+
+* Configuration files: `dovecot-dict-sql.conf.ext`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['dict_sql']['connect']</code></td>
     <td>Dict sql connect configuration as a string or an array.</td>
@@ -770,6 +904,18 @@ Attributes
     <td>Dict sql database tables maps.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## LDAP authentication attributes
+
+* Condiguration files: `dovecot-ldap.conf.ext`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['ldap']['hosts']</code></td>
     <td>Space separated list or array of LDAP hosts to use.</td>
@@ -920,6 +1066,18 @@ Attributes
     <td>Default password scheme. "{scheme}" before password overrides this.</td>
     <td><em>nil</em></td>
   </tr>
+</table>
+
+## SQL authentication attributes
+
+* Configuration file: `dovecot-sql.conf.ext`.
+
+<table>
+  <tr>
+    <td>Attribute</td>
+    <td>Description</td>
+    <td>Default</td>
+  </tr>
   <tr>
     <td><code>node['dovecot']['conf']['sql']['driver']</code></td>
     <td>Database driver: mysql, pgsql or sqlite.</td>