docs: update documentation

This commit is contained in:
Maël Gangloff 2025-11-13 15:51:27 +01:00
parent e5a28514c5
commit 94291f2a30
No known key found for this signature in database
GPG Key ID: 11FDC81C24A7F629
25 changed files with 469 additions and 130 deletions

View File

@ -1,118 +1,87 @@
# Code of conduct # Contributor Covenant 3.0 Code of Conduct
## Our Pledge ## Our Pledge
We as members, contributors, and leaders pledge to make participation in our We pledge to make our community welcoming, safe, and equitable for all.
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our ## Encouraged Behaviors
community include:
* Demonstrating empathy and kindness toward other people While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include: With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
* The use of sexualized language or imagery, and sexual attention or advances of 1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
any kind 2. Engaging **kindly and honestly** with others.
* Trolling, insulting or derogatory comments, and personal or political attacks 3. Respecting **different viewpoints** and experiences.
* Public or private harassment 4. **Taking responsibility** for our actions and contributions.
* Publishing others' private information, such as a physical or email address, 5. Gracefully giving and accepting **constructive feedback**.
without their explicit permission 6. Committing to **repairing harm** when it occurs.
* Other conduct which could reasonably be considered inappropriate in a 7. Behaving in other ways that promote and sustain the **well-being of our community**.
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of ## Restricted Behaviors
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive, We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
or harmful.
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
3. **Stereotyping or discrimination.** Characterizing anyones personality or behavior on the basis of immutable identities or traits.
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
7. Behaving in other ways that **threaten the well-being** of our community.
### Other Restrictions
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
## Reporting an Issue
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
When an incident does occur, it is important to report it promptly. To report a possible violation, please contact the maintainer.
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
## Addressing and Repairing Harm
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
1) Warning
1) Event: A violation involving a single incident or series of incidents.
2) Consequence: A private, written warning from the Community Moderators.
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
2) Temporarily Limited Activities
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
3) Temporary Suspension
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
4) Permanent Ban
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
3) Repair: There is no possible repair in cases of this severity.
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope ## Scope
This Code of Conduct applies within all community spaces, and also applies when This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at contact@maelgangloff.fr.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)

View File

@ -163,7 +163,7 @@ export default function App(): React.ReactElement {
<Link to='/faq'><Button type='text'>{t`FAQ`}</Button></Link> <Link to='/faq'><Button type='text'>{t`FAQ`}</Button></Link>
<Typography.Link <Typography.Link
target='_blank' target='_blank'
href='https://github.com/maelgangloff/domain-watchdog/wiki' href='https://domainwatchdog.eu'
> >
<Button type='text'> <Button type='text'>
{t`Documentation`} {t`Documentation`}

View File

@ -10,7 +10,7 @@ export default function NamecheapConnectorForm() {
label={t`Username`} label={t`Username`}
name={['authData', 'ApiUser']} name={['authData', 'ApiUser']}
help={<Typography.Link target='_blank' href='https://ap.www.namecheap.com/settings/tools/apiaccess/'> help={<Typography.Link target='_blank' href='https://ap.www.namecheap.com/settings/tools/apiaccess/'>
{t`Retreive an API key and whitelist this instance's IP address on Namecheap's website`} {t`Retrieve an API key and whitelist this instance's IP address on Namecheap's website`}
</Typography.Link>} </Typography.Link>}
> >
<Input prefix={<UserOutlined/>} autoComplete='off'/> <Input prefix={<UserOutlined/>} autoComplete='off'/>

View File

@ -37,7 +37,6 @@ export default defineConfig({
{ {
label: 'Developing', label: 'Developing',
items: [ items: [
{label: 'Getting started', slug: 'developing/getting-started'},
{slug: 'developing/technical-stack'}, {slug: 'developing/technical-stack'},
{slug: 'developing/translation'}, {slug: 'developing/translation'},
{label: 'Contributing', autogenerate: {directory: 'developing/contributing'}} {label: 'Contributing', autogenerate: {directory: 'developing/contributing'}}

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

View File

@ -0,0 +1,3 @@
---
title: Add a provider
---

View File

@ -1,3 +1,89 @@
--- ---
title: Code of Conduct title: Code of Conduct
--- ---
## Our Pledge
We pledge to make our community welcoming, safe, and equitable for all.
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
## Encouraged Behaviors
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
2. Engaging **kindly and honestly** with others.
3. Respecting **different viewpoints** and experiences.
4. **Taking responsibility** for our actions and contributions.
5. Gracefully giving and accepting **constructive feedback**.
6. Committing to **repairing harm** when it occurs.
7. Behaving in other ways that promote and sustain the **well-being of our community**.
## Restricted Behaviors
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
3. **Stereotyping or discrimination.** Characterizing anyones personality or behavior on the basis of immutable identities or traits.
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
7. Behaving in other ways that **threaten the well-being** of our community.
### Other Restrictions
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
## Reporting an Issue
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
When an incident does occur, it is important to report it promptly. To report a possible violation, please contact the maintainer.
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
## Addressing and Repairing Harm
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
1) Warning
1) Event: A violation involving a single incident or series of incidents.
2) Consequence: A private, written warning from the Community Moderators.
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
2) Temporarily Limited Activities
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
3) Temporary Suspension
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
4) Permanent Ban
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
3) Repair: There is no possible repair in cases of this severity.
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Attribution
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)

