Zum Inhalt springen

Eine Registry hosten

Ein Registry besteht aus einer registry.json-Datei und einer Reihe von Blockordnern, die über HTTP bereitgestellt werden. Ein spezieller Server ist nicht erforderlich. Alles, was statische Dateien bereitstellen kann, funktioniert.

Was du brauchst

  1. Eine registry.json-Datei, in der deine Blöcke aufgeführt sind
  2. Blockordner mit den in der Manifestdatei referenzierten Dateien
  3. Einen Webserver oder Hosting-Dienst, der beides bereitstellt

Verzeichnisstruktur

Ein typisches Registry-Repository sieht so aus:

Code
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

Die registry.json verweist mit ihrem baseUrl auf das Verzeichnis blocks/:

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Voraussetzungen

Das Hosting muss direkten Dateizugriff über URL unterstützen. Die CLI ruft Dateien ab, indem sie URLs aus {baseUrl}/{block.name}/{file} erstellt.

Die CLI hat keinen eigenen Anmeldeablauf. Bei privaten Registries regelst du die Zugriffskontrolle auf der Hosting-Ebene (e.g: private GitHub-Repositories mit Tokens oder ein Server, der Zugangsdaten prüft) und lässt Nutzer die Zugangsdaten als benutzerdefinierte Header über das Objektformat in blocks.json senden.

Deine Registry testen

Teste sie vor der Veröffentlichung lokal, indem du einen einfachen HTTP-Server startest:

Shell
cd my-registry
npx serve .

Richte dann deine blocks.json auf http://localhost:3000/registry.json aus und führe npx blockstudio list aus, um zu prüfen, ob alles aufgelöst wird. list ruft nur registry.json ab. Um add zu testen, setze baseUrl während des Tests auf http://localhost:3000/blocks, da die CLI Blockdateien von baseUrl herunterlädt.