Skip to content

Commit

Permalink
Update domain verification txt record (#53)
Browse files Browse the repository at this point in the history
* Add support for python virtual envrionment

Python virtual environment makes it easier to isolate python
ennvironments. It ensures that user and system installed modules do not
conflict with one another. Shaving the yak.

* Update custom domain instructions for txt based domain verification

* Fix ref to custom domains page

* Add new lines at 80 columns

Co-authored-by: ruffrey <jeff@ruffrey.com>
  • Loading branch information
mjmayer and ruffrey committed Nov 9, 2020
1 parent 1bd4186 commit 7875416
Show file tree
Hide file tree
Showing 16 changed files with 180 additions and 83 deletions.
Binary file added services/custom_domains/.xdp_byod_mx.png.Z4ELT0
Binary file not shown.
Binary file not shown.
Binary file modified services/custom_domains/byod_dkim.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed services/custom_domains/byod_dns_verified.png
Binary file not shown.
Binary file modified services/custom_domains/byod_mx.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added services/custom_domains/byod_mx_verified.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added services/custom_domains/byod_query_dns.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified services/custom_domains/byod_spf.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added services/custom_domains/byod_txt_verification.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added services/custom_domains/byod_txt_verified.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
235 changes: 152 additions & 83 deletions services/custom_domains/custom_domains.rst
Original file line number Diff line number Diff line change
@@ -1,38 +1,47 @@
.. _Dashboard: https://mailsac.com/dashboard
.. _`Verified Domains`: https://mailsac.com/domains
.. _amazon_dns: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-creating.html
.. _cloudflare_dns: https://support.cloudflare.com/hc/en-us/articles/360019093151
.. _namecheap_dns: https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain
.. _names_co_uk_dns: https://www.names.co.uk/support/1156-changing_your_domains_dns_settings.html
.. _wix_dns: https://support.wix.com/en/article/adding-or-updating-spf-records-in-your-wix-account
.. _dash_custom_domains: https://mailsac.com/domains

.. _doc_custom_domains:

Custom Domains
==============

Custom domains allow for receiving of email at any address within a
domain. Custom domains can be `purchased <https://mailsac.com/pricing>`_ as
an addon or as part of a plan.
Mailsac lets you configure a custom domain to receive disposable email at any address
within the domain, while keep mail private. Mail can be fetched via API and by
logged-in API users, if your plan supports it.

Custom domains `are included with every subscription <https://mailsac.com/pricing>`_.
Additional domains may be added to any subscription.

Zero-Setup Subdomain
--------------------

The Zero-Setup Subdomain automatically creates a subdomain under msdc.co (eg
test123.msdc.co) that is ready to receive email with no additional setup. This
is the ideal option if you do not own a domain or do not have access to change
the DNS records for a domain.
test123.msdc.co).

It is ready to receive and send email with no additional setup.

This is the ideal option if you do not already own a domain - or do not have
access to change the DNS records for a domain.

`Zero-Setup Subdomain Configuration`_

BYODomain
---------

BYODomain (Bring Your Own Domain) allows you to easily receive email with a
domain or subdomain you already own. If you do not already own a domain you can
use our Zero-Setup Subdomain. Alternatively, you can purchase a domain from a
registrar (`Namecheap <https://namecheap.com>`__ or
`GoDaddy <https://godaddy.com>`_) and configure it for use with Mailsac.
domain or subdomain you already own.

If you do not already own a domain you can use our Zero-Setup Subdomain.
Alternatively, you can purchase a domain from a registrar (`Namecheap
<https://namecheap.com>`__ or `GoDaddy <https://godaddy.com>`_ are popular) and
configure it for use with Mailsac.

The exact method for adding DNS records will depend on your DNS hosting
provider. Your IT department may be able to assist with this. Links to
configuring DNS records for popular :ref:`DNS solutions <sec_mx_record_links>`
are found at the bottom of this page.


`BYODomain Configuration`_

