doc/web/source/_static/vmm.cfg
changeset 579 be0906181a10
child 585 ffd24974ed68
equal deleted inserted replaced
578:20141b967c0b 579:be0906181a10
       
     1 # This is the vmm (a virtual mail manager) configuration file.
       
     2 # default location: /usr/local/etc/vmm.cfg
       
     3 #
       
     4 
       
     5 #
       
     6 # Database settings
       
     7 #
       
     8 [database]
       
     9 ; The Python PostgreSQL database adapter module to be used (String)
       
    10 ; Supported modules are:
       
    11 ;    * psycopg2
       
    12 ;    * pyPgSQL
       
    13 module = psycopg2
       
    14 ; Hostname or IP address of the database server (String)
       
    15 host = localhost
       
    16 ; The TCP port, on which the database server is listening for connections (Int)
       
    17 port = 5432
       
    18 ; SSL mode for the database connection (String)
       
    19 ; Possible values are:
       
    20 ;    * disabled
       
    21 ;    * allow
       
    22 ;    * prefer (default)
       
    23 ;    * require
       
    24 ;    * verify-ca (PostgreSQL >= 8.4)
       
    25 ;    * verify-full (PostgreSQL >= 8.4)
       
    26 sslmode = prefer
       
    27 ; Database user name (String)
       
    28 user = dbuser
       
    29 ; Database password (String)
       
    30 pass = dbpassword
       
    31 ; Database name (String)
       
    32 name = mailsys
       
    33 
       
    34 #
       
    35 # mailbox settings
       
    36 #
       
    37 [mailbox]
       
    38 ; The mailbox format to be used for user's mailboxes. (String)
       
    39 ; Depending on the used Dovecot version there are up to 3 supported formats:
       
    40 ;    * maildir - since Dovecot v1.0.0
       
    41 ;    * mdbox   - since Dovecot v2.0.beta5
       
    42 ;    * sdbox   - since Dovecot v2.0.rc3
       
    43 format = maildir
       
    44 ; A colon separated list of mailbox names, that should be created (String)
       
    45 ; e.g.: folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
       
    46 folders = Drafts:Sent:Templates:Trash
       
    47 ; Name of the mailbox root directory in a user's home. (String)
       
    48 ; Usually used names (format: name):
       
    49 ;    * maildir: Maildir
       
    50 ;    * mdbox:   mdbox
       
    51 ;    * sdbox:   sdbox
       
    52 root = Maildir
       
    53 ; Set to true if the mailboxes from the folders option should be listed in
       
    54 ; the subscriptions file. (Boolean)
       
    55 subscribe = true
       
    56 
       
    57 #
       
    58 # Domain settings
       
    59 #
       
    60 [domain]
       
    61 ; Should vmm create the postmaster account when a new domain is created?
       
    62 ; (Boolean)
       
    63 auto_postmaster = true
       
    64 ; Delete domain directory recursive when deleting a domain? (Boolean)
       
    65 delete_directory = false
       
    66 ; Permissions for domain directories (Int)
       
    67 ; octal 0770 -> decimal 504
       
    68 directory_mode = 504
       
    69 ; Force deletion of accounts and aliases when deleting a domain (Boolean)
       
    70 force_deletion = false
       
    71 ;
       
    72 ; The service settings will be evaluated and applied when a domain is
       
    73 ; created. The service settings of the domain will be applied when you
       
    74 ; create a new account.
       
    75 ; Use the subcommand domainservices to modify a domain's service settings.
       
    76 ; Or userservices in order to update the service setting of an account.
       
    77 ; Allow smtp by default? (Boolean)
       
    78 smtp = true
       
    79 ; Allow pop3 by default? (Boolean)
       
    80 pop3 = true
       
    81 ; Allow imap by default? (Boolean)
       
    82 imap = true
       
    83 ; Allow managesieve by default? (Boolean)
       
    84 sieve = true
       
    85 ;
       
    86 ; The quota_* settings will be evaluated and applied when a domain is
       
    87 ; created. The domain's quota_* settings will be applied when an account
       
    88 ; is added to a domain.
       
    89 ; Use the subcommand domainquota to modify a domain's quota limits.
       
    90 ; Or userquota in order to update an account's quota limits.
       
    91 ; Quota limit in bytes. 0 means unlimited (String)
       
    92 ; The value can have one of the suffixes:
       
    93 ;    * b: bytes
       
    94 ;    * k: kilobytes
       
    95 ;    * M: megabytes
       
    96 ;    * G: gigabytes
       
    97 ; 1024 is the same as 1024b or 1k
       
    98 quota_bytes = 0
       
    99 ; Quota limit in number of messages. 0 means unlimited (Int)
       
   100 quota_messages = 0
       
   101 ;
       
   102 ; The transport setting will be evaluated and applied when a domain is
       
   103 ; created. The domain's transport setting will be applied when an account
       
   104 ; is added to a domain.
       
   105 ; Use the subcommand domaintransport to modify the transport of a domain.
       
   106 ; Or usertransport in order to update an account's transport setting.
       
   107 ; default transport for domains and accounts (String)
       
   108 transport = dovecot:
       
   109 
       
   110 #
       
   111 # Account settings
       
   112 #
       
   113 [account]
       
   114 ; Delete the user's home directory recursive when deleting an account? (Boolean)
       
   115 delete_directory = false
       
   116 ; Permissions for the user's home directory and mail directories (Int)
       
   117 ; octal 0700 -> decimal 448
       
   118 directory_mode = 448
       
   119 ; Display disk usage in account info by default? (Boolean)
       
   120 disk_usage = false
       
   121 ; Should vmm generate a random password when no password was given for the
       
   122 ; useradd subcommand? (Boolean)
       
   123 random_password = false
       
   124 ; How many characters to include in the generated passwords? (Int)
       
   125 password_length = 8
       
   126 
       
   127 #
       
   128 # external binaries
       
   129 #
       
   130 [bin]
       
   131 ; location of dovecotpw (String)
       
   132 dovecotpw = /usr/sbin/dovecotpw
       
   133 ; location of disk usage (String)
       
   134 du = /usr/bin/du
       
   135 ; location of postconf (String)
       
   136 postconf = /usr/sbin/postconf
       
   137 
       
   138 #
       
   139 # misc settings
       
   140 #
       
   141 [misc]
       
   142 ; The base directory for all domains/accounts (String)
       
   143 base_directory = /srv/mail
       
   144 ; Number of encryption rounds for the password_scheme BLF-CRYPT (Int)
       
   145 crypt_blowfish_rounds = 5
       
   146 ; Number of encryption rounds for the password_scheme SHA256-CRYPT (Int)
       
   147 crypt_sha256_rounds = 5000
       
   148 ; Number of encryption rounds for the password_scheme SHA512-CRYPT (Int)
       
   149 crypt_sha512_rounds = 5000
       
   150 ; the version number from `dovecot --version` (String)
       
   151 ; e.g. 1.1.18; 1.2.11; 2.0.beta4
       
   152 dovecot_version = 1.2.11
       
   153 ; Password scheme to use (see also: dovecotpw -l) (String)
       
   154 password_scheme = CRAM-MD5
       
   155