← Cloudflare Workers / workers / wrangler

Systémové proměnné prostředí

Systémové proměnné prostředí jsou lokální proměnné prostředí, které mohou změnit chování nástroje Wrangler. Nastavit je lze třemi způsoby:

1. Vytvořte .env soubor v adresáři projektu. Hodnoty proměnných prostředí nastavte ve svém .env soubor. Toto je doporučený způsob nastavení těchto proměnných, protože hodnoty zůstávají zachovány mezi relacemi Wrangler.

2. Zadejte hodnoty přímo v příkazu Wrangler. Například WRANGLER_LOG="debug" npx wrangler deploy nastaví hodnotu WRANGLER_LOG na "debug" pro toto spuštění příkazu.

3. Nastavte hodnoty ve svém prostředí shellu. Pokud například používáte Z shell, přidání export CLOUDFLARE_API_TOKEN=... do vašeho ~/.zshrc soubor nastaví tento token jako součást konfigurace shellu.

Wrangler podporuje následující proměnné prostředí:

• CLOUDFLARE_ACCOUNT_ID string volitelné

  • ID účtu pro účet související s Workers.

• CLOUDFLARE_API_TOKEN string volitelné

  • API token pro váš účet Cloudflare, lze použít k autentizaci v situacích, jako je CI/CD, a další automatizaci.

• CLOUDFLARE_API_KEY string volitelné

  • Klíč API pro váš účet Cloudflare, obvykle používaný u staršího způsobu ověřování s CLOUDFLARE_EMAIL=.

• CLOUDFLARE_EMAIL string volitelné

  • E-mailová adresa přiřazená k vašemu účtu Cloudflare, obvykle používaná u staršího způsobu ověřování s CLOUDFLARE_API_KEY=.

• CLOUDFLARE_ACCESS_CLIENT_ID string volitelné

  • ID klienta u Cloudflare Access Service Token, používá se k ověření u domén chráněných službou Access v neinteraktivních prostředích, jako jsou pipeline CI/CD. Musí být nastaveno společně s CLOUDFLARE_ACCESS_CLIENT_SECRET. Pokud jsou nastaveny obě proměnné, Wrangler se ověří pomocí service tokenu místo spuštění cloudflared access login. Úplné nastavení zásady Access a service tokenu najdete v Připojte se k Workers chráněným pomocí Access.

• CLOUDFLARE_ACCESS_CLIENT_SECRET string volitelné

  • Tajný klíč klienta u Cloudflare Access Service Token, používá se společně s CLOUDFLARE_ACCESS_CLIENT_ID pro ověřování u domén chráněných pomocí Access v neinteraktivních prostředích. Úplný postup nastavení zásad Access a service tokenu najdete v Připojte se k Workers chráněným pomocí Access.

• CLOUDFLARE_AUTH_USE_KEYRING boolean volitelné

  • Možnosti pro toto jsou true a false. Výchozí hodnota není nastavena. Přepisuje trvalé nastavení určené pomocí wrangler login --use-keyring / --no-use-keyring pro jedno volání. Když true, Wrangler ukládá přihlašovací údaje OAuth do šifrovaného souboru, přičemž šifrovací klíč je uložen ve svazku klíčů operačního systému, a pokud úložiště klíčů není k dispozici, ukončí se s chybou. Když false, Wrangler použije starší nešifrovaný soubor TOML, i když je zapnuté trvalé nastavení. Více informací najdete v Ukládání přihlašovacích údajů OAuth do klíčenky OS s podrobnostmi.

• CLOUDFLARE_ENV string volitelné

  • prostředí k použití pro příkazy Wrangler. To vám umožňuje vybrat prostředí bez použití --env příznak. Například CLOUDFLARE_ENV=production wrangler deploy nasadí do production prostředí. --env argument příkazové řádky má přednost před touto proměnnou prostředí.

• NODE_ENV string volitelné

  • Nastaví hodnotu process.env.NODE_ENV v kódu vašeho Workeru. Výchozí hodnota je "development" pro wrangler dev a "production" pro wrangler deploy a wrangler versions upload. Viz Bundling s dalšími informacemi.

• WRANGLER_SEND_METRICS boolean volitelné

  • Možnosti pro toto jsou true a false. Výchozí hodnota je true. Určuje, zda může Wrangler pro tento projekt odesílat Cloudflare anonymní data o používání. Více se dozvíte v našich zásady zpracování dat ↗.

• WRANGLER_SEND_ERROR_REPORTS boolean volitelné

  • Možnosti pro toto jsou true a false. Výchozí hodnota je undefined. Určuje, zda může Wrangler pro tento projekt odesílat Cloudflare hlášení o chybách nesouvisejících s uživatelem. Pokud undefined, Wrangler se při každé chybě, kterou nezpůsobil uživatel, zeptá, zda chcete odeslat hlášení o chybě.

