Fichiers de configuration

vanityURLs garde les valeurs par défaut du produit, les choix propres à l’instance, les réglages locaux du poste et les artefacts runtime générés dans des fichiers séparés.

Utilisez cette page pour identifier les fichiers de configuration actuels et la forme de schéma que chacun suit. Le contrat exact reste les fichiers Git et les scripts dans le dépôt de code.

Configuration source

Configuration du site

custom/v8s-site-config.json est le principal fichier de setup écrit par npm run setup. Il stocke les réglages de site propres à l’instance, dont les langues, la marque, les contacts opérateur, le mode des pages légales et les surcharges de la CLI de liens. La liste exacte des champs est définie par defaults/v8s-site-config.json et l’installateur. Le build fusionne en profondeur la configuration de site par défaut et custom, donc les valeurs par défaut additives peuvent arriver par defaults/ sans réécrire votre fichier custom. Les sections principales importantes sont :

Exemple :

{
  "schema_version": "1.0",
  "i18n": {
    "default_language": "en",
    "supported_languages": ["en", "fr"]
  },
  "links": {
    "random_slug_length": 3,
    "random_slug_alphabet": "34789abcdefghjkmnpqrstvwxy",
    "tag_random_slug_lengths": {
      "training": 4,
      "debug": 2
    }
  },
  "operator": {
    "legal_name": "Example Inc.",
    "short_domain": "example.link",
    "operator_domain": "example.com",
    "abuse_contact": "abuse@example.com",
    "security_contact": "security@example.com",
    "timezone": "America/Toronto",
    "abuse_response_window": "5 business days",
    "legal_pages_enabled": false
  },
  "branding": {
    "domain": "example.link",
    "slogan": {
      "en": "A short-link service for Example Inc.'s projects",
      "fr": "Un service de liens courts pour les projets de Example Inc."
    },
    "custom_public": true,
    "wordmark": {
      "black": "example.",
      "green": "link"
    }
  }
}

Des champs additifs peuvent apparaitre sans changer schema_version. Les changements de version de schéma sont réserves aux changements incompatibles de configuration stockee qui demandent une migration; la décision est consignée dans les ADR du dépôt de code. Les champs additifs sont suivis dans docs/schema-changelog.md du dépôt de code.

Configuration générée

Ordre de surcharge publique

Le build des assets publics est détérministe :

1. copier defaults/public/ dans build/
2. appliquer custom/public/ lorsqu’il existe
3. copier le defaults/public/_stats/index.html par défaut
4. appliquer custom/public/_stats/index.html lorsqu’il existe
5. retirer les répertoires de langues non supportées selon v8s-site-config.json
6. construire v8s.json, v8s-blocklist.json, et v8s-site-config.json
7. génèrer src/ depuis scripts/workers/ pour Wrangler

Artefacts runtime

Le Worker ne lit pas v8s-links.txt à chaque requête. Le build crée les artefacts runtime depuis les fichiers source, les valide, puis les deploie avec les assets Worker.

Les entrées de build incluent :

• defaults/v8s-links.txt, remplace par custom/v8s-links.txt quand present, avec les blocs @schedule inline
• custom/v8s-schedules.json si present comme source de compatibilité 3.x dépréciée
• defaults/v8s-policies.json, remplace par custom/v8s-policies.json quand present
• defaults/v8s-site-config.json, avec custom/v8s-site-config.json fusionne pour les choix de site
• les assets statiques de defaults/public/, surcharges par custom/public/
• les données de feeds générées par npm run generate:blocklist

Le build écrit :

scripts/workers/ est la source de vérité du Worker. src/ est une sortie générée. Les requêtes publiques directes vers les fichiers runtime bruts comme /v8s.json, /v8s-blocklist.json, et /v8s-site-config.json devraient retourner 404.