Expand All @@ -41,11 +50,11 @@ registrar (`Namecheap <https://namecheap.com>`__ or
Zero-Setup Subdomain Configuration
----------------------------------

Setting up a Zero-Setup domain only takes a few seconds.
Adding a Zero-Setup domain only takes a few seconds.

#. From the Dashboard_, select `Verified Domains`_.
#. From the Dashboard_, select `Custom Domains <dash_custom_domains_>`_.

.. image:: verified_domains.png
.. image:: dashboard_domains.png
:scale: 50%
:align: center

Expand Down Expand Up @@ -85,9 +94,25 @@ BYODomain Configuration
BYODomain configuration requires you to have access to modify DNS records on
your domain.

#. From the Dashboard_, select `Verified Domains`_.
Domain verification requires the addition of a TXT record to validate domain
ownership.

Receiving mail requires configuring MX records. Sending mail requires
configuring DKIM and SPF records.

.. image:: verified_domains.png
The following sections will show how to:

- Add a custom domain to Mailsac
- Verify ownership of a custom domain using a TXT record
- Configure a custom domain to receive mail by adding an MX record
- Configure a custom domain to send mail by adding DKIM and SPF records

Adding a Custom Domain
^^^^^^^^^^^^^^^^^^^^^^

#. From the Dashboard_, select `Custom Domains <dash_custom_domains_>`_.

.. image:: dashboard_domains.png
:width: 250px
:align: center

Expand All @@ -103,95 +128,139 @@ your domain.
:width: 600px
:align: center

#. Select the DNS Setup Tab to configure DNS

#. Select the DNS Setup tab to verify DNS

"Not Verified - Action Required" indicates DNS is not properly
configured. The next section explains how to verify
domain ownership.

.. image:: byod_select_dns.png
:width: 600px
:align: center

.. note:: "Not Verified - Action Required" indicates DNS is not properly
configured.

#. Configure TXT DNS record for DKIM
.. _sec_verify_domain_ownership:

Create a TXT record for DKIM with the hostname and value found on the DNS
Setup page
in the Mailsac Dashboard_.
Verify Custom Domain Ownership
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: byod_dkim.png
#. Create a TXT record with the hostname and value found on the DNS Setup
page under `Custom Domains <dash_custom_domains_>`_.

See :ref:`sec_txt_record_links` for DNS provider specific
instructions.

.. image:: byod_txt_verification.png
:width: 600px
:align: center

.. note:: The adding of DNS records will depend on your DNS name server.
Your IT department may be able to assist with this. If you use your domain
registrar's name server they should have documentation on how to configure
DNS (`Namecheap <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain>`__
, `Godaddy Documentation <https://www.godaddy.com/help/add-a-txt-record-19232>`_).

=============== ==================
DNS Provider Documentation Link
=============== ==================
Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <amazon_dns_>`_
GoDaddy `Add a TXT record <https://www.godaddy.com/help/add-a-txt-record-19232>`_
Dreamhost `How do I add custom DNS records <https://help.dreamhost.com/hc/en-us/articles/215414867-How-do-I-add-custom-DNS-records->`_
Cloudflare `Managing DNS records in CloudFlare <cloudflare_dns_>`_
HostGator `Manage DNS records <https://www.hostgator.com/help/article/manage-dns-records-with-hostgatorenom>`_
Namecheap `How do I add TXT/SPF/DKIM/DMARC records for my domain <namecheap_dns_>`_
Names.co.uk `Changing your domain's DNS settings <names_co_uk_dns_>`_
Wix `Adding or updating TXT Records in Your Wix account <wix_dns_>`_
=============== ==================

#. Configure TXT DNS record for SPF

Create a TXT record for SPF with the hostname and value found on the DNS
Setup page in the Mailsac Dashboard_.
#. Select "Query My DNS Settings Now"

.. image:: byod_spf.png
Mailsac will attempt to verify domain ownership by querying DNS records for
the custom domain.

.. image:: byod_query_dns.png
:width: 600px
:align: center

#. Confirm domain ownership.

If the TXT record is correct, an "OK" image will appear in the
"DNS Records" section.

.. image:: byod_txt_verified.png
:width: 600px
:align: center

=============== ==================
DNS Provider Documentation Link
=============== ==================
Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <amazon_dns_>`_
GoDaddy `Adding an SPF record <https://www.godaddy.com/help/add-an-spf-record-19218>`_
Dreamhost `How do I add an SPF record <https://help.dreamhost.com/hc/en-us/articles/216106197-How-do-I-add-an-SPF-record->`_
Cloudflare `Managing DNS records in CloudFlare <cloudflare_dns_>`_
HostGator `SPF Records <https://www.hostgator.com/help/article/spf-records>`_
Namecheap `How do I add TXT/SPF/DKIM/DMARC records for my domain <namecheap_dns_>`_
Names.co.uk `Changing your domain's DNS settings <names_co_uk_dns_>`_
Wix `Adding or updating TXT Records in Your Wix account <wix_dns_>`_
=============== ==================
.. note:: DNS can take up to 24 hours to propagate

#. Configure MX records to receive mail
.. _sec_configure_mx_records:

Create two MX records to receive mail with the hostname and value found on
the DNS Setup page in the Mailsac Dashboard_.
Configure Custom Domain for Receiving Mail
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Create two MX ("Mail eXchange") records to receive mail with
the hostname and value found on the DNS Setup page under the
`Custom Domains <dash_custom_domains_>`_ page.

.. image:: byod_mx.png
:width: 600px
:align: center

.. include:: ./mx_record_links.rst
See :ref:`sec_mx_record_links` for DNS provider specific
instructions

#. Verify DNS Settings
#. Select "Query My DNS Settings Now"

Click the "Query My DNS Settings Now" button to verify your DNS settings.
Mailsac will attempt to verify the MX records for
the custom domain.

.. image:: check_dns.png
:width: 600px
:align: center
.. image:: byod_query_dns.png
:width: 600px
:align: center

.. note:: DNS can take up to 24 hours to propagate
#. Confirm MX records.

#. DNS Setup Complete
If the MX records are correct, an "OK" image will appear next to the
"MX Record Type" section of "DNS Records"

DNS setup is complete when the status message changes to "We have verified
that the DNS settings below were added correctly".
.. image:: byod_mx_verified.png
:width: 600px
:align: center

.. image:: byod_dns_verified.png
:width: 600px
:align: center
.. _sec_configure_dkim_spf_records:

Configure Custom Domain for Sending Mail
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Create a TXT record for DKIM (DomainKeys Identified Mail) with
the hostname and value found on the DNS Setup page under the
`Custom Domains <dash_custom_domains_>`_ page.

See :ref:`sec_txt_record_links` and DNS provider specific
instructions

.. image:: byod_dkim.png
:width: 600px
:align: center

#. Create a TXT record for SPF (Sender Policy Framework) with the
hostname and value found on the DNS Setup page on the
`Custom Domains <dash_custom_domains_>`_ page.

See :ref:`sec_spf_record_links` for DNS provider specific
instructions

.. image:: byod_spf.png
:width: 600px
:align: center

#. Confirm DKIM and SPF records.

If the DKIM and SPF records are correct, an "OK" image will appear
next to the "DKIM Public Key" and "SPF" section of "DNS Records"

.. image:: byod_dkim_spf_verified.png
:width: 600px
:align: center

.. _sec_mx_record_links:

DNS Provider MX Record Links
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. include:: ./mx_record_links.rst

.. _sec_txt_record_links:

DNS Provider TXT Record Links
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. include:: ./txt_record_links.rst

.. _sec_spf_record_links:

Email can now be received and sent from your BYODomain!
DNS Provider SPF Record Links
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. include:: ./spf_record_links.rst
Binary file added services/custom_domains/dashboard_domains.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions services/custom_domains/spf_record_links.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _doc_spf_record_links:

=============== ==================
DNS Provider Documentation Link
=============== ==================
Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-creating.html>`_
GoDaddy `Adding an SPF record <https://www.godaddy.com/help/add-an-spf-record-19218>`_
Dreamhost `How do I add an SPF record <https://help.dreamhost.com/hc/en-us/articles/216106197-How-do-I-add-an-SPF-record->`_
Cloudflare `Managing DNS records in CloudFlare <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
HostGator `SPF Records <https://www.hostgator.com/help/article/spf-records>`_
Namecheap `How do I add TXT/SPF/DKIM/DMARC records for my domain <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain>`_
Names.co.uk `Changing your domain's DNS settings <https://www.names.co.uk/support/1156-changing_your_domains_dns_settings.html>`_
Wix `Adding or updating TXT Records in Your Wix account <https://support.wix.com/en/article/adding-or-updating-spf-records-in-your-wix-account>`_
=============== ==================
14 changes: 14 additions & 0 deletions services/custom_domains/txt_record_links.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _doc_txt_record_links:

=============== ==================
DNS Provider Documentation Link
=============== ==================
Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-creating.html>`_
GoDaddy `Add a TXT record <https://www.godaddy.com/help/add-a-txt-record-19232>`_
Dreamhost `How do I add custom DNS records <https://help.dreamhost.com/hc/en-us/articles/215414867-How-do-I-add-custom-DNS-records->`_
Cloudflare `Managing DNS records in CloudFlare <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
HostGator `Manage DNS records <https://www.hostgator.com/help/article/manage-dns-records-with-hostgatorenom>`_
Namecheap `How do I add TXT/SPF/DKIM/DMARC records for my domain <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain>`_
Names.co.uk `Changing your domain's DNS settings <https://www.names.co.uk/support/1156-changing_your_domains_dns_settings.html>`_
Wix `Adding or updating TXT Records in Your Wix account <https://support.wix.com/en/article/adding-or-updating-spf-records-in-your-wix-account>`_
=============== ==================
Binary file removed services/custom_domains/verified_domains.png
Binary file not shown.

0 comments on commit 7875416

Please sign in to comment.