improvmx.md - is-a-dev-docs - is-a.dev Documentation

improvmx.md (1480B)
      1 ---
      2 order: 1500
      3 label: ImprovMX
      4 icon: /media/improvmx.svg
      5 tags: guides
      6 ---
      7 
      8 # Setting up ImprovMX with an is-a.dev subdomain
      9 
     10 This guide will walk you through the process of setting up ImprovMX with your is-a.dev subdomain.
     11 
     12 ## Requirements
     13 
     14 1. You must have an ImprovMX account. If you don't have an ImprovMX account, please visit [their website](https://improvmx.com) and create an account.
     15 2. You should have already forked the [is-a.dev repository](https://github.com/is-a-dev/register). If you haven't forked the repository, please make one by using [this link](https://github.com/is-a-dev/register/fork).
     16 
     17 ## Creating the file
     18 
     19 Visit your fork and navigate into the `domains` directory and create a file. The file should be named in this manner: `subdomain.json`. (Replace `subdomain` with the subdomain name that you want.)
     20 
     21 After you've made the file, it should look like this:
     22 ```json
     23 {
     24     "owner": {
     25         "username": "github-username"
     26     },
     27     "records": {
     28         "MX": ["mx1.improvmx.com", "mx2.improvmx.com"],
     29         "TXT": ["v=spf1 include:spf.improvmx.com ~all"]
     30     }
     31 }
     32 ```
     33 
     34 **After you've made the file, make a pull request to the [is-a.dev repository](https://github.com/is-a-dev/register).**
     35 
     36 ## Configuring
     37 
     38 After your pull request has been merged, the MX records should be recognized automatically and start working. If you haven't configured it beforehand, please go to the [ImprovMX dashboard](https://app.improvmx.com/) and add the subdomain there.