Pages: General typo and grammatical fixes (#391)

Main changes include switching language from ISP to domain registrar, and standardization around the phrase "Codeberg Pages".

Signed-off-by: Mark Pitblado <mark@pitblado.me>

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/391
Reviewed-by: crapStone <codeberg@crapstone.dev>
Co-authored-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
Co-committed-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
This commit is contained in:
Mark Pitblado 2024-02-09 08:18:50 +00:00 committed by crapStone
parent 6c2ced0ab3
commit 8a32b7cec9

View file

@ -6,7 +6,7 @@ eleventyNavigation:
order: 10
---
Instead of using the `codeberg.page` Domain, you can also purchase your own domain from your internet service provider of your choice and configure it to serve content from Codeberg Page.
Instead of using the `codeberg.page` domain, you can also purchase your own domain from your domain registrar of your choice and configure it to serve content from Codeberg Pages.
{% admonition "warning" "Known pitfalls for failed certificate errors" %}
@ -21,7 +21,7 @@ For custom domains, two things are required:
- One domain per line, you can leave lines empty and comment out lines with `#`.
- The first domain is the main domain, all other domains in the file will be redirected to the first one.
- The rest of the list includes also all relevant `*.codeberg.page` domains for the specific repository.
- The rest of the list includes all relevant `*.codeberg.page` domains for the specific repository.
- a [DNS record](https://en.wikipedia.org/wiki/Domain_Name_System#Address_resolution_mechanism) pointing to one of the following targets, depending on where your static files reside:
@ -29,13 +29,13 @@ For custom domains, two things are required:
{% admonition "question" "Why do I need all of these DNS records?" %}
To understand how the Pages Server serves content, you need to know that a user browsing your custom domain just sends "Hey, I want to see `yourdomain.com`" to the server. But the server might not know, that it is responsible for `yourdomain.com` and it cannot just server all domains in the world. So to find out if the server is responsible for `yourdomain.com` it will check the DNS entries of `yourdomain.com`. If it returns something with `codeberg.page` (according to the domain schemes mentioned below) then it knows, which respository to check for the `.domains` file and your content.
To understand how the Pages server serves content, you need to know that a user browsing your custom domain just sends "Hey, I want to see `yourdomain.com`" to the server. But the server might not know that it is responsible for `yourdomain.com` and it cannot just serve all domains in the world. So to find out if the server is responsible for `yourdomain.com` it will check the DNS entries of `yourdomain.com`. If it returns something with `codeberg.page` (according to the domain schemes mentioned below) then it knows which respository to check for the `.domains` file and your content.
{% endadmonition %}
## Setting the DNS record
There are several ways on how DNS records for your website can be setup in order to tell the Pages server your repository location. For all of the options it is important, that the Pages server knows where to look for the `.domains` file and your content. Depening on from where you want to serve your files, there is a naming scheme for the domain:
There are several ways DNS records for your website can be setup in order to tell the Pages server your repository location. For all of the options it is important that the Pages server knows where to look for the `.domains` file and your content. Depending on from where you want to serve your files, there is a naming scheme for the domain:
<table class="table">
<thead>
@ -93,7 +93,7 @@ If you need email or others services, you have to use one of the remaining optio
If you cannot use a CNAME record to configure the target you can use this method, which needs two entries instead of one.
- First you need to specify, which server should be serving your website. Similar to CNAME you can use an `ALIAS record`. The [difference](https://www.ecosia.org/search?q=cname%20vs%20alias%20record) between an CNAME record is, that the DNS server directly responds with the ip address and not the `codeberg.page` domain. Therefore you need to add a second entry, so that the pages server knows, what to serve under this domain.
- First you need to specify which server should be serving your website. Similar to CNAME you can use an `ALIAS record`. The [difference](https://www.ecosia.org/search?q=cname%20vs%20alias%20record) between an CNAME record is, that the DNS server directly responds with the ip address and not the `codeberg.page` domain. Therefore you need to add a second entry, so that the pages server knows what to serve under this domain.
- Second, you need to setup a `TXT record` which contains the information from the `CNAME entry` which is your repository location as mentioned above. For example `[[branch.]repo.]user.codeberg.page`.
In the end it should look like this:
@ -120,7 +120,7 @@ In the end it should look like this:
If your service provider does not support `ALIAS records` you can also use `A records` and `AAAA records` instead.
- First you need to specify, which server should be serving your website. You can do this, by setting an `A record` for IPv4 and an `AAAA record` for IPv6 which contains the ip address of the Codeberg Page server. The servers ip addresses are:
- First you need to specify which server should be serving your website. You can do this by setting an `A record` for IPv4 and an `AAAA record` for IPv6 which contains the ip address of the Codeberg Pages server. The servers' ip addresses are:
- `A record` which contains the IPv4 value `217.197.91.145`
- `AAAA record` which contains the IPv6 value `2001:67c:1401:20f0::1`
- Second, you need to setup a `TXT record` which contains the information from the `CNAME entry` which is your repository location as mentioned above. For example `[[branch.]repo.]user.codeberg.page`.