You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 5.1 KiB

5 years ago
3 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
1 year ago
5 years ago
1 year ago
5 years ago
5 years ago
5 years ago
3 years ago
4 years ago
1 year ago
1 year ago
5 years ago
1 year ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. # Email server setup script
  2. I wrote this script during the grueling process of installing and setting up
  3. an email server. It perfectly reproduces my successful steps to ensure the
  4. same setup time and time again, now with many improvements.
  5. I'm glad to say that dozens, hundreds of people have now used it and there is a
  6. sizeable network of people with email servers thanks to this script.
  7. I've linked this file on Github to a shorter, more memorable address on my
  8. website so you can get it on your machine with this short command:
  9. ```sh
  10. curl -LO lukesmith.xyz/emailwiz.sh
  11. ```
  12. When prompted by a dialog menu at the beginning, select "Internet Site", then
  13. give your full domain without any subdomain, i.e. `lukesmith.xyz`.
  14. ## This script installs
  15. - **Postfix** to send and receive mail.
  16. - **Dovecot** to get mail to your email client (mutt, Thunderbird, etc.).
  17. - Config files that link the two above securely with native log-ins.
  18. - **Spamassassin** to prevent spam and allow you to make custom filters.
  19. - **OpenDKIM** to validate you so you can send to Gmail and other big sites.
  20. - The required SSL certificates if not already present.
  21. ## This script does _not_
  22. - use a SQL database or anything like that. We keep it simple and use normal
  23. Unix system users for accounts and passwords.
  24. - set up a graphical web interface for mail like Roundcube or Squirrel Mail.
  25. You are expected to use a normal mail client like Thunderbird or K-9 for
  26. Android or good old mutt with
  27. [mutt-wizard](https://github.com/lukesmithxyz/mutt-wizard). Note that there
  28. is a guide for [Rainloop](https://landchad.net/rainloop/) on
  29. [LandChad.net](https://landchad.net) for those that want such a web
  30. interface.
  31. ## Prerequisites for Installation
  32. 1. Debian or Ubuntu server. I suited this script for
  33. [Vultr](https://www.vultr.com/?ref=8940911-8H) servers originally, but it
  34. works consistently on any normal setup.
  35. 2. DNS records that point your domain to your server's IP (IPv4 and IPv6).
  36. ## Mandatory Finishing Touches
  37. ### Unblock your ports
  38. While the script enables your mail ports on your server, it is common practice
  39. for all VPS providers to block mail ports on their end by default. Open a help
  40. ticket with your VPS provider asking them to open your mail ports and they will
  41. do it in short order.
  42. ### DNS records
  43. At the end of the script, you will be given some DNS records to add to your DNS
  44. server/registrar's website. These are mostly for authenticating your emails as
  45. non-spam. The 4 records are:
  46. 1. An MX record directing to `mail.yourdomain.tld`.
  47. 2. A TXT record for SPF (to reduce mail spoofing).
  48. 3. A TXT record for DMARC policies.
  49. 4. A TXT record with your public DKIM key. This record is long and **uniquely
  50. generated** while running `emailwiz.sh` and thus must be added after
  51. installation.
  52. They will look something like this:
  53. ```
  54. @ MX 10 mail.example.org
  55. mail._domainkey.example.org TXT v=DKIM1; k=rsa; p=anextremelylongsequenceoflettersandnumbersgeneratedbyopendkim
  56. _dmarc.example.org TXT v=DMARC1; p=reject; rua=mailto:dmarc@example.org; fo=1
  57. example.org TXT v=spf1 mx a: -all
  58. ```
  59. The script will create a file, `~/dns_emailwiz` that will list our the records
  60. for your convenience, and also prints them at the end of the script.
  61. ### Add a rDNS/PTR record as well!
  62. Set a reverse DNS or PTR record to avoid getting spammed. You can do this at
  63. your VPS provider, and should set it to `mail.yourdomain.tld`. Note that you
  64. should set this for both IPv4 and IPv6.
  65. ## Making new users/mail accounts
  66. Let's say we want to add a user Billy and let him receive mail, run this:
  67. ```
  68. useradd -m -G mail billy
  69. passwd billy
  70. ```
  71. Any user added to the `mail` group will be able to receive mail. Suppose a user
  72. Cassie already exists and we want to let her receive mail too. Just run:
  73. ```
  74. usermod -a -G mail cassie
  75. ```
  76. A user's mail will appear in `~/Mail/`. If you want to see your mail while ssh'd
  77. in the server, you could just install mutt, add `set spoolfile="+Inbox"` to
  78. your `~/.muttrc` and use mutt to view and reply to mail. You'll probably want
  79. to log in remotely though:
  80. ## Logging in from email clients (Thunderbird/mutt/etc)
  81. Let's say you want to access your mail with Thunderbird or mutt or another
  82. email program. For my domain, the server information will be as follows:
  83. - SMTP server: `mail.lukesmith.xyz`
  84. - SMTP port: 465
  85. - IMAP server: `mail.lukesmith.xyz`
  86. - IMAP port: 993
  87. ## Benefited from this?
  88. I am always glad to hear this script is still making life easy for people. If
  89. this script or documentation has saved you some frustration, donate here:
  90. - btc: `bc1qzw6mk80t3vrp2cugmgfjqgtgzhldrqac5axfh4`
  91. - xmr: `8A5v4Ci11Lz7BDoE2z2oPqMoNHzr5Zj8B3Q2N2qzqrUKhAKgNQYGSSaZDnBUWg6iXCiZyvC9mVCyGj5kGMJTi1zGKGM4Trm`
  92. ## Sites for Troubleshooting
  93. Can send or receive mail? Getting marked as spam? There are tools to double-check your DNS records and more:
  94. - Always check `journalctl -xe` first for specific errors.
  95. - [Check your DNS](https://intodns.com/)
  96. - [Test your TXT records via mail](https://appmaildev.com/en/dkim)
  97. - [Is your IP blacklisted?](https://mxtoolbox.com/blacklists.aspx)
  98. - [mxtoolbox](https://mxtoolbox.com/SuperTool.aspx)