External/domain-watchdog
1
0
Fork 0
mirror of https://github.com/maelgangloff/domain-watchdog.git synced 2025-12-29 16:15:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update documentation

Browse Source
This commit is contained in:
Maël Gangloff
2025-11-13 18:19:27 +01:00
parent 22568c0e31
commit d0f03570b8
4 changed files with 67 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/src/content/docs/en/developing/technical-stack.md
View File

@@ -2,7 +2,7 @@
title: Technical stack
---
This page lists the main technologies used in the project, with links to their reference documentation. Specific version
This page lists the main technologies used in the project, with links to their documentation. Specific version
information can be found in the project’s dependency files (`composer.lock`, `package.json`, etc.). The architecture
diagram below summarizes how these services interact.
@@ -14,14 +14,14 @@ diagram below summarizes how these services interact.
The programming language is **PHP**.
The backend is developed using the **Symfony** framework ([reference documentation](https://symfony.com/doc)).
The backend is developed using the **Symfony** framework ([documentation](https://symfony.com/doc)).
The API is made possible by the **API Platform**
project ([reference documentation](https://api-platform.com/docs/symfony/)).
project ([documentation](https://api-platform.com/docs/symfony/)).
### SQL database
This project requires a **PostgreSQL** database ([reference documentation](https://www.postgresql.org/docs/current/)).
This project requires a **PostgreSQL** database ([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.
@@ -59,8 +59,8 @@ ___
The language for frontend development is **TypeScript**.
The framework used for the frontend is **React** ([reference documentation](https://react.dev/reference/react)).
The framework used for the frontend is **React** ([documentation](https://react.dev/reference/react)).
### Component Library
The component library used is **Ant Design** ([reference documentation](https://ant.design/components/overview/)).
The component library used is **Ant Design** ([documentation](https://ant.design/components/overview/)).

43
docs/src/content/docs/en/self-hosting/configuration.mdx Normal file
View File

@@ -0,0 +1,43 @@
---
title: Configuration
---
import {LinkCard} from '@astrojs/starlight/components';
## Docker
<LinkCard title="Install with Docker" href="../docker-install"/>
## Environment variables
| Variable | Description | Default |
|--------------------------------|----------------------------------------------|:---------------------------:|
| `DATABASE_URL` | Please check Symfony config | |
| `OUTGOING_IP` | Outgoing IPv4, needed for some providers | |
| `INFLUXDB_ENABLED` | Enable the connection with InfluxDB | `false` |
| `INFLUXDB_URL` | InfluxDB URL | `http://localhost:8086` |
| `INFLUXDB_TOKEN` | InfluxDB token | |
| `INFLUXDB_BUCKET` | InfluxDB bucket name | `domainwatchdog` |
| `INFLUXDB_ORG` | InfluxDB organization | `domainwatchdog` |
| `LIMITED_FEATURES` | Limit certain features for users | `false` |
| `LIMIT_MAX_WATCHLIST` | Maximum number of Watchlists per user | `0` |
| `LIMIT_MAX_WATCHLIST_DOMAINS` | Maximum number of domains per Watchlist | `0` |
| `LIMIT_MAX_WATCHLIST_WEBHOOKS` | Maximum number of webhooks per Watchlist | `0` |
| `MAILER_SENDER_NAME` | Name of the sender of emails | `Domain Watchdog` |
| `MAILER_SENDER_EMAIL` | Sender's email address | `notifications@example.com` |
| `REGISTRATION_ENABLED` | Enable user registration | `true` |
| `REGISTRATION_VERIFY_EMAIL` | Verify email addresses during registration | `false` |
| `MAILER_DSN` | Please check Symfony config | `null://null` |
| `OAUTH_CLIENT_ID` | Client ID (OAuth 2.0) for using external SSO | |
| `OAUTH_CLIENT_SECRET` | Client secret (OAuth 2.0) | |
| `OAUTH_AUTHORIZATION_URL` | Authorization URL (OAuth 2.0) | |
| `OAUTH_TOKEN_URL` | Token URL (OAuth 2.0) | |
| `OAUTH_USERINFO_URL` | User Info URL (OAuth 2.0) | |
| `OAUTH_SCOPE` | Scope (OAuth 2.0) | |
## 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.

18
docs/src/content/docs/en/self-hosting/docker-install.md
View File

@@ -1,3 +1,21 @@
---
title: Install with Docker
---
1. Download the [docker-compose.yml](https://github.com/maelgangloff/domain-watchdog/blob/develop/docker-compose.yml)
and modify it as needed
2. Download the [.env](https://github.com/maelgangloff/domain-watchdog/blob/develop/.env) and modify it as needed
3. Add static files to customize your instance (under `public/content`)
4. Pull the latest version of the Domain Watchdog image from Docker Hub
```shell
docker compose pull
```
5. Start the project in production environment
```shell
docker compose up
```
By default, the container listens on http://localhost:8080, but you can configure this in environment variables.

10
docs/src/content/docs/en/self-hosting/getting-started.md
View File

@@ -1,10 +0,0 @@
---
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.