Lewati ke konten

Meng-host Registri

Registri adalah file registry.json dan sekumpulan folder blok yang disajikan melalui HTTP. Tidak diperlukan server khusus. Apa pun yang dapat menyajikan file statis dapat digunakan.

Yang diperlukan

  1. File registry.json yang mencantumkan blok Anda
  2. Folder blok dengan file yang dirujuk dalam manifes
  3. Server web atau layanan hosting yang menyajikan keduanya

Struktur direktori

Repositori registri biasanya terlihat seperti ini:

Kode
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 menunjuk ke direktori blocks/ sebagai baseUrl-nya:

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

Persyaratan

Hosting harus mendukung akses file langsung melalui URL. CLI mengambil file dengan menyusun URL dari {baseUrl}/{block.name}/{file}.

CLI tidak memiliki alur login sendiri. Untuk registri privat, atur kontrol akses di lapisan hosting (e.g. repositori privat GitHub dengan token, atau server yang memeriksa kredensial), lalu minta konsumen mengirim kredensial sebagai header khusus melalui format objek di blocks.json.

Menguji registri Anda

Sebelum menerbitkan, uji secara lokal dengan menjalankan server HTTP sederhana:

Shell
cd my-registry
npx serve .

Lalu arahkan blocks.json Anda ke http://localhost:3000/registry.json dan jalankan npx blockstudio list untuk memastikan semuanya dapat diakses. list hanya mengambil registry.json. Untuk menguji add, atur baseUrl ke http://localhost:3000/blocks selama pengujian, karena CLI mengunduh file blok dari baseUrl.