From d0f03570b8661e130dd179051d7c9c0f6e894c13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= Date: Thu, 13 Nov 2025 18:19:27 +0100 Subject: [PATCH] docs: update documentation --- .../docs/en/developing/technical-stack.md | 12 +++--- .../docs/en/self-hosting/configuration.mdx | 43 +++++++++++++++++++ .../docs/en/self-hosting/docker-install.md | 18 ++++++++ .../docs/en/self-hosting/getting-started.md | 10 ----- 4 files changed, 67 insertions(+), 16 deletions(-) create mode 100644 docs/src/content/docs/en/self-hosting/configuration.mdx delete mode 100644 docs/src/content/docs/en/self-hosting/getting-started.md diff --git a/docs/src/content/docs/en/developing/technical-stack.md b/docs/src/content/docs/en/developing/technical-stack.md index 0927f0a..72a9676 100644 --- a/docs/src/content/docs/en/developing/technical-stack.md +++ b/docs/src/content/docs/en/developing/technical-stack.md @@ -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/)). diff --git a/docs/src/content/docs/en/self-hosting/configuration.mdx b/docs/src/content/docs/en/self-hosting/configuration.mdx new file mode 100644 index 0000000..6202f1e --- /dev/null +++ b/docs/src/content/docs/en/self-hosting/configuration.mdx @@ -0,0 +1,43 @@ +--- +title: Configuration +--- + +import {LinkCard} from '@astrojs/starlight/components'; + +## Docker + + +## 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. diff --git a/docs/src/content/docs/en/self-hosting/docker-install.md b/docs/src/content/docs/en/self-hosting/docker-install.md index 95238a4..ea770cc 100644 --- a/docs/src/content/docs/en/self-hosting/docker-install.md +++ b/docs/src/content/docs/en/self-hosting/docker-install.md @@ -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. diff --git a/docs/src/content/docs/en/self-hosting/getting-started.md b/docs/src/content/docs/en/self-hosting/getting-started.md deleted file mode 100644 index 8e941b6..0000000 --- a/docs/src/content/docs/en/self-hosting/getting-started.md +++ /dev/null @@ -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.