Global

Type Definitions

ApiInfo

Source:
Properties:
Name Type Description
mailcow object
Properties
Name Type Description
url string
apikey string
powerdns object
Properties
Name Type Description
url String
apikey String
Type:
  • object
Example
{
        mailcow: {
            url: process.env.MAILCOW_API_URL,
            apikey: process.env.MAILCOW_API_KEY
        },
        powerdns: {
            url: process.env.PDNS_API_URL,
            apikey: process.env.PDNS_API_KEY
        }
    }

Info

Source:
Properties:
Name Type Attributes Default Description
nameserver Array.<string> array of nameservers for your domain, first ns in the list will be used as primary
hostmasterEmail string hostnmaster email address
dmarcMail string <optional>
add mail if you want to get dmarc reports
mailDomain string the domain you may want to add mail for
mailServerHostname String the hostname of the mailserver
defaultMailbox Object
Properties
Name Type Attributes Default Description
local_part String local part of you mailbox (the part before the @ not including the @)
name String the name of mailbox
password String <optional>
RANDOM will generate a random password for your mailbox if omitted
mailServerIp String IPv6 address of your mailserver
mailServerLegacyIp String IPv4 address of your mailserver
addLetsEncryptCAA Boolean <optional>
enable this option if you are ONLY using letsencrypt certs
caaReportMail String <optional>
openssl_path String <optional>
'openssl' optional alternative path for openssl
Type:
  • object
Example
{
        nameserver: ['ns1.domain.tld', 'ns2.domain.tld', 'ns3.domain.tld'],
        hostmasterEmail: 'hostmaster@domain.tld',
        dmarcMail: 'postmaster@domain.tld', 
        mailDomain: 'domain.tld',
        mailServerHostname: 'mail.domain.tld',
        defaultMailbox: {
            local_part: `max.mustermensch`,
            name: `Max Mustermensch`
        },
        //NEEDED FOR MAILSERVER DOMAIN SETUP
        mailServerIp: '2a00:1450:4016:801::2003', //Your IPv6 address WITHOUT brackets([]) 
        mailServerLegacyIp: '127.0.0.1',//Your IPv4 address
        addLetsEncryptCAA: true,
        caaReportMail: 'caa.report@domain.tld' //can be set if you want to get reports on malicious cert issues
    }