Clarify DNS instructions (#202)

People have come into the Matrix channel with some confusion about how to set up the DNS records properly on a couple occasion. A few small adjustments will make it easier to understand and hopefully reduce the likelihood of accidental misconfiguration.

Reviewed-on: https://codeberg.org/Codeberg/pages-server/pulls/202
Reviewed-by: Otto <otto@codeberg.org>
Reviewed-by: 6543 <6543@obermui.de>
Co-authored-by: crystal <crystal@noreply.codeberg.org>
Co-committed-by: crystal <crystal@noreply.codeberg.org>
This commit is contained in:
crystal 2023-03-11 03:35:15 +00:00 committed by 6543
parent 8b3b20a86f
commit 4959211e9c

View file

@ -155,16 +155,16 @@
</p> </p>
<div class="codeberg-divider"><hr>or<hr></div> <div class="codeberg-divider"><hr>or<hr></div>
<p> <p>
To use a custom domain, create a file <code class="code">.domains</code> in your repository with the domain name to use. To use a custom domain, create a file <code class="code">.domains</code> in your repository with the domain name you wish to use.
<br><br> <br><br>
Then, add a DNS record to that domains:<br> Then, add a DNS record for that domain:<br>
<code class="code">CNAME [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.codeberg.page</code> <code class="code">CNAME [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.codeberg.page.</code>
<br><br> <br><br>
Or for zone roots where CNAME doesn't work:<br> Or for apex domains where CNAME doesn't work:<br>
<code class="code">ALIAS codeberg.page</code><br> <code class="code">ALIAS codeberg.page.</code><br>
<code class="code">TXT [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.codeberg.page</code> <code class="code">TXT [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.codeberg.page</code>
<br><br> <br><br>
If ALIAS isn't supported, use A & AAAA instead:<br> If ALIAS isn't supported, use A &amp; AAAA instead:<br>
<code class="code">A 217.197.91.145</code><br> <code class="code">A 217.197.91.145</code><br>
<code class="code">AAAA 2001:67c:1401:20f0::1</code><br> <code class="code">AAAA 2001:67c:1401:20f0::1</code><br>
+ <code class="code">TXT</code> as above + <code class="code">TXT</code> as above