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:
Maël Gangloff
parent
e040f484c9
commit
4f35d9f8b5
@ -2,26 +2,24 @@
|
||||
title: Connector
|
||||
---
|
||||
|
||||
import {LinkCard} from '@astrojs/starlight/components';
|
||||
import {LinkCard, Steps} from '@astrojs/starlight/components';
|
||||
|
||||
A Connector allows Domain Watchdog to communicate with an external domain registrar’s API to perform actions such as
|
||||
domain registration.
|
||||
|
||||
## Create a Connector
|
||||
|
||||
<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="../supported-registrar"/>
|
||||
|
||||
<LinkCard title="Supported registrar" description="List of supported registrars for creating a Connector" href="../supported-registrar"/>
|
||||
2. Enter the required information using the credentials obtained from your provider’s customer area
|
||||
|
||||
:::tip{icon="heart"}
|
||||
A link allows you to directly access the Provider's page to retrieve this authentication information
|
||||
:::
|
||||
|
||||
:::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 🎉**
|
||||
</Steps>
|
||||
|
||||
## Legal considerations
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: Getting started
|
||||
description: Step-by-step guide to creating an account, searching domains, tracking changes, and enabling auto-purchase with Connectors.
|
||||
---
|
||||
|
||||
import {LinkCard} from '@astrojs/starlight/components';
|
||||
import {LinkCard, Steps} from '@astrojs/starlight/components';
|
||||
|
||||
On this page, you'll find a step-by-step guide to getting started with **Domain Watchdog** and exploring its main
|
||||
features. The sidebar menu on the left allows you to quickly navigate between all documentation sections.
|
||||
@ -21,9 +21,11 @@ If your instance allows user registration, you can create an account directly fr
|
||||
|
||||
|
||||
|
||||
<Steps>
|
||||
1. Click the **Register** button.
|
||||
2. Enter your **email address** and **password**.
|
||||
3. A confirmation email will be sent to verify your address.
|
||||
</Steps>
|
||||
|
||||
After confirming your email, you can log in and start using all available features.
|
||||
|
||||
@ -36,29 +38,33 @@ domain names.
|
||||
|
||||
|
||||
|
||||
:::tip[Read more]
|
||||
To read the documentation related to domain name search, please click on the link below.
|
||||
|
||||
<LinkCard title="Domain search"
|
||||
description="Obtain the details of a domain name registration and the history of observed events"
|
||||
href="../features/search/domain-search"/>
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Create a Watchlist
|
||||
|
||||
A **Watchlist** is a collection of domain names, triggers, and optionally an API Connector.
|
||||
A **Watchlist** is a collection of domain names, triggers, and optionally an API Connector.
|
||||
It allows you to:
|
||||
- monitor domain status changes,
|
||||
- receive notifications (email or webhook: Slack, Mattermost, Discord, etc.),
|
||||
- optionally auto-purchase a domain when it expires.
|
||||
- monitor domain status changes
|
||||
- receive notifications (email or webhook: Slack, Mattermost, Discord, etc.)
|
||||
- optionally auto-purchase a domain when it expires
|
||||
|
||||
|
||||
|
||||
:::tip[Read more]
|
||||
To read the documentation related to the Watchlist, please click on the link below.
|
||||
|
||||
<LinkCard title="Watchlist"
|
||||
description="Add domain names to aWatchlist to track them, be notified of any changes, and potentially buy them when they expire"
|
||||
description="Add domain names to a Watchlist to track them, be notified of any changes, and potentially buy them when they expire"
|
||||
href="../features/tracking/watchlist"/>
|
||||
:::
|
||||
|
||||
### Watchlist notifications
|
||||
|
||||
@ -73,11 +79,13 @@ A **Connector** is used to automatically order (backorder) a domain name using i
|
||||
|
||||
|
||||
|
||||
:::tip[Read more]
|
||||
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="../features/backorder/connector"/>
|
||||
:::
|
||||
|
||||
### Supported registrar list
|
||||
|
||||
@ -94,8 +102,10 @@ This list is ordered, meaning the domain names are arranged according to their e
|
||||
|
||||
|
||||
|
||||
:::tip[Read more]
|
||||
To read the documentation related to the Tracking table, please click on the link below.
|
||||
|
||||
<LinkCard title="Tracking table"
|
||||
description="List all the domains you're monitoring in your Watchlist and track the status of those domains"
|
||||
href="../features/tracking/tracking-table"/>
|
||||
:::
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Watchlist
|
||||
---
|
||||
import {Steps} from '@astrojs/starlight/components';
|
||||
|
||||
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.
|
||||
@ -15,11 +16,13 @@ possible to predict in advance which user will win the domain name. The choice i
|
||||
|
||||
## Create a Watchlist
|
||||
|
||||
<Steps>
|
||||
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 🎉**
|
||||
</Steps>
|
||||
|
||||
Now, it's your turn to create a Watchlist!
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Manual Install
|
||||
---
|
||||
|
||||
import {LinkCard} from '@astrojs/starlight/components';
|
||||
import {LinkCard, Steps} from '@astrojs/starlight/components';
|
||||
|
||||
## Installation
|
||||
|
||||
@ -29,59 +29,62 @@ git clone https://github.com/maelgangloff/domain-watchdog.git
|
||||
|
||||
#### Backend
|
||||
|
||||
<Steps>
|
||||
1. Install dependencies:
|
||||
```shell
|
||||
composer install
|
||||
```
|
||||
```shell
|
||||
composer install
|
||||
```
|
||||
2. Set up your environment variables:
|
||||
```shell
|
||||
cp .env .env.local
|
||||
```
|
||||
|
||||
<LinkCard title="Configuration" description="List of environment variables" href="../configuration"/>
|
||||
```shell
|
||||
cp .env .env.local
|
||||
```
|
||||
<LinkCard title="Configuration" description="List of environment variables" href="../configuration"/>
|
||||
|
||||
3. Generate the cryptographic key pair for the JWT signature
|
||||
```shell
|
||||
php bin/console lexik:jwt:generate-keypair
|
||||
```
|
||||
```shell
|
||||
php bin/console lexik:jwt:generate-keypair
|
||||
```
|
||||
4. Run database migrations:
|
||||
```shell
|
||||
php bin/console doctrine:migrations:migrate
|
||||
```
|
||||
```shell
|
||||
php bin/console doctrine:migrations:migrate
|
||||
```
|
||||
5. Start the Symfony server:
|
||||
```shell
|
||||
symfony server:start
|
||||
```
|
||||
```shell
|
||||
symfony server:start
|
||||
```
|
||||
6. Build assets:
|
||||
```shell
|
||||
php bin/console assets:install
|
||||
```
|
||||
```shell
|
||||
php bin/console assets:install
|
||||
```
|
||||
7. Don't forget to set up workers to process the [message queue](https://symfony.com/doc/current/messenger.html)
|
||||
</Steps>
|
||||
|
||||
#### Frontend
|
||||
|
||||
<Steps>
|
||||
1. Install dependencies:
|
||||
```shell
|
||||
yarn install
|
||||
```
|
||||
```shell
|
||||
yarn install
|
||||
```
|
||||
2. Generate language files:
|
||||
```shell
|
||||
yarn run ttag:po2json
|
||||
```
|
||||
```shell
|
||||
yarn run ttag:po2json
|
||||
```
|
||||
3. Make the final build:
|
||||
```shell
|
||||
yarn build
|
||||
```
|
||||
```shell
|
||||
yarn build
|
||||
```
|
||||
4. Add and modify the following files as you wish:
|
||||
~~~
|
||||
public/content/home.md
|
||||
public/content/privacy.md
|
||||
public/content/tos.md
|
||||
public/content/faq.md
|
||||
public/images/icons-512.png
|
||||
public/images/banner.png
|
||||
public/favicon.ico
|
||||
~~~
|
||||
~~~
|
||||
public/content/home.md
|
||||
public/content/privacy.md
|
||||
public/content/tos.md
|
||||
public/content/faq.md
|
||||
public/images/icons-512.png
|
||||
public/images/banner.png
|
||||
public/favicon.ico
|
||||
~~~
|
||||
</Steps>
|
||||
|
||||
## Update
|
||||
|
||||
@ -95,34 +98,38 @@ git pull origin master
|
||||
|
||||
### Backend
|
||||
|
||||
<Steps>
|
||||
1. Install dependencies:
|
||||
```shell
|
||||
composer install
|
||||
```
|
||||
```shell
|
||||
composer install
|
||||
```
|
||||
2. Run database migrations:
|
||||
```shell
|
||||
php bin/console doctrine:migrations:migrate
|
||||
```
|
||||
```shell
|
||||
php bin/console doctrine:migrations:migrate
|
||||
```
|
||||
3. Clearing the Symfony cache:
|
||||
```shell
|
||||
php bin/console cache:clear
|
||||
```
|
||||
```shell
|
||||
php bin/console cache:clear
|
||||
```
|
||||
4. Build assets:
|
||||
```shell
|
||||
php bin/console assets:install
|
||||
```
|
||||
```shell
|
||||
php bin/console assets:install
|
||||
```
|
||||
</Steps>
|
||||
|
||||
### Frontend
|
||||
|
||||
<Steps>
|
||||
1. Install dependencies:
|
||||
```shell
|
||||
yarn install
|
||||
```
|
||||
```shell
|
||||
yarn install
|
||||
```
|
||||
2. Generate language files:
|
||||
```shell
|
||||
yarn run ttag:po2json
|
||||
```
|
||||
```shell
|
||||
yarn run ttag:po2json
|
||||
```
|
||||
3. Make the final build:
|
||||
```shell
|
||||
yarn build
|
||||
```
|
||||
```shell
|
||||
yarn build
|
||||
```
|
||||
</Steps>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user