• CLOUDFLARE_HYPERDRIVE_LOCAL_CONNECTION_STRING_<BINDING_NAME>string volitelné

  • lokální připojovací řetězec pro vaši databázi pro použití při lokálním vývoji s Hyperdrive. Pokud se binding pro váš Hyperdrive jmenuje například PROD_DB, to by bylo CLOUDFLARE_HYPERDRIVE_LOCAL_CONNECTION_STRING_PROD_DB="postgres://user:[email protected]:5432/testdb". Každý Hyperdrive je jednoznačně určen názvem bindingu.

• CLOUDFLARE_API_BASE_URL string volitelné

  • Výchozí hodnota je "https://api.cloudflare.com/client/v4".

• WRANGLER_LOG string volitelné

  • Možnosti pro úrovně logování jsou "none", "error", "warn", "info", "log" a "debug". Úrovně nerozlišují velká a malá písmena a výchozí hodnota je "log". Pokud je zadána neplatná úroveň, Wrangler použije výchozí hodnotu. Logy mohou obsahovat požadavky na API Cloudflare, veškerá shromažďovaná data o využití a podrobnější chybové logy.

• WRANGLER_LOG_PATH string volitelné

  • Cesta k souboru nebo adresáři, kam bude Wrangler zapisovat ladicí logy. Pokud cesta končí na .log, Wrangler to bude považovat za cestu k souboru, do kterého se budou zapisovat všechny protokoly. V opačném případě bude Wrangler považovat cestu za adresář, do kterého zapíše jeden nebo více souborů protokolu s názvy podle časového razítka.

• WRANGLER_LOG_SANITIZE boolean volitelné

  • Možnosti pro toto jsou true a false. Výchozí hodnota je true. Určuje, zda Wrangler odstraní citlivé informace z logů zapisovaných do konzole nebo do log souboru. Mezi citlivé informace patří API tokeny, e-mailové adresy, ID účtů a další.

• FORCE_COLOR string volitelné

  • Nastavením této hodnoty na 0, můžete vypnout barevný výstup Wrangleru, což u některých nastavení terminálu usnadňuje čtení. Například FORCE_COLOR=0.

• WRANGLER_HTTPS_KEY_PATH string volitelné

  • Cesta k vlastnímu klíči certifikátu HTTPS při spouštění wrangler dev, k použití s WRANGLER_HTTPS_CERT_PATH.

• WRANGLER_HTTPS_CERT_PATH string volitelné

  • Cesta k vlastnímu certifikátu HTTPS při spouštění wrangler dev, k použití s WRANGLER_HTTPS_KEY_PATH.

• DOCKER_HOST string volitelné

  • Slouží k lokálnímu vývoji Containers. Wrangler se pokusí automaticky najít správný socket, který použije ke komunikaci s vaším kontejnerovým enginem. Pokud to nefunguje (což se obvykle projevuje jako internal error při pokusu o připojení k vašemu Containeru), můžete zkusit nastavit cestu k soketu pomocí této proměnné prostředí.

• WRANGLER_R2_SQL_AUTH_TOKEN string volitelné

  • API token použitý ke spouštění dotazů pomocí R2 SQL.

• WRANGLER_OUTPUT_FILE_PATH string volitelné

  • Určuje cestu k souboru, kam Wrangler zapíše výstupní data ve formátu ND-JSON ↗ (JSON oddělený novými řádky). Každý řádek souboru představuje samostatný objekt JSON s informacemi o operacích Wrangleru, jako jsou nasazení, nahrávání verzí a chyby. To se hodí pro pipeline CI/CD a automatizační nástroje, které potřebují přistupovat k informacím o nasazení programově. Pokud jsou zadány oba WRANGLER_OUTPUT_FILE_PATH a WRANGLER_OUTPUT_FILE_DIRECTORY jsou nastaveny, WRANGLER_OUTPUT_FILE_PATH má přednost.

• WRANGLER_OUTPUT_FILE_DIRECTORY string volitelné

  • Určuje adresář, ve kterém Wrangler vytvoří soubor s náhodným názvem (formát: wrangler-output-<timestamp>-<random>.json) pro zápis výstupních dat v ND-JSON ↗ formát. To se hodí, pokud chcete udržovat výstupní soubory organizované ve zvláštním adresáři, ale nepotřebujete řídit přesný název souboru. Pokud jsou zadány oba WRANGLER_OUTPUT_FILE_PATH a WRANGLER_OUTPUT_FILE_DIRECTORY jsou nastaveny, WRANGLER_OUTPUT_FILE_PATH má přednost.

