mirror of
https://github.com/maelgangloff/domain-watchdog.git
synced 2025-12-17 17:55:42 +00:00
docs: update documentation
This commit is contained in:
parent
b147849d59
commit
6444e05e02
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Acknowledgment
|
||||
description: Many thanks to the contributors to this project, developers and translators.
|
||||
---
|
||||
|
||||
import { ContributorList } from "starlight-contributor-list"
|
||||
|
||||
@ -30,7 +30,7 @@ When a client requests a domain, the resolution chain queries:
|
||||
<LinkCard
|
||||
title="Top Level Domain"
|
||||
description="An overview of Top-Level Domains (TLDs), their classification (gTLD, ccTLD, etc.), and the structure of the DNS root zone."
|
||||
href="/en/definitions/top-level-domain"/>
|
||||
href="/en/definitions/top-level-domain/"/>
|
||||
|
||||
## GLUE Records
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ Implementing DNSSEC involves two main stages:
|
||||
<LinkCard
|
||||
title="Domain name"
|
||||
description="An explanation of what a domain name is and its structure."
|
||||
href="/en/definitions/domain-name"/>
|
||||
href="/en/definitions/domain-name/"/>
|
||||
|
||||
## The Adoption of DNSSEC
|
||||
|
||||
@ -45,7 +45,7 @@ Adoption is a top-down process starting from the Root Zone. While the Root and m
|
||||
<LinkCard
|
||||
title="Top Level Domain"
|
||||
description="An overview of Top-Level Domains (TLDs) and their classification (gTLD, ccTLD, etc.)."
|
||||
href="/en/definitions/top-level-domain"/>
|
||||
href="/en/definitions/top-level-domain/"/>
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ For most Generic Top-Level Domains (gTLDs) regulated by ICANN, the cycle follows
|
||||
<LinkCard
|
||||
title="Domain name"
|
||||
description="An explanation of what a domain name is and its structure."
|
||||
href="/en/definitions/domain-name"/>
|
||||
href="/en/definitions/domain-name/"/>
|
||||
|
||||
## Special Cases of some ccTLDs
|
||||
|
||||
@ -37,7 +37,7 @@ Country Code Top-Level Domains (ccTLDs) operate under local regulations, leading
|
||||
<LinkCard
|
||||
title="Top Level Domain"
|
||||
description="An overview of Top-Level Domains (TLDs) and their classification (gTLD, ccTLD, etc.)."
|
||||
href="/en/definitions/top-level-domain"/>
|
||||
href="/en/definitions/top-level-domain/"/>
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: EPP Protocol
|
||||
description: What is a Domain Name Registrar? Learn their role in managing the registration and transfer of domain names for the public.
|
||||
description: What is the EPP protocol? Learn how this protocol allows registries and registrars to communicate about domain names.
|
||||
---
|
||||
|
||||
import {LinkCard} from "@astrojs/starlight/components";
|
||||
@ -16,7 +16,7 @@ The Registrar acts as the EPP Client. They send XML commands to create, update,
|
||||
<LinkCard
|
||||
title="Registrar"
|
||||
description="What is a Domain Name Registrar?"
|
||||
href="/en/definitions/registrar"/>
|
||||
href="/en/definitions/registrar/"/>
|
||||
|
||||
### Server (Registry)
|
||||
|
||||
@ -25,7 +25,7 @@ The Registry acts as the EPP Server. It processes the commands, validates logic
|
||||
<LinkCard
|
||||
title="Registry"
|
||||
description="What is a Domain Name Registry?"
|
||||
href="/en/definitions/registry"/>
|
||||
href="/en/definitions/registry/"/>
|
||||
|
||||
## The Protocol Mechanism
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ ICANN decides which new Top-Level Domains (TLDs) are added to the Root Zone.
|
||||
<LinkCard
|
||||
title="Top Level Domain"
|
||||
description="An overview of Top-Level Domains (TLDs) and their classification (gTLD, ccTLD, etc.)."
|
||||
href="/en/definitions/top-level-domain"/>
|
||||
href="/en/definitions/top-level-domain/"/>
|
||||
|
||||
## Accrediting Registrars
|
||||
|
||||
@ -31,7 +31,7 @@ ICANN manages the accreditation system for Registrars wishing to sell generic TL
|
||||
<LinkCard
|
||||
title="Registrar"
|
||||
description="What is a Domain Name Registrar?"
|
||||
href="/en/definitions/registrar"/>
|
||||
href="/en/definitions/registrar/"/>
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ The **Registration Data Access Protocol (RDAP)** is the modern standard for acce
|
||||
<LinkCard
|
||||
title="WHOIS Protocol"
|
||||
description="Get an overview of the WHOIS Protocol."
|
||||
href="/en/definitions/whois"/>
|
||||
href="/en/definitions/whois/"/>
|
||||
|
||||
## Deployment Status
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ A **Registrar** is an accredited commercial entity that sells domain name regist
|
||||
<LinkCard
|
||||
title="Registry"
|
||||
description="What is a Domain Name Registry?"
|
||||
href="/en/definitions/registry"/>
|
||||
href="/en/definitions/registry/"/>
|
||||
|
||||
## Core Responsibilities
|
||||
|
||||
@ -29,7 +29,7 @@ A **Registrar** is an accredited commercial entity that sells domain name regist
|
||||
<LinkCard
|
||||
title="DNS Protocol"
|
||||
description="What is DNS? Understand the Domain Name System."
|
||||
href="/en/definitions/dns"/>
|
||||
href="/en/definitions/dns/"/>
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@ Registries generally do not sell directly to the public. Instead, they:
|
||||
<LinkCard
|
||||
title="Registrar"
|
||||
description="What is a Domain Name Registrar?"
|
||||
href="/en/definitions/registrar"/>
|
||||
href="/en/definitions/registrar/"/>
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@ -89,7 +89,7 @@ Since the implementation of the **GDPR** (General Data Protection Regulation) an
|
||||
* **Privacy Proxies**: Registrars often provide services that replace the registrant's details with the registrar's generic contact information to prevent spam and harassment.
|
||||
* **Tiered Access**: Full, unredacted data is often no longer publicly available anonymously and requires a legitimate legal request or accreditation.
|
||||
|
||||
<LinkCard title="RDAP Protocol" href="/en/definitions/rdap"
|
||||
<LinkCard title="RDAP Protocol" href="/en/definitions/rdap/"
|
||||
description="Learn about the successor to WHOIS designed to handle structured data and privacy access."/>
|
||||
|
||||
## See also
|
||||
|
||||
@ -21,7 +21,7 @@ You’ll implement both the Backend (Provider logic) and the Frontend (configura
|
||||
<Steps>
|
||||
1. Read the API documentation of the new Provider and identify the sections related to user authentication and domain name registration.
|
||||
1. Set up your development environment.
|
||||
<LinkCard title="Manual Installation" href="/en/install-config/install/manual-install" description='Install the project from source to begin development' />
|
||||
<LinkCard title="Manual Installation" href="/en/install-config/install/manual-install/" description='Install the project from source to begin development' />
|
||||
</Steps>
|
||||
|
||||
## Backend
|
||||
|
||||
@ -12,7 +12,7 @@ domain registration.
|
||||
|
||||
<Steps>
|
||||
1. Choose an external API provider from the list of supported registrars.
|
||||
<LinkCard title="Supported registrar" description="List of supported registrars for creating a Connector" href="/en/features/backorder/supported-registrar"/>
|
||||
<LinkCard title="Supported registrar" description="List of supported registrars for creating a Connector" href="/en/features/backorder/supported-registrar/"/>
|
||||
|
||||
2. Enter the required information using the credentials obtained from your provider’s customer area
|
||||
:::tip{icon="heart"}
|
||||
|
||||
@ -43,7 +43,7 @@ To read the documentation related to domain name search, please click on the lin
|
||||
|
||||
<LinkCard title="Domain search"
|
||||
description="Obtain the details of a domain name registration and the history of observed events"
|
||||
href="/en/features/search/domain-search"/>
|
||||
href="/en/features/search/domain-search/"/>
|
||||
:::
|
||||
|
||||
---
|
||||
@ -63,7 +63,7 @@ To read the documentation related to the Watchlist, please click on the link bel
|
||||
|
||||
<LinkCard title="Watchlist"
|
||||
description="Add domain names to a Watchlist to track them, be notified of any changes, and potentially buy them when they expire"
|
||||
href="/en/features/tracking/watchlist"/>
|
||||
href="/en/features/tracking/watchlist/"/>
|
||||
:::
|
||||
|
||||
### Watchlist notifications
|
||||
@ -84,14 +84,14 @@ To read the documentation related to Connector, please click on the link below.
|
||||
|
||||
<LinkCard title="Connector"
|
||||
description="Create a Connector to enable domain name purchases by linking it to your Watchlists"
|
||||
href="/en/features/backorder/connector"/>
|
||||
href="/en/features/backorder/connector/"/>
|
||||
:::
|
||||
|
||||
### Supported registrar list
|
||||
|
||||
<LinkCard title="Supported registrar list"
|
||||
description="List of registrars supported by this project"
|
||||
href="/en/features/backorder/supported-registrar"/>
|
||||
href="/en/features/backorder/supported-registrar/"/>
|
||||
|
||||
---
|
||||
|
||||
@ -107,5 +107,5 @@ To read the documentation related to the Tracking table, please click on the lin
|
||||
|
||||
<LinkCard title="Tracking table"
|
||||
description="List all the domains you're monitoring in your Watchlist and track the status of those domains"
|
||||
href="/en/features/tracking/tracking-table"/>
|
||||
href="/en/features/tracking/tracking-table/"/>
|
||||
:::
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
---
|
||||
title: TLD list
|
||||
description: Discover the list of currently active TLDs directly in your interface, along with additional information.
|
||||
---
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Tracking table
|
||||
description: The tracking table is a tool that allows you to gather information about the domain names you are tracking.
|
||||
---
|
||||
|
||||

|
||||
|
||||
@ -5,7 +5,7 @@ description: Configuration guide explaining environment variables and settings r
|
||||
|
||||
import {LinkCard} from '@astrojs/starlight/components';
|
||||
|
||||
<LinkCard title="Install with Docker" href="/en/install-config/install/docker-compose"/>
|
||||
<LinkCard title="Install with Docker" href="/en/install-config/install/docker-compose/"/>
|
||||
|
||||
## Environment variables
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ git clone https://github.com/maelgangloff/domain-watchdog.git
|
||||
```shell
|
||||
cp .env .env.local
|
||||
```
|
||||
<LinkCard title="Configuration" description="List of environment variables" href="/en/install-config/configuration"/>
|
||||
<LinkCard title="Configuration" description="List of environment variables" href="/en/install-config/configuration/"/>
|
||||
|
||||
3. Generate the cryptographic key pair for the JWT signature
|
||||
```shell
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
---
|
||||
title: FAQ
|
||||
published: false
|
||||
---
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Cycle de vie d'un domaine
|
||||
description: Explorez le cycle de vie d'un domaine, de l'enregistrement et du renouvellement à l'expiration et la rédemption. Connaissez les phases critiques pour gérer votre nom de domaine.
|
||||
description: Explorez le cycle de vie d'un domaine, de l'enregistrement et du renouvellement à l'expiration et la rédemption. Découvrez les phases critiques pour gérer votre nom de domaine.
|
||||
---
|
||||
|
||||
import {LinkCard} from "@astrojs/starlight/components";
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Protocole EPP
|
||||
description: Qu'est-ce qu'un bureau d'enregistrement de noms de domaine ? Apprenez leur rôle dans la gestion de l'enregistrement et du transfert des noms de domaine pour le public.
|
||||
description: Qu'est-ce que le protocole EPP ? Découvrez comment ce protocole permet aux registres et bureaux d'enregistrement de communiquer au sujet des noms de domaines.
|
||||
---
|
||||
|
||||
import {LinkCard} from "@astrojs/starlight/components";
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Protocole RDAP
|
||||
description: Le protocole d'accès aux données moderne. Comprendre RDAP (Registration Data Access Protocol) pour un accès fiable et structuré aux données d'enregistrement et de propriété des domaines.
|
||||
description: Le protocole moderne d'accès aux informations publiques des domaines. Découvrez RDAP (Registration Data Access Protocol) pour un accès fiable et structuré aux données d'enregistrement et de propriété des domaines.
|
||||
---
|
||||
|
||||
import {LinkCard} from "@astrojs/starlight/components";
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Bureau d'enregistrement
|
||||
description: Qu'est-ce qu'un bureau d'enregistrement de noms de domaine ? Apprenez leur rôle dans la gestion de l'enregistrement et du transfert des noms de domaine pour le public.
|
||||
description: Qu'est-ce qu'un bureau d'enregistrement de noms de domaine ? Explorez leur rôle dans la gestion de l'enregistrement et du transfert des noms de domaine pour le public.
|
||||
---
|
||||
|
||||
import {LinkCard} from "@astrojs/starlight/components";
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Registre
|
||||
description: Comprendre le registre de noms de domaine. Apprenez comment ces organisations gèrent la base de données centrale pour tous les noms de domaine sous un TLD spécifique.
|
||||
description: Qu'est-ce qu'un registre de noms de domaine ? Découvrez comment ces organisations gèrent la base de données centrale pour tous les noms de domaine sous un TLD spécifique.
|
||||
---
|
||||
|
||||
import {LinkCard} from "@astrojs/starlight/components";
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Protocole WHOIS
|
||||
description: Obtenez un aperçu de WHOIS. Apprenez comment ce protocole est utilisé pour interroger des bases de données afin d'obtenir des informations sur l'utilisateur enregistré ou les attributaires d'un nom de domaine.
|
||||
description: Qu'est-ce que le protocole WHOIS ? Découvezz comment ce protocole est utilisé pour interroger des bases de données afin d'obtenir des informations sur un nom de domaine.
|
||||
---
|
||||
|
||||
import {LinkCard} from "@astrojs/starlight/components";
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
---
|
||||
title: Liste des TLD
|
||||
description: Découvrez la liste des TLD actuellement actifs directement dans votre interface, ainsi que des informations complémentaires à leur sujet.
|
||||
---
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Tableau de suivi
|
||||
description: Le tableau de suivi est un outil qui permet de rassembler les informations à propos des noms de domaines que vous suivez.
|
||||
---
|
||||
|
||||

|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user