View File

@ -1,3 +0,0 @@
---
title: Guidelines
---

View File

@ -1,3 +1,48 @@
--- ---
title: Pull Requests title: Pull Requests
--- ---
When you want to propose a change to the source code, you will need to create a Pull Request on this project's GitHub
repository.
Note that if you are modifying several different parts, you should split it into multiple Pull Requests. This will make
it easier to review and merge your proposals.
You will then be asked to fill in a few fields:
## Title
The Pull Request title should briefly describe the proposed changes. Please be concise and precise. For example, to add
support for a new, fictitious provider called "FakeRegistrar," you could write something like "Add support for
FakeRegistrar provider".
## Description
For complex changes, please provide as much detail as possible. If your changes modify an existing API, you must mention
this in the description, as it may have repercussions on projects related to Domain Watchdog.
If the proposal modifies the frontend, it would be best to include screenshots (desktop and mobile versions) to better
visualize the proposal.
## Change Type
A checklist allows you to choose the type of change proposed:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
This checklist helps to better identify the project's impact on the PR.
## Compliance Checklist
The checklist below allows you to self-assess the conformity of your proposal before submitting it for review:
- [x] Commit names follow the Conventional Commits convention
- [x] I have checked the entire code before submitting it
- [x] I have updated the documentation related to my commits
- [x] My code does not generate errors
In any case, if you experience any difficulties creating a PR, feel free to open one; we will help you ensure it
complies with these requirements.

View File

@ -1,3 +0,0 @@
---
title: Getting started
---

View File

