Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

Provide additional clarification for custom domains with Codeberg Pages #293

Merged
fnetX merged 3 commits from :imbev-codeberg-pages-clarify into main 2023年03月03日 23:17:38 +01:00
Contributor
Copy link
This provides more detail when using ALIAS+TXT DNS records. More context: https://matrix.to/#/!wkyjxWeAOBpKMvHbno:matrix.org/$Z0mdXrDKTNptIBpENaeZKd9WuuMWhCrawgIWsNjJjXo?via=freeyourgadget.org&via=matrix.org&via=tchncs.de
@ -43,3 +43,3 @@
- `branchname.reponame.username.codeberg.page` → https://username.codeberg.page/reponame/@branchname/
If you can't use a CNAME record to configure the target (e.g. for a zone root), you can use an A/AAAA/ALIAS record to `codeberg.page` with an additional TXT record for the target (just as shown above for CNAME records).
If you can't use a CNAME record to configure the target (e.g. for a zone root), you can use an A/AAAA/ALIAS record to `codeberg.page` with an additional TXT record for the target (to `[[branch.]repo.]user.codeberg.page` just as shown above for CNAME records).
Owner
Copy link

I'd remove the "to", might be subjective. I think we need a comma between the target and "just as shown ...".

I'd remove the "to", might be subjective. I think we need a comma between the target and "just as shown ...".
Member
Copy link

Correct. The TXT record doesn't really point "to" anything, it's just a record that allows storing arbitrary textual data in DNS.

As I mentioned in the Matrix room before, I also think the IPv4 and IPv6 addresses should be listed for A and AAAA records respectively. Maybe it would even be better to replace this paragraph with a table showing which records you need for your particular setup and what their exact value should be.

There should also probably be a notice somewhere that the A/AAAA records will break if Codeberg's IP address changes for some reason. I don't know how the network is setup or what the likelihood of that scenario is but I do think it's worth noting.

Correct. The TXT record doesn't really point "to" anything, it's just a record that allows storing arbitrary textual data in DNS. As I mentioned in the Matrix room before, I also think the IPv4 and IPv6 addresses should be listed for A and AAAA records respectively. Maybe it would even be better to replace this paragraph with a table showing which records you need for your particular setup and what their exact value should be. There should also probably be a notice somewhere that the A/AAAA records will break if Codeberg's IP address changes for some reason. I don't know how the network is setup or what the likelihood of that scenario is but I do think it's worth noting.
Author
Contributor
Copy link

Is there a reason to prefer A/AAAA over ALIAS?

Is there a reason to prefer A/AAAA over ALIAS?
Member
Copy link

As I stated in the Matrix room,

ALIAS records do not work correctly on DNSSEC signed zones and many providers simply do not support them.

[As I stated in the Matrix room,](https://matrix.to/#/!wkyjxWeAOBpKMvHbno:matrix.org/$B9oW7O9rSHY9N3_hz8Vfs-R3toZ1BrPGX_kBzpVhMZU?via=freeyourgadget.org&via=matrix.org&via=tchncs.de) > ALIAS records do not work correctly on DNSSEC signed zones and many providers simply do not support them.
imbev deleted branch imbev-codeberg-pages-clarify 2023年03月04日 00:15:44 +01:00
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Codeberg Pages
Issues affecting Codeberg Pages
Documentation Usability
Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator
This is related to the generation of the documentation, not to the content itself
Priority: High
The priority is high
Priority: Low
The priority is low
Priority: Medium
The priority is medium
Reviewed: Confirmed
Something has been confirmed
Reviewed: Duplicate
Something exists already
Reviewed: Invalid
Something was marked as invalid
Reviewed: Wontfix
Something won't be fixed
Status: Blocked
Status: Help wanted
Contributions are welcome!
Status: In progress
Work is in progress
Status: Needs feedback
Feedback is needed
Status: Ready for Review
Work is completed
Status: Review
Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Codeberg/Documentation!293
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch ":imbev-codeberg-pages-clarify"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?