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