@ -1,3 +1,66 @@
--- ---
title: Technical stack title: Technical stack
--- ---
This page lists the main technologies used in the project, with links to their reference documentation. Specific version
information can be found in the projects dependency files (`composer.lock`, `package.json`, etc.). The architecture
diagram below summarizes how these services interact.
![Technical stack diagram](../../../../assets/images/dw-stack-diagram.png)
## Backend
### Framework
The programming language is **PHP**.
The backend is developed using the **Symfony** framework ([reference documentation](https://symfony.com/doc)).
The API is made possible by the **API Platform**
project ([reference documentation](https://api-platform.com/docs/symfony/)).
### SQL database
This project requires a **PostgreSQL** database ([reference documentation](https://www.postgresql.org/docs/current/)).
Other database types cannot be used because some migrations were specifically written to leverage the performance of
this database management system.
### Key-value database
A **Redis-compatible** key-value database is required to:
- Cache certain values
- Implement locks to limit the possibility of conditional raises
- Store messages to be distributed to workers to process asynchronous actions. For example: updating domain names in a
Watchlist on a high-priority RDAP client queue.
## Time Series database
The **InfluxDB** database is optional.
A data point is added for the following events:
- RDAP requests from your instance: response time, requested domain name, HTTP status code, IP address of the RDAP
server, etc.
- User notifications: adding events to a domain name, changing EPP statuses, etc.
### SSO authentication
An **OAuth 2.0** server is not required to authenticate users.
Using Single Sign-On (SSO) allows you to delegate user authentication to a third party. This can be useful if you only
want people within your organization to be able to use this project instance. Furthermore, you can then configure
advanced security policies such as passwordless login, passkeys, multifactor authentication, and more.
___
## Frontend
### Framework
The language for frontend development is **TypeScript**.
The framework used for the frontend is **React** ([reference documentation](https://react.dev/reference/react)).
### Component Library
The component library used is **Ant Design** ([reference documentation](https://ant.design/components/overview/)).

View File

@ -1,3 +1,36 @@
--- ---
title: Connector title: Connector
--- ---
A Connector allows Domain Watchdog to communicate with an external domain registrars API to perform actions such as
domain registration.
## Create a Connector
1. Choose an external API provider from the list of [supported registrars](../supported-registrar)
2. Enter the required information using the credentials obtained from your providers customer area
:::tip{icon="heart"}
A link allows you to directly access the Provider's page to retrieve this authentication information
:::
3. Review and consent to the required terms. As a reminder, you can delete a Connector at any time from your personal
space.
4. Click the button to create your Connector. **Congratulations 🎉**
## Legal considerations
These legal requirements ensure that all domain operations comply with registrar policies and applicable regulations.
Domain Watchdog acts only as a technical interface and does not serve as a payment intermediary.
Your credentials are transmitted directly to the providers API for domain operations.
By creating a Connector, you consent to the providers terms and the use of your credentials for authorized operations.
In particular, you must consent to:
- Accept the providers API Terms of Use
- Confirm that you are of legal age to accept these terms
- Waive any right of withdrawal, as domain names are reserved immediately and made available to you
Since the terms of use may change at any time, the link to these terms is always accessible on the page listing the
Connectors.

View File

@ -1,3 +1,75 @@
--- ---
title: Supported registrar title: Supported registrar
--- ---
:::caution[Reminder]
* Please note that this project is NOT affiliated IN ANY WAY with the API Providers used to order domain names.
* The project installers are responsible for the use of their own instance.
* Under no circumstances will the owner of this project be held responsible for other cases over which he has no
control.
:::
## OVH
| Field | Description | Required |
|----------------|----------------------------------------------------------------------------------|:--------:|
| App key | the key that allows OVH to identify your application | Required |
| App secret key | the secret key associated with your application | Required |
| Consumer key | the secret key that links the application to your account | Required |
| Endpoint | allows you to choose which server to use (Europe, United States or Canada) | Required |
| Subsidiary | the country linked to the OVH subsidiary associated with your account | Required |
| Pricing mode | choose whether you want to pay for a Premium domain name or only standard prices | Required |
## Gandi
| Field | Description | Required |
|------------|------------------------------------------------------------------|:--------:|
| Token | your account authentication token | Required |
| Sharing ID | indicates the organization that will pay for the ordered product | Optional |
## Namecheap
:::caution
This provider requires that the IPv4 address of your instance be entered on its web interface when creating the API
connection. This information must also be entered in the configuration.
:::
| Field | Description | Required |
|----------|---------------------------------------|:--------:|
| API user | the API user as given by the Provider | Required |
| API key | the API key as given by the Provider | Required |
## AutoDNS
:::caution
This provider does not provide a list of supported TLD. Please double-check if the domain you want to register is
supported.
:::
| Field | Description | Required |
|---------------|---------------------------------------------------------------|:--------:|
| Username | the account username | Required |
| Password | the account password | Required |
| Owner consent | purchase consent | Required |
| Context | the "context" as given by the Provider | Required |
| Contact ID | Contact ID of the domain name holder of the purchased domains | Required |
## Name.com
:::caution
This provider does not provide a list of supported TLD. Please double-check if the domain you want to register is
supported.
:::
| Field | Description | Required |
|----------|-----------------------------------|:--------:|
| Username | the account username | Required |
| Token | your account authentication token | Required |
## Custom EPP server
This type of connector allows you to directly link your instance to a registry via the EPP protocol.
This requires that you have signed a contract with a registry; you are then considered a registry in your own right.
Currently, the implementation of this feature has not been tested; your feedback is important!

View File

@ -1,3 +1,29 @@
--- ---
title: Getting started title: Getting started
--- ---
On this page, you'll find a step-by-step guide to getting started with Domain Watchdog and exploring its features.
:::note
Depending on the configuration of the instance on which you're performing these actions, your options may be
limited.
:::
The sidebar menu on the left allows you to quickly navigate between the pages, which are described below.
## Create an account
If your configuration allows, you can create an account directly in the interface. First, click the registration button
and enter an email address and password.
A confirmation email will be sent to you to verify your email address.
## Search for a domain name
## Create a Watchlist
## Create a Connector
## TLD list
## ICANN-accredited registrar list

View File

@ -1,3 +1,9 @@
--- ---
title: Domain search title: Domain search
--- ---
:::tip[Did you know?]
In this project, everything is done to minimize the number of requests to RDAP servers. Limitations imposed on end users
help to control the flow of RDAP requests. These limitations can be configured for each instance, in the environment
variables.
:::

View File

@ -1,3 +1,31 @@
--- ---
title: Watchlist title: Watchlist
--- ---
A Watchlist is a list of domain names, triggers and possibly an API connector. They allow you to follow the life of the
listed domain names and send you a notification when a change has been detected.
If a domain has expired and a connector is linked to the Watchlist, then Domain Watchdog will try to order it via the
connector provider's API.
:::note
If the same domain name is present on several Watchlists, on the same principle as the raise condition, it is not
possible to predict in advance which user will win the domain name. The choice is left to chance...
:::
## Create a Watchlist
1. Choose a name for your Watchlist and find it more easily
2. Add the domain names you want to follow
3. Select the events for which you want to receive an email notification
4. Optionally add a connector to try to automatically buy a domain name that becomes available
5. Click the button to create your Watchlist. **Congratulations 🎉**
Now, it's your turn to create a Watchlist!
## Limitations
Depending on the instance configuration, there are several limitations to frame user behavior:
* `LIMIT_MAX_WATCHLIST` : Maximum number of Watchlists that can be created
* `LIMIT_MAX_WATCHLIST_DOMAINS` : Maximum number of domain names for each Watchlist

View File

@ -10,7 +10,7 @@ hero:
- text: Get started - text: Get started
link: /en/features link: /en/features
icon: right-arrow icon: right-arrow
- text: Demo instance - text: Demo
link: https://demo.domainwatchdog.eu link: https://demo.domainwatchdog.eu
icon: external icon: external
variant: minimal variant: minimal

View File

@ -1,3 +1,6 @@
--- ---
title: License title: License
--- ---
This entire project is licensed under [*GNU Affero General Public License v3.0 or later*](https://www.gnu.org/licenses/agpl-3.0.txt).
Contributions are welcome as long as they do not contravene the Code of Conduct.

View File

@ -1,3 +0,0 @@
---
title: Privacy policy
---

View File

@ -1,3 +1,14 @@
--- ---
title: Security title: Security policy
--- ---
## Reporting a Vulnerability
If you want to report a vulnerability, please contact the maintainer of this repository. Thanks!
~~~
Contact: mailto:contact@maelgangloff.fr
Encryption: openpgp4fpr:323E63F1AB879F30B38F527611FDC81C24A7F629
Encryption: https://maelgangloff.fr/pgp-key.txt
Preferred-Languages: fr, en
~~~

View File

@ -1,3 +0,0 @@
---
title: Terms of service
---

View File

@ -1,3 +1,3 @@
--- ---
title: Install with Docker title: Install with Docker
--- ---

View File

@ -1,3 +1,10 @@
--- ---
title: Getting started title: Getting started
--- ---
## Authentication
Currently, there is no way to delete your account, reset your password, or enable multifactor authentication.
Registering users directly in the interface is recommended for individual instances. For multi-user environments, the
recommended method is to use external SSO via the OAuth 2.0 protocol.

View File

@ -69,6 +69,6 @@
"watch": "encore dev --watch", "watch": "encore dev --watch",
"build": "encore production --progress", "build": "encore production --progress",
"ttag:po2json": "cd translations; for i in $(find . -name \"*.po\"); do ttag po2json $i > ../public/locales/$i.json; done; cd ..", "ttag:po2json": "cd translations; for i in $(find . -name \"*.po\"); do ttag po2json $i > ../public/locales/$i.json; done; cd ..",
"ttag:extract": "ttag extract $(find assets -name 'assets/*.ts' -or -name 'assets/*.tsx' | sort) -o translations/translations.pot" "ttag:extract": "ttag extract $(find assets -name '*.ts' -or -name '*.tsx' | sort) -o translations/translations.pot"
} }
} }

View File

@ -1452,7 +1452,7 @@ msgstr ""
#: assets/utils/providers/forms/NamecheapConnectorForm.tsx:13 #: assets/utils/providers/forms/NamecheapConnectorForm.tsx:13
msgid "" msgid ""
"Retreive an API key and whitelist this instance's IP address on Namecheap's " "Retrieve an API key and whitelist this instance's IP address on Namecheap's "
"website" "website"
msgstr "" msgstr ""