mirror of
https://github.com/maelgangloff/domain-watchdog.git
synced 2025-12-29 16:15:04 +00:00
104 lines
3.5 KiB
Markdown
104 lines
3.5 KiB
Markdown
# Domain Watchdog
|
|
|
|
Domain Watchdog is a standalone web application that collects open access information about domain names, helping users
|
|
track the history and changes associated with domain names.
|
|
|
|
## Why use it?
|
|
|
|
- **Historical Tracking**: Know the history of a domain name, from its inception to its release into the public domain.
|
|
- **Detailed Monitoring**: Follow the evolution of a domain name and the entities that manage it in detail.
|
|
- **Reverse Directory**: Discover domain names associated with an entity registered with a registrar.
|
|
|
|
Although the RDAP and WHOIS protocols allow you to obtain precise information about a domain, it is not possible to
|
|
perform a reverse search to discover a list of domain names associated with an entity. Additionally, accessing a
|
|
detailed history of events (ownership changes, renewals, etc.) is not feasible with these protocols.
|
|
|
|
## How it works?
|
|
|
|
The latest version of the WHOIS protocol was standardized in 2004 by RFC 3912.[^1] This protocol allows anyone to
|
|
retrieve key information concerning a domain name, an IP address, or an entity registered with a registry.
|
|
|
|
ICANN launched a global vote in 2023 to propose replacing the WHOIS protocol with RDAP. As a result, registries and
|
|
registrars will no longer be required to support WHOIS from 2025 (*WHOIS Sunset Date*).[^2]
|
|
|
|
Domain Watchdog uses the RDAP protocol, which will soon be the new standard for retrieving information concerning domain
|
|
names. The data is organized in a SQL database to minimize space by ensuring an entity is not repeated.
|
|
|
|
## Installation
|
|
|
|
To deploy a Domain Watchdog instance, please refer to the Symfony documentation
|
|
on [How to deploy a Symfony application](https://symfony.com/doc/current/deployment.html).
|
|
|
|
### Prerequisites
|
|
|
|
- PHP 8.2 or higher
|
|
- PostgreSQL
|
|
|
|
### Steps
|
|
|
|
Clone the repository:
|
|
|
|
```shell
|
|
git clone https://github.com/maelgangloff/domain-watchdog.git
|
|
```
|
|
|
|
Navigate to the project directory:
|
|
|
|
```shell
|
|
cd domain-watchdog
|
|
```
|
|
|
|
#### Backend
|
|
|
|
1. Install dependencies:
|
|
```shell
|
|
composer install
|
|
```
|
|
2. Set up your environment variables:
|
|
```shell
|
|
cp .env .env.local
|
|
```
|
|
3. Generate the cryptographic key pair for the JWT signature
|
|
```shell
|
|
php bin/console lexik:jwt:generate-keypair
|
|
```
|
|
4. Run database migrations:
|
|
```shell
|
|
php bin/console doctrine:migrations:migrate
|
|
```
|
|
```
|
|
5. Start the Symfony server:
|
|
```shell
|
|
symfony server:start
|
|
```
|
|
|
|
#### Frontend
|
|
|
|
1. Install dependencies:
|
|
```shell
|
|
yarn install
|
|
```
|
|
2. Generate language files:
|
|
```shell
|
|
yarn run ttag:po2json
|
|
```
|
|
3. Make the final build:
|
|
```shell
|
|
yarn build
|
|
```
|
|
|
|
> [!NOTE]
|
|
> ## Useful documentation
|
|
> - [RFC 7482 : Registration Data Access Protocol (RDAP) Query Format](https://datatracker.ietf.org/doc/html/rfc7482)
|
|
> - [RFC 7483 : JSON Responses for the Registration Data Access Protocol (RDAP)](https://datatracker.ietf.org/doc/html/rfc7483)
|
|
> - [RFC 7484 : Finding the Authoritative Registration Data (RDAP) Service](https://datatracker.ietf.org/doc/html/rfc7484)
|
|
|
|
## Licensing
|
|
|
|
This entire project is licensed under *GNU Affero General Public License v3.0 or later*.
|
|
Contributions are welcome as long as they do not contravene the Code of Conduct.
|
|
|
|
[^1]: RFC 3912 : WHOIS Protocol Specification. (2004). IETF Datatracker. https://datatracker.ietf.org/doc/html/rfc3912
|
|
[^2]: 2023 Global Amendments to the Base gTLD Registry Agreement (RA), Specification 13, and 2013 Registrar
|
|
Accreditation Agreement (RAA) - ICANN. (s. d.). https://www.icann.org/resources/pages/global-amendment-2023-en
|