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

docs: update documentation

Browse Source
This commit is contained in:
Maël Gangloff 2025-12-08 18:22:45 +01:00
parent 5476ee7acc
commit 1b141b6b11
No known key found for this signature in database
GPG Key ID: 11FDC81C24A7F629
3 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.env
View File

@ -86,6 +86,7 @@ LIMITED_FEATURES=false
LIMIT_MAX_WATCHLIST=0
LIMIT_MAX_WATCHLIST_DOMAINS=0
LIMIT_MAX_WATCHLIST_WEBHOOKS=0
PUBLIC_RDAP_LOOKUP_ENABLE=false
# STATISTICS
INFLUXDB_ENABLED=false

51
docs/src/content/docs/en/install-config/configuration.mdx
View File

@ -9,31 +9,32 @@ import {LinkCard} from '@astrojs/starlight/components';
## 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) | |
| `SSO_AUTO_REDIRECT` | Redirection to the SSO auth URL | `false` |
| 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) | |
| `SSO_AUTO_REDIRECT` | Redirect to the SSO auth URL | `false` |
| `PUBLIC_RDAP_LOOKUP_ENABLE` | Allow unauthenticated domain name name lookups | `false` |
## Authentication

1
docs/src/content/docs/fr/install-config/configuration.mdx
View File

@ -34,6 +34,7 @@ import {LinkCard} from '@astrojs/starlight/components';
| `OAUTH_USERINFO_URL` | URL des informations utilisateur (OAuth 2.0) | |
| `OAUTH_SCOPE` | Scope (OAuth 2.0) | |
| `SSO_AUTO_REDIRECT` | Redirection vers l'URL d'authentification du SSO | `false` |
| `PUBLIC_RDAP_LOOKUP_ENABLE` | Autoriser les recherches anonymes de domaines | `false` |
## Authentification