Pular para o conteúdo

Servidor personalizado

Se GitHub não atender às suas necessidades, você pode hospedar um registro em qualquer servidor HTTP. O único requisito é que registry.json e os arquivos dos blocos estejam acessíveis por URL.

Servidor de arquivos estáticos

A opção mais simples. Coloque suas pastas registry.json e blocks/ em qualquer serviço de hospedagem estática:

  • Nginx/Apache: disponibilize o diretório diretamente
  • Vercel/Netlify: publique o diretório como um site estático
  • S3/R2/GCS: envie os arquivos para um bucket com acesso público
  • CDN: coloque os arquivos atrás de Cloudflare, Fastly ou qualquer CDN

O CLI só precisa de acesso GET aos arquivos. Não há API, nem rotas dinâmicas, nem lógica necessária no lado do servidor.

Servidor dinâmico

Se quiser gerar registry.json dinamicamente (e.g, por exemplo, a partir de um banco de dados, ou adicionar controle de acesso), você pode criar um API simples:

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

{file} pode conter barras quando um bloco lista arquivos em subdiretórios (src/script.js), então a rota de arquivos precisa corresponder a caminhos aninhados.

O CLI não se importa com a forma como esses endpoints são implementados. Ele faz requisições GET simples e espera que o corpo da resposta contenha o conteúdo do arquivo.

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

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

Se o CLI for executado em um ambiente onde CORS seja relevante (algo improvável para um Node.js CLI, mas possível em futuras ferramentas baseadas na Web), verifique se o servidor envia os cabeçalhos Access-Control-Allow-Origin apropriados.

Cache

O CLI armazena em cache os arquivos registry.json obtidos na memória durante uma única execução de comando. Os caches não são mantidos entre execuções. Para otimizar registros grandes, adicione cabeçalhos de cache HTTP padrão (Cache-Control, ETag) às respostas do servidor.

Registros internos/corporativos

Para equipes que querem compartilhar blocos internamente:

  1. Hospede o registro em um servidor interno ou URL acessível por VPN
  2. Cada desenvolvedor adiciona o registro URL ao blocks.json do projeto
  3. O CLI busca nesse URL como em qualquer outro registro

Não é necessária nenhuma configuração especial. Desde que o URL esteja acessível na máquina do desenvolvedor, ele funciona.