mmv

mailserver bootstrap script
git clone git://git.yotsev.xyz/mmv.git
Log | Files | Refs | README | LICENSE

README.md (1681B)


      1 ## About
      2 
      3 mmv - minimal mailserver virtual
      4 
      5 mmv is a script for setting up a personal email server on OpenBSD using
      6 virtual users. It allows one to host email for multiple domains on the
      7 same server. It also sets up a tor hidden service by default so that one
      8 can fetch email from public WiFi anonymously.
      9 
     10 ## Prerequisites
     11 
     12 The script automates as much as possible but there is one thing out of
     13 its reach - DNS. If your email is `user@example.com`, you'll need A/AAAA
     14 records for `mail.example.com`.
     15 
     16 ## Installation
     17 
     18     git clone git://git.yotsev.xyz/mmv.git
     19     cd mmv
     20     ./mmv example.com
     21 
     22 If you want to add another domain, simply run the script again:
     23 
     24     ./mmv another-domain.tld
     25 
     26 ## Post-execution
     27 
     28 After the script has finished executing successfully, it will have
     29 written DNS record that you have to paste into your name server or your
     30 registrar's interface.
     31 
     32 ## Usage
     33 
     34 After everything is in place, you can use the newly installed scripts to
     35 manage user accounts.
     36 
     37 To add a user:                       (you'll be prompted for a password)
     38 
     39     madduser user@example.com
     40 
     41 To delete a user:
     42 
     43     mdeluser user@example.com
     44 
     45 To change a user's password:
     46 
     47     mpasswd user@example.com
     48 
     49 ## IMAPS & SMTP example client settings
     50 
     51 * IMAPS
     52     * Domain: mail.example.com
     53     * Port: 993
     54     * Security: TLS
     55     * login: user@example.com
     56 * SMTP
     57     * Domain: mail.example.com
     58     * Port: 587
     59     * Security: STARTTLS
     60     * login: user@example.com
     61 
     62 ## Troubleshooting
     63 
     64 If the script fails to sign the TLS certificate, it's likely that
     65 OpenSMTPD and Dovecot will show up as failed. In most cases just getting
     66 the certificate will fix them because they are just failing to load it.