Skip to content

Commit

Permalink
settings: Add doveadm_config_version
Browse files Browse the repository at this point in the history
  • Loading branch information
sirainen committed Jun 19, 2024
1 parent fb390fc commit 5fa416a
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
14 changes: 14 additions & 0 deletions data/settings.js
Original file line number Diff line number Diff line change
Expand Up @@ -3490,6 +3490,20 @@ many connections to the doveadm service.
If \`0\`, commands are run directly in the same process.`
},

doveadm_config_version: {
values: setting_types.STRING,
text: `
Dovecot configuration version. This must be the first setting in the
configuration file. It specifies the configuration syntax, the used setting
names and the expected default values.
When there are default configuration changes in newer Dovecot versions, the
existing installations will continue to work the same as before with the same
default settings until this version number is increased. If there are other
configuration changes, the old configuration will either keep working or there
will be a clear failure at startup.`
},

dsync_alt_char: {
default: '_',
tags: [ 'dsync' ],
Expand Down
6 changes: 6 additions & 0 deletions docs/core/settings/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Dovecot doesn't care which settings are in which files. They could all be put
into a single `dovecot.conf` if preferred (except for
[external config files](#external-config-files)).

## Config Version

The first setting in the configuration file must be
[[setting,dovecot_config_version]]. It specifies the configuration syntax,
the used setting names and the expected default values.

## Basic Syntax

The syntax generally looks like this:
Expand Down

0 comments on commit 5fa416a

Please sign in to comment.