Vai al contenuto

Ospitare un registro

Un registro è un file registry.json e un insieme di cartelle di blocchi distribuiti tramite HTTP. Non serve un server speciale: basta qualsiasi sistema in grado di distribuire file statici.

Cosa serve

  1. Un file registry.json che elenca i vostri blocchi
  2. Cartelle dei blocchi con i file indicati nel manifest
  3. Un server web o un servizio di hosting che distribuisca entrambi

Struttura delle directory

Un tipico repository di registro ha questa struttura:

Codice
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

Il registry.json indica la directory blocks/ come proprio baseUrl:

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

Requisiti

L’hosting deve supportare l’accesso diretto ai file tramite URL. Il CLI recupera i file costruendo URL a partire da {baseUrl}/{block.name}/{file}.

Il CLI non dispone di una procedura di accesso propria. Per i registri privati, gestite il controllo degli accessi a livello di hosting (e.g, ad esempio, repository GitHub privati con token oppure un server che verifica le credenziali) e fate inviare le credenziali ai consumer come intestazioni personalizzate tramite il formato object in blocks.json.

Testare il registro

Prima di pubblicarlo, testatelo localmente avviando un semplice server HTTP:

Shell
cd my-registry
npx serve .

Poi impostate blocks.json su http://localhost:3000/registry.json ed eseguite npx blockstudio list per verificare che tutto venga risolto. list recupera solo registry.json. Per testare add, durante il test impostate baseUrl su http://localhost:3000/blocks, perché il CLI scarica i file dei blocchi da baseUrl.