Aller au contenu

Serveur personnalisé

Si GitHub ne répond pas à vos besoins, vous pouvez héberger un registre sur n’importe quel serveur HTTP. La seule exigence est que registry.json et les fichiers de blocs soient accessibles via leurs URL.

Serveur de fichiers statiques

L’option la plus simple. Déposez votre registry.json et votre dossier blocks/ sur n’importe quel service d’hébergement statique :

  • Nginx/Apache : servir directement le répertoire
  • Vercel/Netlify : déployer le répertoire en tant que site statique
  • S3/R2/GCS : téléverser les fichiers dans un bucket en accès public
  • CDN : placer les fichiers derrière Cloudflare, Fastly ou tout autre CDN

Le CLI a uniquement besoin d’un accès GET aux fichiers. Il n’y a pas de API, pas de routes dynamiques ni de logique côté serveur nécessaire.

Serveur dynamique

Si vous souhaitez générer registry.json dynamiquement (e.g. à partir d’une base de données, ou pour ajouter un contrôle d’accès), vous pouvez créer un API simple :

Code
GET /registry.json          -> returns the registry manifest
GET /blocks/{name}/{file}   -> returns the block file content

{file} peut contenir des barres obliques lorsqu’un bloc répertorie des fichiers dans des sous-répertoires (src/script.js), la route du fichier doit donc prendre en charge les chemins imbriqués.

Le CLI ne se soucie pas de la manière dont ces points de terminaison sont implémentés. Il envoie des requêtes GET simples et attend que le corps de la réponse contienne le contenu du fichier.

Exemple : Express

JavaScript
const express = require('express');
const path = require('path');

const app = express();

app.get('/registry.json', (req, res) => {
  res.sendFile(path.join(__dirname, 'registry.json'));
});

app.use('/blocks', express.static(path.join(__dirname, 'blocks')));

app.listen(3000);

Exemple : PHP

PHP
<?php
$path = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);

if ($path === '/registry.json') {
    header('Content-Type: application/json');
    readfile(__DIR__ . '/registry.json');
    exit;
}

if (preg_match('#^/blocks/([^/]+)/(.+)$#', $path, $matches)) {
    $file = __DIR__ . '/blocks/' . $matches[1] . '/' . $matches[2];
    if (file_exists($file)) {
        readfile($file);
        exit;
    }
}

http_response_code(404);

CORS

Si le CLI s’exécute dans un environnement où CORS est important (peu probable pour un Node.js CLI, mais possible pour de futurs outils web), assurez-vous que votre serveur envoie les en-têtes Access-Control-Allow-Origin appropriés.

Mise en cache

Le CLI met en cache les fichiers registry.json récupérés en mémoire pendant l’exécution d’une commande. Les caches ne sont pas conservés d’une exécution à l’autre. Pour optimiser les registres volumineux, ajoutez des en-têtes de cache HTTP standard (Cache-Control, ETag) aux réponses de votre serveur.

Registres internes et d’entreprise

Pour les équipes qui souhaitent partager des blocs en interne :

  1. Hébergez le registre sur un serveur interne ou un URL accessible via VPN
  2. Chaque développeur ajoute l’URL du registre au blocks.json de son projet
  3. Le CLI récupère les données depuis cet URL comme depuis tout autre registre

Aucune configuration particulière n’est nécessaire. Tant que le URL est accessible depuis la machine du développeur, tout fonctionne.