← Back to branch summary

~ubuntu-branches/ubuntu/trusty/dovecot/trusty-proposed

« back to all changes in this revision

Viewing changes to pigeonhole/INSTALL

  • Committer: Package Import Robot
  • Author(s): James Page, James Page, Ante Karamatic
  • Date: 2013-02-11 12:41:24 UTC
  • mfrom: (4.1.33 sid)
  • Revision ID: package-import@ubuntu.com-20130211124124-v7bdegzftlhw7yfr
Tags: 1:2.1.7-7ubuntu1
https://launchpad.net/bugs/1117613
https://launchpad.net/bugs/1075456
https://launchpad.net/bugs/671065
[ James Page ]
* Merge from Debian unstable (LP: #1117613, #1075456), remaining changes:
  + Add mail-stack-delivery package:
    - Update d/rules
    - d/control: convert existing dovecot-postfix package to a dummy
      package and add new mail-stack-delivery package.
    - Update maintainer scripts.
    - Rename d/dovecot-postfix.* to debian/mail-stack-delivery.*
    - d/mail-stack-delivery.preinst: Move previously installed backups and
      config files to a new package namespace.
    - d/mail-stack-delivery.prerm: Added to handle downgrades.
  + Use Snakeoil SSL certificates by default:
    - d/control: Depend on ssl-cert.
    - d/dovecot-core.postinst: Relax grep for SSL_* a bit.
  + Add autopkgtest to debian/tests/*.
  + Add ufw integration:
    - d/dovecot-core.ufw.profile: new ufw profile.
    - d/rules: install profile in dovecot-core.
    - d/control: dovecot-core - suggest ufw.
  + d/dovecot-core.dirs: Added usr/share/doc/dovecot-core
  + Add apport hook:
    - d/rules, d/source_dovecot.py
  + Add upstart job:
    - d/rules, d/dovecot-core.dovecot.upstart, d/control,
      d/dovecot-core.dirs, dovecot-imapd.{postrm, postinst, prerm},
      d/dovecot-pop3d.{postinst, postrm, prerm}.
      d/mail-stack-deliver.postinst: Convert init script to upstart.
  + d/control: Added Pre-Depends: dpkg (>= 1.15.6) to dovecot-dbg to support
    xz compression in Ubuntu.
  + d/control: Demote dovecot-common Recommends: to Suggests: to prevent
    install of extra packages on upgrade.
  + d/patches/dovecot-drac.patch: Updated with version for dovecot >= 2.0.0.
* Dropped changes, included in Debian:
  + d/{control,rules}: enable PIE hardening.
  + d/control: Drop B-D on systemd.
* d/p/mail-stack-delivery.postinst: Updated to ensure that configured SSL
  cert and key locations are used when configuring postfix, sorted out
  formatting.
* d/p/dovecot-core.postinst: Create compat links to old style, existing
  SSL cert and key if found.
* d/rules: Don't pass hardening flags for DRAC plugin.
* d/dovecot-{pop3d,imapd}.prerm: Re-sync with Debian.
* d/dovecot-core.lintian-overrides: Drop override for DRAC plugin as not
  required in Ubuntu.
* d/01-mail-stack-delivery: Renamed 99-mail-stack-delivery to ensure that
  the mail-stack-delivery configuration overrides configuration options
  set elsewhere, updated with new cert/key file locations.

[ Ante Karamatic ]
* Change configuration file for LDA on new installs and upgrades
  (LP: #671065).

Show diffs side-by-side

added added

removed removed

Lines of Context:
pigeonhole/INSTALL
85
85
plugin section of the config file (default values are shown if applicable):
86
86
 
87
87
 sieve = ~/.dovecot.sieve
88
 
   The path to the user's main active script. 
 
88
   The location of the user's main active script. 
89
89
 
90
90
 sieve_default = 
91
 
   The path to the default personal sieve script file, which gets executed ONLY
92
 
   if user's private Sieve script does no exist, e.g.
93
 
   /var/lib/dovecot/default.sieve. This is usually a global script, so sure to
94
 
   pre-compile this script manually using the sievec command line tool, as
95
 
   explained in the README file.
96
 
 
97
 
 sieve_global_path =
98
 
   This is the DEPRECATED former name of the sieve_default setting.
 
91
   The location of the default personal sieve script file, which gets executed
 
92
   ONLY if user's private Sieve script does no exist, e.g.
 
93
   /var/lib/dovecot/default.sieve. This is usually a global script, so be sure
 
94
   to pre-compile this script manually using the sievec command line tool, as
 
95
   explained in the README file. This setting used to be called
 
96
   `sieve_global_path', but that name is now deprecated.
99
97
 
100
98
 sieve_global_dir =
101
 
   Directory for :global include scripts for the Sieve include extension. 
 
99
   Location for :global include scripts for the Sieve include extension. 
102
100
 
103
 
 sieve_dir = ~/
104
 
   Directory for :personal include scripts for the Sieve include extension. 
 
101
 sieve_dir = ~/sieve
 
102
   Location for :personal include scripts for the Sieve include extension. 
105
103
 
106
104
 sieve_extensions =
107
105
   Which Sieve language extensions are available to users. By default, all 
131
129
   (wiki2.dovecot.org) or the pigeonhole website (http://pigeonhole.dovecot.org)
132
130
   for available plugins. 
133
131
 
 
132
 sieve_user_log =
 
133
   The path to the file where the user log file is written. If not configured, a
 
134
   default location is used. If the main user's personal Sieve (as configured
 
135
   with sieve=) is a file, the logfile is set to <filename>.log by default. If
 
136
   it is not a file, the default user log file is ~/.dovecot.sieve.log. 
 
137
 
134
138
 recipient_delimiter = +
135
139
   The separator that is expected between the :user and :detail address parts 
136
140
   introduced by the subaddress extension. This may also be a sequence of
176
180
   The maximum number of redirect actions that can be performed during a single
177
181
   script execution. If set to 0, no redirect actions are allowed.
178
182
 
179
 
Sieve Interpreter - Per-user Sieve script location
 
183
Sieve Interpreter - Script Locations
 
184
------------------------------------
 
185
 
 
186
The location of Sieve scripts is not limited to the file system. The Sieve
 
187
interpreter can be extended to retrieve Sieve scripts from other sources as
 
188
well, such as a database. Currently, all settings that are used to obtain the
 
189
location of a single Sieve script, such as sieve=, sieve_default=, sieve_dir=
 
190
and sieve_global_dir= accept the following extended syntax:
 
191
 
 
192
location = [<type>:]path[;<option>[=<value>][;...]]
 
193
 
 
194
The following script location types are implemented by default:
 
195
 
 
196
  file    - The location path is a file system path pointing to the script file
 
197
            or a directory containing script files with names structured as
 
198
            `<script-name>.sieve'.
 
199
        dict    - Dovecot dict lookup. The location path is a dict uri. Read
 
200
            doc/scipt-location-dict.txt for more information and examples. 
 
201
 
 
202
If the type prefix is omitted, the script location type is 'file'.
 
203
 
 
204
The following options are defined for all location types:
 
205
 
 
206
  name=<script-name>
 
207
    Set the name of the Sieve script that this location points to. If the name
 
208
    of the Sieve script is not contained in the location path, this option is
 
209
    required (e.g. for dict locations that must point to a particular script).
 
210
    If the name of the script is contained in the location, the value of the
 
211
    name option overrides the name retrieved from the location. If the Sieve
 
212
    interpreter explicitly queries for a specific name (e.g. to include a script
 
213
    from the sieve_dir= location), this option has no effect.
 
214
 
 
215
  bindir=<dirpath>
 
216
                Points to the directory where the compiled binaries for this script location
 
217
    are stored. If this option is omitted, the behavior depends on the location
 
218
    type. For `file' type locations, the binary is then stored in the same
 
219
    directory as where the script file was found if possible. For `dict' type
 
220
    locations, the binary is not stored at all in that case. Don't specify the
 
221
    same directory for different script locations, as this will result in
 
222
    undefined behavior. 
 
223
        
 
224
Sieve Interpreter - Per-user Sieve Script Location
180
225
--------------------------------------------------
181
226
 
182
227
By default, the Pigeonhole LDA Sieve plugin looks for the user's Sieve script
184
229
home directory is set for the user.
185
230
 
186
231
If you want to store the script elsewhere, you can override the default using 
187
 
the sieve setting, which specifies the path to the user's script file. This can 
188
 
be done in two ways:
 
232
the sieve= setting, which specifies the location of the user's script file. This
 
233
can be done in two ways:
189
234
 
190
235
 1. Define the sieve setting in the plugin section of dovecot.conf.
191
236
 2. Return sieve extra field from userdb extra fields. 
215
260
config file control the execution sequence:
216
261
 
217
262
 sieve_before =
 
263
 sieve_before2 =
 
264
 sieve_before3 = (etc..)
218
265
   Path to a script file or a directory containing script files that need to be
219
 
   executed before the user's script. If the path points to a directory, all the
220
 
   Sieve scripts contained therein (with the proper .sieve extension) are
221
 
   executed. The order of execution is determined by the file names, using a
222
 
   normal 8bit per-character comparison. 
 
266
   executed before the user's personal script. If the path points to a
 
267
   directory, all the Sieve scripts contained therein (with the proper .sieve
 
268
   extension) are executed. The order of execution within that directory is
 
269
   determined by the file names, using a normal 8bit per-character comparison.
 
270
   
 
271
   Multiple script file or directory paths can be specified by appending an
 
272
   increasing number. The Sieve scripts found from these paths are added to the
 
273
   script execution sequence in the specified order. Reading the numbered
 
274
   sieve_before settings stops at the first missing setting, so no numbers may
 
275
   be skipped.
223
276
 
224
277
 sieve_after =
225
 
   Identical to sieve_before, only the specified scripts are executed after the
226
 
   user's script (only when keep is still in effect!). 
 
278
 sieve_after2 =
 
279
 sieve_after3 = (etc..)
 
280
   Identical to sieve_before, but the specified scripts are executed after the
 
281
   user's script (only when keep is still in effect, as explained below). 
227
282
 
228
283
The script execution ends when the currently executing script in the sequence
229
284
does not yield a "keep" result: when the script terminates, the next script is 
257
312
 
258
313
plugin {
259
314
...
260
 
   # Scripts executed before the user's script.
 
315
   # Global scripts executed before the user's personal script.
261
316
   #   E.g. handling messages marked as dangerous
262
317
   sieve_before = /var/lib/dovecot/sieve/discard-virusses.sieve
263
318
 
264
 
   # Scripts executed after the user's script (if keep is still in effect)
 
319
   # User-specific scripts executed before the user's personal script.
 
320
   #   E.g. a vacation script managed through a non-ManageSieve GUI.
 
321
   sieve_before2 = /var/vmail/%d/%n/sieve-before
 
322
 
 
323
   # User-specific scripts executed after the user's personal script.
 
324
   # (if keep is still in effect)
 
325
   #   E.g. user-specific default mail filing rules
 
326
   sieve_after = /var/vmail/%d/%n/sieve-after
 
327
 
 
328
   # Global scripts executed after the user's personal script 
 
329
   # (if keep is still in effect)
265
330
   #   E.g. default mail filing rules.
266
 
   sieve_after = /var/lib/dovecot/sieve/after.d/
 
331
   sieve_after2 = /var/lib/dovecot/sieve/after.d/
267
332
}
268
333
 
269
 
IMPORTANT: Be sure to manually pre-compile the scripts specified by sieve_before 
270
 
and sieve_after using the sievec tool, as explained in the README file.
 
334
IMPORTANT: The scripts specified by sieve_before and sieve_after are often
 
335
located in global locations to which the Sieve interpreter has no write access.
 
336
In that case be sure to manually pre-compile those scripts using the sievec
 
337
tool, as explained in the README file.
271
338
 
272
339
Sieve Interpreter - Extension Configuration
273
340
-------------------------------------------
279
346
  to delete and add header fields.
280
347
 
281
348
  The editheader extension requires explicit configuration and is not enabled
282
 
  for use by default. Refer to doc/editheader.txt for configuration information.
 
349
  for use by default. Refer to doc/extensions/editheader.txt for configuration
 
350
  information.
283
351
 
284
352
- Vacation extension:
285
353
 
287
355
  automatic replies to incoming email messages.
288
356
 
289
357
  The vacation extension is available by default, but it has its own specific
290
 
  configuration options. Refer to doc/vacation.txt for settings specific to the
291
 
  vacation extension.
 
358
  configuration options. Refer to doc/extensions/vacation.txt for settings
 
359
  specific to the vacation extension.
292
360
 
293
361
- Include extension:
294
362
 
296
364
  into another.
297
365
 
298
366
  The include extension is available by default, but it has its own specific
299
 
  configuration options. Refer to doc/include.txt for settings specific to the
300
 
  include extension.
 
367
  configuration options. Refer to doc/extensions/include.txt for settings
 
368
  specific to the include extension.
301
369
 
302
370
- Spamtest and Virustest extensions:
303
371
 
312
380
 
313
381
  The spamtest, spamtestplus and virustest extensions require explicit
314
382
  configuration and are not enabled for use by default. Refer to
315
 
  doc/spamtest-virustest.txt for configuration information.
 
383
  doc/extensions/spamtest-virustest.txt for configuration information.
316
384
 
317
385
Sieve Interpreter - Migration from CMUSieve (Dovecot v1.0/v1.1)
318
386
---------------------------------------------------------------