INTEGRITY Dokumentace

Spravovat gateways

Cloudflare Web3 gateway poskytuje rozhraní dostupná přes HTTP pro různé sítě Web3. S gateway můžete pracovat několika způsoby.

Vytvoření gateway

Chcete-li vytvořit bránu pomocí dashboardu:

  1. V dashboardu Cloudflare přejděte na Web3 stránce.

    Přejděte na Web3 ↗
  2. Klikněte na Create Gateway.

  3. Zadejte následující údaje:

  • Hostname: Zadejte hostname, který chcete použít jako svou gateway. Musí se jednat o subdoménu aktuální zóny Cloudflare.
  • Popis Gateway: Zadejte popis, který pomůže odlišit jednotlivé gateway.
  • Typ Gateway: Vyberte cíl gateway IPFS DNSLink, IPFS Universal Path, nebo Ethereum.
  • DNSLink: Platí pouze pro IPFS gateway, více informací naleznete na DNSLink.
  1. Klikněte na Nasadit.

Chcete-li vytvořit gateway pomocí API, odešlete POST požadavek, který obsahuje následující parametry:

  • name: Hostname, který bude na cílovou gateway odkazovat prostřednictvím CNAME záznam.
  • target: Cíl gateway pro daný hostname (ethereum, ipfs, ipfs_universal_path).

Pokud potřebujete pomoc s ověřováním API, podívejte se na Dokumentace Cloudflare API.

Požadavek
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/web3/hostnames" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "gateway.example.com",
  "description": "This is my IPFS gateway.",
  "target": "ipfs",
  "dnslink": "/ipns/onboarding.ipfs.cloudflare.com"
}'

Odpověď obsahuje úplnou definici nového gateway.

Odpověď
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "<WEB3_GATEWAY_ID>",
    "name": "gateway.example.com",
    "description": "This is my IPFS gateway.",
    "status": "active",
    "target": "ipfs",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
    "created_on": "<CREATED_ON_DATE>",
    "modified_on": "<MODIFIED_ON_DATE>"
  }
}

Při vytvoření brány Cloudflare automaticky:


Úprava gateway

Jakmile máte vytvořili bránu, můžete upravit pouze Popis Gateway a pokud se jedná o IPFS gateway, upravte také hodnotu DNSLink .

Pokud potřebujete upravit jiná pole, odstranit bránu a vytvořte nový.

Chcete-li upravit bránu pomocí dashboardu:

  1. V dashboardu Cloudflare přejděte na Web3 stránce.

    Přejděte na Web3 ↗
  2. U konkrétní brány klikněte na Úprava.

  3. Aktualizujte Popis Gateway a v případě, že upravujete IPFS gateway, hodnota pro DNSLink.

  4. Klikněte na Použít znovu.

Chcete-li upravit konkrétní nastavení brány, použijte PATCH požadavek.


Obnovení gateway

Když vaše brána uvízne ve stavu Chyba stav, zkuste gateway obnovit, což se pokusí znovu vytvořit přidružené DNS záznamy pro daný hostname.

Chcete-li obnovit bránu pomocí dashboardu:

  1. V dashboardu Cloudflare přejděte na Web3 stránce.

    Přejděte na Web3 ↗
  2. Na bráně klikněte na rozevírací nabídku a poté Obnovit.

Chcete-li obnovit bránu pomocí API, odešlete PATCH požadavek s prázdným tělem požadavku.


Aktualizace seznamu blokovaných

Při nastavování brána IPFS Universal Path, možná budete chtít přidat položky do blocklistu gateway, který umožňuje blokovat přístup ke konkrétnímu obsahu.

Máte možnost zablokovat přístup k jedné nebo více z následujících položek:

Chcete-li přidat položku do blocklistu pomocí dashboardu:

  1. V dashboardu Cloudflare přejděte na Web3 stránce.

    Přejděte na Web3 ↗
  2. U konkrétní brány klikněte na rozevírací nabídku a poté Blocklist.

  3. Klikněte na Přidat položku.

  4. Zadejte následující údaje:

    • Blocklist entry type: Vyberte CID nebo Cesta k obsahu.
    • Blocklist entry content: Přidejte CID nebo cestu k obsahu, který chcete zablokovat, tedy platný řetězec CIDv0 nebo CIDv1 (CID), nebo záznam začínající /ipfs/ nebo /ipns/ (cesta k obsahu).
    • Blocklist entry description: Přidejte popis, který vám pomůže identifikovat položku blocklistu.
  5. Klikněte na Přidat.

Chcete-li přidat položku do blocklistu pomocí API, odešlete POST požadavek.


Odstranění gateway

Při odstranění brány Cloudflare automaticky odstraní všechny přidružené DNS záznamy názvu hostitele. Tato akce ovlivní váš provoz a nelze ji vrátit zpět.

Chcete-li odstranit bránu pomocí dashboardu:

  1. V dashboardu Cloudflare přejděte na Web3 stránce.

    Přejděte na Web3 ↗
  2. U konkrétní brány klikněte na rozevírací nabídku a poté Odebrat.

  3. Klikněte na Odstranit hostname.

Chcete-li odstranit bránu pomocí API, odešlete DELETE požadavek.