• WRANGLER_CACHE_DIR string volitelné

  • Vlastní adresář pro soubory mezipaměti Wrangleru. Pokud je nastaven, přepíše výchozí umístění mezipaměti (node_modules/.cache/wrangler). Hodí se pro prostředí, která nepoužívají tradiční node_modules adresáři, jako je Yarn PnP.

• MINIFLARE_CACHE_DIR string volitelné

  • Vlastní adresář pro Miniflare cf.json souboru cache používaného při lokálním vývoji s wrangler dev. Pokud je nastaveno, přepíše se výchozí umístění mezipaměti (node_modules/.mf). Hodí se pro prostředí, která nepoužívají tradiční node_modules adresáři, jako je Yarn PnP.

• CLOUDFLARE_CF_FETCH_ENABLED string volitelné

  • Ovládá, zda Miniflare načte cf.json soubor obsahující Request.cf vlastnosti od Cloudflare během lokálního vývoje. Nastavte na "false" nebo "0" abyste zcela zakázali načítání a použili záložní data. Žádné node_modules/.mf/cf.json soubor se vytvoří, když je vypnuto. Výchozí hodnota je "true". To se hodí zejména pro projekty mimo JavaScript (například Rust nebo Go Workers), které nechtějí node_modules adresář vytvořen automaticky. Explicitní cf možnost v Miniflare API má přednost před touto proměnnou prostředí.

• CLOUDFLARE_CF_FETCH_PATH string volitelné

  • Určuje vlastní cestu pro ukládání do mezipaměti cf.json soubor, čímž přepíšete výchozí node_modules/.mf/cf.json umístění. To se hodí pro nastavení s více projekty, kde chcete sdílené umístění cache, nebo pro projekty, které chtějí cache ukládat mimo node_modules. Explicitní cf možnost v Miniflare API má přednost před touto proměnnou prostředí a CLOUDFLARE_CF_FETCH_ENABLED=false má přednost před touto proměnnou.

Když jsou tyto proměnné prostředí nastaveny, Wrangler zapisuje do výstupního souboru jeden objekt JSON na řádek. Každý záznam obsahuje timestamp pole a type pole udávající typ operace. Zde je příklad, co může soubor obsahovat po spuštění wrangler deploy:

{"type":"wrangler-session","version":1,"wrangler_version":"3.78.0","command_line_args":["deploy"],"log_file_path":"/path/to/logs/wrangler-2024-11-03_12-00-00_abc.log","timestamp":"2024-11-03T12:00:00.000Z"}
{"type":"deploy","version":1,"worker_name":"my-worker","worker_tag":"abc123def456","version_id":"v1-abc123","targets":["https://my-worker.example.workers.dev"],"worker_name_overridden":false,"wrangler_environment":"production","timestamp":"2024-11-03T12:00:05.000Z"}

wrangler-session záznam se zapíše při spuštění Wrangleru a obsahuje informace o spouštěném příkazu. deploy záznam se zapíše po úspěšném dokončení nasazení a obsahuje název workeru, ID verze a adresy URL nasazení.

Mezi další typy položek patří:

• version-upload - Napsáno wrangler versions upload s ID verze a náhledovými URL adresami
• version-deploy - Napsáno wrangler versions deploy s informacemi o nasazení
• pages-deploy - Napsáno wrangler pages deploy s podrobnostmi o nasazení Pages
• command-failed - Zapsáno při selhání příkazu, včetně chybového kódu a zprávy

Následuje příklad .env soubor:

CLOUDFLARE_ACCOUNT_ID=<YOUR_ACCOUNT_ID_VALUE>
CLOUDFLARE_API_TOKEN=<YOUR_API_TOKEN_VALUE>
CLOUDFLARE_EMAIL=<YOUR_EMAIL>
WRANGLER_SEND_METRICS=true
CLOUDFLARE_API_BASE_URL=https://api.cloudflare.com/client/v4
WRANGLER_LOG=debug
WRANGLER_LOG_PATH=../Desktop/my-logs/my-log-file.log
WRANGLER_R2_SQL_AUTH_TOKEN=<YOUR_R2_API_TOKEN_VALUE>
CLOUDFLARE_CF_FETCH_ENABLED=false

Následující proměnné jsou zastaralé. Použijte nové proměnné uvedené výše, abyste předešli problémům nebo nežádoucím zprávám.

• CF_ACCOUNT_ID
• CF_API_TOKEN
• CF_API_KEY
• CF_EMAIL
• CF_API_BASE_URL