doc/web/source/howto/manage_domains.rst
changeset 591 2b165e90e225
child 682 697350dd9369
child 697 61aaa7a98ec0
equal deleted inserted replaced
590:9d343514b832 591:2b165e90e225
       
     1 ================
       
     2 Managing domains
       
     3 ================
       
     4 .. _domainadd:
       
     5 
       
     6 domainadd
       
     7 ---------
       
     8 Syntax:
       
     9  | **vmm domainadd** *fqdn* [*transport*]
       
    10  | **vmm da** *fqdn* [*transport*]
       
    11  
       
    12 Adds the new domain into the database and creates the domain directory.
       
    13 
       
    14 If the optional argument transport is given, it will override the default
       
    15 transport (*domain.transport*) from :file:`vmm.cfg`.
       
    16 The specified *transport* will be the default transport for all new accounts
       
    17 in this domain.
       
    18 
       
    19 Configuration-related behavior:
       
    20 
       
    21  *domain.auto_postmaster*
       
    22   When that option is set to **true** (default) :command:`vmm` will
       
    23   automatically create the postmaster account for the new domain and prompt
       
    24   for **postmaster**\ @\ *fqdn*'s password.
       
    25 
       
    26  *account.random_password*
       
    27   When the value of that option is also set to **true**, :command:`vmm`
       
    28   will automatically create the postmaster account for the new domain and
       
    29   print the generated postmaster password to stdout.
       
    30 
       
    31 Example:
       
    32 
       
    33 .. code-block:: console
       
    34 
       
    35  root@host:~# vmm domainadd support.example.com smtp:[mx1.example.com]:2025
       
    36  Creating account for postmaster@support.example.com
       
    37  Enter new password: 
       
    38  Retype new password: 
       
    39  root@host:~# vmm cs account.random_password true
       
    40  root@host:~# vmm da sales.example.com
       
    41  Creating account for postmaster@sales.example.com
       
    42  Generated password: pLJUQ6Xg_z
       
    43 
       
    44 domaindelete
       
    45 ------------
       
    46 Syntax:
       
    47  | **vmm domaindelete** *fqdn* [**force**]
       
    48  | **vmm dd** *fqdn* [**force**]
       
    49 
       
    50 This subcommand deletes the domain specified by *fqdn*.
       
    51 
       
    52 If there are accounts, aliases and/or relocated users assigned to the given
       
    53 domain, :command:`vmm` will abort the requested operation and show an error
       
    54 message.
       
    55 If you know, what you are doing, you can specify the optional keyword
       
    56 **force**.
       
    57 
       
    58 If you really always know what you are doing, edit your :file:`vmm.cfg` and
       
    59 set the option *domain.force_deletion* to **true**.
       
    60 
       
    61 domaininfo
       
    62 ----------
       
    63 Syntax:
       
    64  | **vmm domaininfo** *fqdn* [*details*]
       
    65  | **vmm di** *fqdn* [*details*]
       
    66 
       
    67 This subcommand shows some information about the given domain.
       
    68 
       
    69 For a more detailed information about the domain the optional argument
       
    70 *details* can be specified.
       
    71 A possible *details* value can be one of the following six keywords:
       
    72 
       
    73 ============ ==========================================================
       
    74 keyword      description
       
    75 ============ ==========================================================
       
    76 accounts     to list the e-mail addresses of all existing user accounts
       
    77 aliasdomains to list all assigned alias domain names
       
    78 aliases      to list all available alias e-mail addresses
       
    79 catchall     to list all catch-all destinations
       
    80 relocated    to list the e-mail addresses of all relocated users
       
    81 full         to list all information mentioned above
       
    82 ============ ==========================================================
       
    83 
       
    84 Example:
       
    85 
       
    86 .. code-block:: console
       
    87 
       
    88  root@host:~# vmm domaininfo sales.example.com
       
    89  Domain information
       
    90  ------------------
       
    91          Domain Name......: sales.example.com
       
    92          GID..............: 70708
       
    93          Domain Directory.: /srv/mail/c/70708
       
    94          Quota Limit/User.: Storage: 500.00 MiB; Messages: 10,000
       
    95          Active Services..: IMAP SIEVE
       
    96          Transport........: lmtp:unix:private/dovecot-lmtp
       
    97          Alias Domains....: 0
       
    98          Accounts.........: 1
       
    99          Aliases..........: 0
       
   100          Relocated........: 0
       
   101          Catch-All Dests..: 0
       
   102 
       
   103 domainnote
       
   104 ----------
       
   105 Syntax:
       
   106  | **vmm domainnote** *fqdn* [*note*]
       
   107  | **vmm do** *fqdn* [*note*]
       
   108 
       
   109 With this subcommand, it is possible to attach a note to the specified
       
   110 domain.
       
   111 Without an argument, an existing note is removed.
       
   112 
       
   113 Example:
       
   114 
       
   115 .. code-block:: console
       
   116 
       
   117  root@host:~# vmm do example.com Belongs to Robert
       
   118 
       
   119 .. versionadded:: 0.6.0
       
   120 
       
   121 domainquota
       
   122 -----------
       
   123 Syntax:
       
   124  | **vmm domainquota** *fqdn storage* [*messages*] [**force**]
       
   125  | **vmm dq** *fqdn storage* [*messages*] [**force**]
       
   126 
       
   127 This subcommand is used to configure a new quota limit for the accounts
       
   128 of the domain - not for the domain itself.
       
   129 
       
   130 The default quota limit for accounts is defined in the :file:`vmm.cfg`
       
   131 (*domain.quota_bytes* and *domain.quota_messages*).
       
   132 
       
   133 The new quota limit will affect only those accounts for which the limit has
       
   134 not been overridden.
       
   135 If you want to restore the default to all accounts, you may pass the keyword
       
   136 **force**.
       
   137 When the argument *messages* was omitted the default number of messages
       
   138 **0** (zero) will be applied.
       
   139 
       
   140 Example:
       
   141 
       
   142 .. code-block:: console
       
   143 
       
   144  root@host:~# vmm domainquota example.com 1g force
       
   145 
       
   146 .. versionadded:: 0.6.0
       
   147 
       
   148 domainservices
       
   149 --------------
       
   150 Syntax:
       
   151  | **vmm domainservices** *fqdn* [*service ...*] [**force**]
       
   152  | **vmm ds** *fqdn* [*service ...*] [**force**]
       
   153 
       
   154 To define which services could be used by the users of the domain — with
       
   155 the given *fqdn* — use this subcommand.
       
   156 
       
   157 Each specified *service* will be enabled/usable.
       
   158 All other services will be deactivated/unusable.
       
   159 Possible service names are: **imap**, **pop3**, **sieve** and **smtp**.
       
   160 The new service set will affect only those accounts for which the set has
       
   161 not been overridden.
       
   162 If you want to restore the default to all accounts, you may pass the
       
   163 keyword **force**.
       
   164 
       
   165 .. versionadded:: 0.6.0
       
   166 
       
   167 domaintransport
       
   168 ---------------
       
   169 Syntax:
       
   170  | **vmm domaintransport** *fqdn transport* [**force**]
       
   171  | **vmm dt** *fqdn transport* [**force**]
       
   172 
       
   173 A new transport for the indicated domain can be set with this subcommand.
       
   174 
       
   175 The new transport will affect only those accounts for which the transport
       
   176 has not been overridden.
       
   177 If you want to restore the default to all accounts, you may pass the
       
   178 keyword **force**.
       
   179 
       
   180 Example:
       
   181 
       
   182 .. code-block:: console
       
   183 
       
   184  root@host:~# vmm domaintransport support.example.com dovecot: