コンテンツへスキップ

カスタムサーバー

GitHub が要件に合わない場合は、任意の HTTP サーバーでレジストリをホストできます。必要なのは、registry.json とブロックファイルにそれぞれの URL からアクセスできることだけです。

静的ファイルサーバー

最も簡単な方法です。registry.json と blocks/ フォルダーを任意の静的ホスティングサービスに配置します:

  • Nginx/Apache: ディレクトリをそのまま配信
  • Vercel/Netlify: ディレクトリを静的サイトとしてデプロイ
  • S3/R2/GCS: パブリックアクセス可能なバケットにファイルをアップロード
  • CDN: Cloudflare、Fastly、または任意の CDN の背後にファイルを配置

CLI が必要とするのは、ファイルへの GET アクセスだけです。API も動的ルートもサーバー側のロジックも必要ありません。

動的サーバー

registry.jsonを動的に生成する場合(たとえばe.gから生成する場合)、またはアクセス制御を追加する場合は、シンプルなAPIを作成できます:

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

{file} にサブディレクトリ内のファイルを指定するとスラッシュを含むことがあるため (src/script.js)、ファイルのルートはネストされたパスに一致させる必要があります。

CLI はこれらのエンドポイントの実装方法を問いません。通常の GET リクエストを送信し、レスポンス本文にファイルの内容が含まれることを想定します。

例: 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);

例: 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

CLI が CORS の影響を受ける環境で実行される場合 (Node.js CLI ではまれですが、将来ウェブベースのツールで必要になる可能性があります)、サーバーが適切な Access-Control-Allow-Origin ヘッダーを送信するようにしてください。

キャッシュ

CLI は1回のコマンド実行中に、取得した registry.json ファイルをメモリにキャッシュします。実行をまたいでキャッシュを保持することはありません。大規模なレジストリのパフォーマンスを最適化する場合は、サーバーのレスポンスに標準的な HTTP キャッシュヘッダー (Cache-Control、ETag) を追加してください。

社内・企業向けレジストリ

ブロックを社内で共有したいチームの場合:

  1. 社内サーバー、または VPN 経由でアクセスできる URL でレジストリをホストします
  2. 各開発者がプロジェクトの blocks.json にレジストリ URL を追加します
  3. CLI は他のレジストリと同様に、その URL から取得します

特別な設定は必要ありません。開発者のマシンから URL にアクセスできれば動作します。