Hostowanie rejestru
Rejestr to plik registry.json i zestaw folderów bloków udostępnianych przez HTTP. Nie jest potrzebny żaden specjalny serwer. Wystarczy dowolny serwer, który może udostępniać pliki statyczne.
Czego potrzebujesz
- Plik
registry.jsonzawierający listę bloków - Foldery bloków z plikami wskazanymi w manifeście
- Serwer WWW lub usługa hostingowa, która udostępnia oba te elementy
Struktura katalogów
Typowe repozytorium rejestru wygląda tak:
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 wskazuje katalog blocks/ jako swoją baseUrl:
{
"name": "my-registry",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"files": ["block.json", "index.php", "style.scss"]
}
]
}
Wymagania
Hosting musi obsługiwać bezpośredni dostęp do plików przez URL. CLI pobiera pliki, tworząc adresy URL na podstawie {baseUrl}/{block.name}/{file}.
CLI nie ma własnego procesu logowania. W przypadku prywatnych rejestrów kontrolę dostępu należy obsłużyć po stronie hostingu (e.g, na przykład prywatne repozytoria GitHub z tokenami lub serwer sprawdzający dane uwierzytelniające), a konsumenci powinni wysyłać dane uwierzytelniające jako niestandardowe nagłówki w formacie obiektu opisanym w formacie obiektublocks.json.
Testowanie rejestru
Przed publikacją przetestuj rejestr lokalnie, uruchamiając prosty serwer HTTP:
cd my-registry
npx serve .
Następnie ustaw blocks.json na http://localhost:3000/registry.json i uruchom npx blockstudio list, aby sprawdzić, czy wszystko jest rozwiązywane prawidłowo. list pobiera tylko registry.json. Aby przetestować add, podczas testowania ustaw baseUrl na http://localhost:3000/blocks, ponieważ CLI pobiera pliki bloków z baseUrl.