Samples for Daemontools run scripts
===================================

The directories

- bincimap (IMAP over tcpserver)
- bincimaps (IMAPS over sslserver)
- bincimapstls (IMAP + StartTLS over sslserver)

can be used as templates for the invokation of Binc IMAP.

Assumptions & Requirements
--------------------------

[R] strong requirement
[r] mild requirement
[A] strong assumption
[a] loose assumption
[]  nothing in partiuclar

a) [R] ucspi-tcp6 and ucspi-ssl need to be installed.
b) [r] s/qmail is installed; though not strictly required.
c) [r] Daemaontools/daemontools-encore/runit or s6 tools
       need to be installed.
   []  Alternatively, systemd could be used with some caution.
d) [A] Logging is multilog; for syslog consult man pages.
e) [A] The authentication PAM is qmail-authuser, 
   []  alternatively the checkpassword.pl could be used.
   [R] Those PAMs need to belong to root and need to be 'sticky'.
   [R] In order to work, the absolut path of the PAM is required;
       the $PATH environmen is ignored.
   [r] For logging purpose, the user needs to be placed in the
       environment variable $USER=authuser.
f) [A] Binc IMAP settings are done by environment variables only;
       I don't recommend arguments for bincimap-up.
       bincimapd should have the only argument <maildepot>. 
   [a] envdir is used here.
g) [a] Since Binc IMAP shares the TLS settings with s/qmail,
       it can employ the same user for reading the crypt materials.
h) [a] The respective bincimap* directory includes a ./log
       subdir with a generic ./run file for multilog.
       Automatically, a bincimap* a log directory will be
       raised upon the first call under /var/log owned by 'qmaill'.
       Adjust it to your own needs!

After customization and tests (by simply invoking the 'run' file), 
the respective directory can be linked to /service or an other
appropriate directory for supervision.

All services are labeled 'down' initially. Invoke them manually 
and remove the 'down' file for production.

Happy Binc IMAPing!

August 2023.
--eh.
