Hosting af et register
Et register består af en registry.json-fil og et sæt blokmapper, der udgives via HTTP. Der kræves ingen særlig server. Alt, der kan udgive statiske filer, fungerer.
Det skal du bruge
- En
registry.json-fil med en liste over dine blokke - Blokmapper med de filer, der henvises til i manifestet
- En webserver eller hostingtjeneste, der udgiver begge dele
Mappestruktur
Et typisk repository for et register ser sådan ud:
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 peger på mappen blocks/ som sin baseUrl:
{
"name": "my-registry",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"files": ["block.json", "index.php", "style.scss"]
}
]
}
Krav
Hostingen skal understøtte direkte filadgang via URL. CLI henter filer ved at opbygge URL’er ud fra {baseUrl}/{block.name}/{file}.
CLI har ikke sit eget loginforløb. For private registre skal adgangskontrollen håndteres på hostinglaget (e.g. private GitHub-repositories med tokens eller en server, der kontrollerer legitimationsoplysninger), og forbrugerne skal sende legitimationsoplysningerne som brugerdefinerede headers via objektformatet i blocks.json.
Test af registret
Før du udgiver, skal du teste lokalt ved at starte en enkel HTTP-server:
cd my-registry
npx serve .
Angiv derefter blocks.json til http://localhost:3000/registry.json, og kør npx blockstudio list for at kontrollere, at alt findes. list henter kun registry.json. Hvis du vil teste add, skal du under testen angive baseUrl til http://localhost:3000/blocks, fordi CLI henter blokfiler fra baseUrl.