Skip to content

Commit 86df480

Browse files
committed
fixup! feat: implement semantic release
1 parent 15ae32c commit 86df480

2 files changed

Lines changed: 27 additions & 44 deletions

File tree

README.rst

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/README.rst

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ dovecot-formula
1818
:scale: 100%
1919
:target: https://github.com/pre-commit/pre-commit
2020

21-
A SaltStack formula that is empty. It has dummy content to help with a quick
22-
start on a new formula and it serves as a style guide.
21+
A salt formula that installs and configures the dovecot IMAP server. It currently supports an Arch, Debian/Ubuntu, Gentoo or
22+
Red Hat styled layout of the dovecot configuration files in /etc.
23+
Config file content (where needed) is stored in pillar (see pillar.example).
2324

2425
.. contents:: **Table of Contents**
2526
:depth: 1
@@ -81,9 +82,30 @@ Available states
8182

8283
*Meta-state (This is a state that includes other states)*.
8384

84-
This installs the dovecot package,
85-
manages the dovecot configuration file and then
86-
starts the associated dovecot service.
85+
Installs and configures the dovecot package, and ensures that the associated dovecot service is running.
86+
87+
Config file to pillar mappings:
88+
===============================
89+
90+
.. code::
91+
92+
/etc/dovecot/local.conf in dovecot:config:local
93+
94+
e.g.:
95+
96+
.. code::
97+
98+
/etc/dovecot/dovecot-ldap.conf.ext in dovecot:config:dovecotext:ldap
99+
/etc/dovecot/conf.d/auth-ldap.conf.ext in dovecot:config:confext:ldap
100+
/etc/dovecot/conf.d/10-ldap.conf in dovecot:config:conf:10-ldap
101+
/etc/dovecot/auth.d/example.tld.passwd in dovecot:config:passwd_files:example.tld
102+
103+
104+
.. note::
105+
106+
Any help, suggestions if this works / how this works for other distributions are welcome.
107+
108+
87109

88110
Testing
89111
-------

0 commit comments

Comments
 (0)