Preskočiť na obsah

Hostovanie registra

Register tvorí súbor registry.json a súbor priečinkov blokov dostupných cez HTTP. Nepotrebujete žiadny špeciálny server. Postačí čokoľvek, čo dokáže poskytovať statické súbory.

Čo potrebujete

  1. Súbor registry.json so zoznamom vašich blokov
  2. Priečinky blokov so súbormi uvedenými v manifeste
  3. Webový server alebo hostingovú službu, ktorá poskytuje oboje

Štruktúra adresára

Typické úložisko registra vyzerá takto:

Kód
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

registry.json odkazuje na adresár blocks/ ako na svoj baseUrl:

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

Požiadavky

Hosting musí podporovať priamy prístup k súborom cez URL. CLI načítava súbory vytváraním adries URL z {baseUrl}/{block.name}/{file}.

CLI nemá vlastný prihlasovací proces. Pri súkromných registroch nastavte riadenie prístupu na úrovni hostingu (e.g, napríklad súkromné úložiská GitHub s tokenmi alebo server, ktorý overuje prihlasovacie údaje) a nechajte používateľov posielať prihlasovacie údaje ako vlastné hlavičky cez formát objektov v blocks.json.

Testovanie registra

Pred zverejnením ho otestujte lokálne spustením jednoduchého servera HTTP:

Shell
cd my-registry
npx serve .

Potom nastavte blocks.json na http://localhost:3000/registry.json a spustite npx blockstudio list, aby ste overili správne rozlíšenie všetkých údajov. list načítava iba registry.json. Ak chcete otestovať add, počas testovania nastavte baseUrl na http://localhost:3000/blocks, pretože CLI sťahuje súbory blokov z baseUrl.