mirror of
https://github.com/mail-in-a-box/mailinabox.git
synced 2024-12-18 06:37:06 +00:00
46 lines
2.4 KiB
HTML
46 lines
2.4 KiB
HTML
<style>
|
|
</style>
|
|
|
|
<h2>Custom DNS (Advanced)</h2>
|
|
|
|
<p>It is possible to set custom DNS records on domains hosted here. For instance, you can create your own dynamic DNS service. To do so, you will need to call your box’s DNS API.</p>
|
|
|
|
<h4>The HTTP POST request</h4>
|
|
|
|
<p>Send a POST request like this:</p>
|
|
|
|
<pre>curl -d "" --user {email}:{password} https://{{hostname}}/admin/dns/set/<b>qname</b>[/<b>rtype</b>[/<b>value</b>]]</pre>
|
|
|
|
<table class="table">
|
|
<thead><th>Parameter</th> <th>Value</th></thead>
|
|
<tr><td>email</td> <td>The email address of any administrative user here.</td></tr>
|
|
<tr><td>password</td> <td>That user’s password.</td></tr>
|
|
<tr><td>qname</td> <td>The fully qualified domain name for the record you are trying to set.</td></tr>
|
|
<tr><td>rtype</td> <td>The resource type. <code>A</code> if omitted. Possible values: <code>A</code> (an IPv4 address), <code>AAAA</code> (an IPv6 address), <code>TXT</code> (a text string), or <code>CNAME</code> (an alias, which is a fully qualified domain name).</td></tr>
|
|
<tr><td>value</td> <td>The new record’s value. If omitted, the IPv4 address of the remote host is used. This is handy for dynamic DNS! To delete a record, use “__delete__”.</td></tr>
|
|
</table>
|
|
|
|
<p style="margin-top: 1em">Note that <code>-d ""</code> is merely to ensure curl sends a POST request. You do not need to put anything inside the quotes. You can also pass the value using typical form encoding in the POST body.</p>
|
|
|
|
<p>Strict <a href="http://tools.ietf.org/html/rfc4408">SPF</a> and <a href="https://datatracker.ietf.org/doc/draft-kucherawy-dmarc-base/?include_text=1">DMARC</a> records will be added to all custom domains unless you override them.</p>
|
|
|
|
<h4>Examples:</h4>
|
|
|
|
<pre># sets laptop.mydomain.com to point to the IP address of the machine you are executing curl on
|
|
curl -d "" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/laptop.mydomain.com
|
|
|
|
# sets an alias
|
|
curl -d "" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/foo.mydomain.com/cname/bar.mydomain.com
|
|
|
|
# clears the alias
|
|
curl -d "" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/bar.mydomain.com/cname/__delete__
|
|
|
|
# sets a TXT record using the alternate value syntax
|
|
curl -d "value=something%20here" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/foo.mydomain.com/txt
|
|
</pre>
|
|
|
|
<script>
|
|
function show_custom_dns() {
|
|
}
|
|
</script>
|