Liigu sisu juurde

Kohandatud server

Kui GitHub sinu vajadustele ei vasta, võid hostida registrit mis tahes HTTP serveris. Ainus nõue on, et registry.json ja plokifailid oleksid URL-ide kaudu kättesaadavad.

Staatiline failiserver

Lihtsaim võimalus. Paiguta oma registry.json ja blocks/ kaust mis tahes staatilise sisu majutusteenusesse:

  • Nginx/Apache: serveeri kataloogi otse
  • Vercel/Netlify: juuruta kataloog staatilise saidina
  • S3/R2/GCS: laadi failid avaliku juurdepääsuga salvestusruumi
  • CDN: paiguta failid Cloudflare, Fastly või mis tahes CDN taha

CLI vajab failidele juurdepääsuks ainult GET. Pole vaja API, dünaamilisi marsruute ega serveripoolset loogikat.

Dünaamiline server

Kui soovite registry.json dünaamiliselt luua (e.g näiteks andmebaasist või lisada juurdepääsukontrolli), saate ehitada lihtsa API:

Kood
GET /registry.json          -> returns the registry manifest
GET /blocks/{name}/{file}   -> returns the block file content

{file} võib sisaldada kaldkriipse, kui plokk loetleb alamkataloogides olevaid faile (src/script.js), seega peab failimarsruut vastama pesastatud radadele.

CLI ei hooli sellest, kuidas need lõpp-punktid on teostatud. See teeb tavalisi GET päringuid ja eeldab, et vastuse sisu on faili sisu.

Näide: Express

JavaScript
const express = require('express');
const path = require('path');

const app = express();

app.get('/registry.json', (req, res) => {
  res.sendFile(path.join(__dirname, 'registry.json'));
});

app.use('/blocks', express.static(path.join(__dirname, 'blocks')));

app.listen(3000);

Näide: PHP

PHP
<?php
$path = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);

if ($path === '/registry.json') {
    header('Content-Type: application/json');
    readfile(__DIR__ . '/registry.json');
    exit;
}

if (preg_match('#^/blocks/([^/]+)/(.+)$#', $path, $matches)) {
    $file = __DIR__ . '/blocks/' . $matches[1] . '/' . $matches[2];
    if (file_exists($file)) {
        readfile($file);
        exit;
    }
}

http_response_code(404);

CORS

Kui CLI töötab keskkonnas, kus CORS on oluline (Node.js CLI puhul ebatõenäoline, kuid tulevaste veebipõhiste tööriistade korral võimalik), veenduge, et server saadaks sobivad Access-Control-Allow-Origin päised.

Vahemällu salvestamine

CLI salvestab ühe käsu käitamise ajal allalaaditud registry.json failid mällu. Vahemälu ei säilitata järgmiste käivituste vahel. Suurte registrite korral jõudluse parandamiseks lisage serveri vastustele standardsed HTTP vahemälupäised (Cache-Control, ETag).

Ettevõttesisesed registrid

Meeskondadele, kes soovivad plokke ettevõttesiseselt jagada:

  1. Majutage register siseserveris või VPN-i kaudu ligipääsetavas kohas URL
  2. Iga arendaja lisab registri URL oma projekti faili blocks.json
  3. CLI hangib sealt URL samamoodi nagu mis tahes muust registrist

Eriseadistust pole vaja. Kui URL on arendaja masinast ligipääsetav, siis see töötab.