Ga naar de inhoud

Aangepaste server

Als GitHub niet aan je behoeften voldoet, kun je een register hosten op elke HTTP-server. De enige vereiste is dat registry.json en blokbestanden via hun URL’s toegankelijk zijn.

Statische bestandsserver

De eenvoudigste optie. Plaats je mappen registry.json en blocks/ op een willekeurige statische hostingdienst:

  • Nginx/Apache: serveer de map rechtstreeks
  • Vercel/Netlify: publiceer de map als statische site
  • S3/R2/GCS: upload de bestanden naar een bucket met openbare toegang
  • CDN: plaats de bestanden achter Cloudflare, Fastly of een andere CDN

De CLI heeft alleen GET toegang tot de bestanden nodig. Er is geen API nodig, geen dynamische routes en geen serverlogica.

Dynamische server

Als u registry.json dynamisch wilt genereren (e.g bijvoorbeeld vanuit een database of om toegangsbeheer toe te voegen), kunt u een eenvoudige API bouwen:

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

{file} kan schuine strepen bevatten wanneer een blok bestanden in submappen opsomt (src/script.js), dus de bestandsroute moet overeenkomen met geneste paden.

Het maakt de CLI niet uit hoe deze endpoints zijn geïmplementeerd. De tool doet gewone GET-verzoeken en verwacht dat de hoofdtekst van het antwoord de bestandsinhoud bevat.

Voorbeeld: 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);

Voorbeeld: 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

Als de CLI wordt uitgevoerd in een omgeving waarin CORS van belang is (onwaarschijnlijk voor een Node.js CLI, maar mogelijk voor toekomstige webtools), moet u ervoor zorgen dat uw server de juiste Access-Control-Allow-Origin-headers verstuurt.

Caching

De CLI cachet opgehaalde registry.json-bestanden in het geheugen tijdens één opdrachtuitvoering. Caches worden niet tussen uitvoeringen bewaard. Als u grote registers wilt optimaliseren, voegt u standaard HTTP-cacheheaders toe (Cache-Control, ETag) aan uw serverantwoorden.

Interne/bedrijfsregisters

Voor teams die blokken intern willen delen:

  1. Host het register op een interne server of een via VPN toegankelijke URL
  2. Elke ontwikkelaar voegt de register-URL toe aan de blocks.json van het project
  3. De CLI haalt gegevens op bij die URL, net als bij elk ander register

Er is geen speciale configuratie nodig. Zolang de URL bereikbaar is vanaf de computer van de ontwikkelaar, werkt het.