Zum Inhalt springen

Benutzerdefinierter Server

Wenn GitHub nicht zu deinen Anforderungen passt, kannst du eine Registry auf einem beliebigen HTTP-Server hosten. Voraussetzung ist lediglich, dass registry.json und die Blockdateien über ihre URLs erreichbar sind.

Statischer Dateiserver

Die einfachste Option: Lege deine Ordner registry.json und blocks/ auf einem beliebigen Static-Hosting-Dienst ab:

  • Nginx/Apache: Stelle das Verzeichnis direkt bereit
  • Vercel/Netlify: Veröffentliche das Verzeichnis als statische Website
  • S3/R2/GCS: Lade die Dateien in einen öffentlich zugänglichen Bucket hoch
  • CDN: Lege die Dateien hinter Cloudflare, Fastly oder einem beliebigen CDN ab

CLI benötigt lediglich GET Zugriff auf die Dateien. API, dynamische Routen und serverseitige Logik sind nicht erforderlich.

Dynamischer Server

Wenn du registry.json dynamisch generieren möchtest (e.g. etwa aus einer Datenbank oder um Zugriffskontrollen hinzuzufügen), kannst du einen einfachen API erstellen:

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

{file} kann Schrägstriche enthalten, wenn ein Block Dateien in Unterverzeichnissen aufführt (src/script.js). Daher muss die Dateiroute verschachtelte Pfade abgleichen können.

CLI ist egal, wie diese Endpunkte implementiert sind. Das Programm sendet einfache GET-Anfragen und erwartet den Dateiinhalt im Antworttext.

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

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

Wenn CLI in einer Umgebung läuft, in der CORS relevant ist (bei einem Node.js-CLI unwahrscheinlich, bei künftigen webbasierten Tools aber möglich), muss dein Server die passenden Access-Control-Allow-Origin-Header senden.

Caching

CLI speichert abgerufene registry.json-Dateien während eines einzelnen Befehlsdurchlaufs im Arbeitsspeicher zwischen. Der Cache bleibt nicht über mehrere Durchläufe hinweg erhalten. Wenn du große Registrys optimieren möchtest, füge deinen Serverantworten standardmäßige HTTP-Cache-Header hinzu (Cache-Control, ETag).

Interne und Unternehmens-Registrys

Für Teams, die Blöcke intern teilen möchten:

  1. Hoste die Registry auf einem internen Server oder einem URL, der über VPN erreichbar ist
  2. Jeder Entwickler fügt die Registry-URL zur blocks.json seines Projekts hinzu
  3. CLI ruft Inhalte wie bei jeder anderen Registry von diesem URL ab

Eine spezielle Einrichtung ist nicht erforderlich. Solange URL vom Rechner des Entwicklers aus erreichbar ist, funktioniert es.