INTEGRITY Dokumentace

Parametry spuštění tunelu

Tato stránka uvádí konfigurační příznaky pro cloudflared tunnel run příkaz. Pro vzdáleně spravovaný tunel, přidejte tyto příznaky do služba tunelu. Pokud používáte lokálně spravovaný tunel přidejte tyto příznaky do svého konfigurační soubor jako páry klíč/hodnota.

Přidat parametry spuštění do tunelové služby

Vzdáleně spravované tunely běží jako služba ve vašem operačním systému. Pokud chcete do souboru služby tunelu přidat parametry spuštění:

Na Linuxu se Cloudflare Tunnel nainstaluje jako systémová služba pomocí systemctl. Ve výchozím nastavení se služba bude jmenovat cloudflared.service. Chcete-li nakonfigurovat tunel v Linuxu:

  1. Otevřete cloudflared.service.

    sudo systemctl edit --full cloudflared.service
  2. Upravte cloudflared tunnel run příkaz s požadovaným konfiguračním příznakem. Například,

    [Unit]
    Description=Cloudflare Tunnel
    After=network.target
    
    [Service]
    TimeoutStartSec=0
    Type=notify
    ExecStart=/usr/local/bin/cloudflared tunnel --loglevel info --logfile /var/log/cloudflared/cloudflared.log run --token <TOKEN VALUE>
    Restart=on-failure
    RestartSec=5s
    
    [Install]
    WantedBy=multi-user.target
  3. Restartovat cloudflared.service:

    sudo systemctl restart cloudflared
  4. Chcete-li ověřit novou konfiguraci, zkontrolujte stav služby:

    sudo systemctl status cloudflared
    ● cloudflared.service - cloudflared
      Loaded: loaded (/etc/systemd/system/cloudflared.service; enabled; preset: enabled)
      Active: active (running) since Wed 2024-10-09 20:02:59 UTC; 2s ago
    Main PID: 2157 (cloudflared)
       Tasks: 8 (limit: 1136)
      Memory: 16.3M
         CPU: 136ms
      CGroup: /system.slice/cloudflared.service
              └─2157 /usr/bin/cloudflared tunnel --loglevel info --logfile /var/log/cloudflared/cloudflared.log run --token eyJhIjoi...

V systému macOS se Cloudflare Tunnel nainstaluje jako launch agent pomocí launchctl. Ve výchozím nastavení se agent bude jmenovat com.cloudflare.cloudflared. Chcete-li nakonfigurovat tunel v macOS:

  1. Zastavte cloudflared služba.

    sudo launchctl stop com.cloudflare.cloudflared
  2. Odeberte konfigurační soubor.

    sudo launchctl unload /Library/LaunchDaemons/com.cloudflare.cloudflared.plist
  3. Otevřete /Library/LaunchDaemons/com.cloudflare.cloudflared.plist v textovém editoru.

  4. Upravte ProgramArguments klíč s požadovaným konfiguračním příznakem. Například,

    <plist version="1.0">
        <dict>
            <key>Label</key>
            <string>com.cloudflare.cloudflared</string>
            <key>ProgramArguments</key>
            <array>
                <string>/opt/homebrew/bin/cloudflared</string>
                <string>tunnel</string>
                <string>--logfile</string>
                <string><PATH></string>
                <string>--loglevel</string>
                <string>debug</string>
                <string>run</string>
                <string>--token</string>
                <string><TOKEN VALUE> </string>
            </array>
  5. Načtěte aktualizovaný konfigurační soubor.

    sudo launchctl load /Library/LaunchDaemons/com.cloudflare.cloudflared.plist
  6. Spusťte cloudflared služba.

    sudo launchctl start com.cloudflare.cloudflared

Ve Windows se Cloudflare Tunnel nainstaluje jako systémová služba pomocí Editoru registru. Ve výchozím nastavení se tato služba jmenuje cloudflared. Chcete-li nakonfigurovat tunel ve Windows:

  1. Otevřete Registry Editor.

  2. Přejděte na HKEY_LOCAL_MACHINE > SYSTÉM > CurrentControlSet > Služby > cloudflared.

  3. Dvakrát klikněte na ImagePath.

  4. Upravit Data hodnoty s požadovaným konfiguračním příznakem. Například,

    C:\Program Files (x86)\cloudflared\.\cloudflared.exe tunnel --loglevel info --logfile <PATH> run --token <TOKEN VALUE>
Úprava služby cloudflared v Editoru registru

Parametry

autoupdate-freq

Syntaxe Výchozí
cloudflared tunnel --autoupdate-freq <FREQ> run <UUID or NAME> 24h

Konfiguruje frekvenci cloudflared aktualizace.

Standardně cloudflared bude pravidelně kontrolovat aktualizace a restartovat se s novou verzí. Restart probíhá spuštěním nového procesu, který se připojí ke globální síti Cloudflare. Po úspěšném připojení starý proces korektně ukončí činnost poté, co dokončí všechny nevyřízené požadavky. Viz také: no-autoupdate.

config

Syntaxe Výchozí
cloudflared tunnel --config <PATH> run <UUID or NAME> ~/.cloudflared/config.yml

Určuje cestu k konfigurační soubor ve formátu YAML.

dns-resolver-addrs

Syntaxe Proměnná prostředí
cloudflared tunnel run --dns-resolver-addrs <IP:PORT> <UUID or NAME> TUNNEL_DNS_RESOLVER_ADDRS

Určuje vlastní adresy DNS resolveru pro cloudflared místo výchozích resolverů hostitelského počítače. Každá adresa musí být v ip:port formátu: pokud zadáte IP adresu bez portu, způsobí to cloudflared selhat při spuštění. Více resolverů můžete zadat opakováním příznaku. Například,

cloudflared tunnel run --dns-resolver-addrs 1.1.1.1:53 --dns-resolver-addrs 1.0.0.1:53 <UUID or NAME>

Pokud je zadáno více resolverů, cloudflared náhodně vybere jednu pro každý DNS požadavek. Povoleno je maximálně 10 adres resolverů.

edge-bind-address

Syntaxe Proměnná prostředí
cloudflared tunnel --edge-bind-address <IP> run <UUID or NAME> TUNNEL_EDGE_BIND_ADDRESS

Určuje odchozí IP adresu použitou k navázání připojení mezi cloudflared a globální síť Cloudflare.

Standardně cloudflared nechá rozhodnutí, kterou IP adresu použít, na operačním systému. Tato možnost je užitečná, pokud máte k dispozici více síťových rozhraní a chcete upřednostnit konkrétní rozhraní.

Verze IP edge-bind-address přepíše edge-ip-version (pokud je uvedena). Pokud například zadáte zdrojovou adresu IPv6, cloudflared se vždy připojí k cíli IPv6.

edge-ip-version

Syntaxe Výchozí Proměnná prostředí
cloudflared tunnel --edge-ip-version <VERSION> run <UUID or NAME> 4 TUNNEL_EDGE_IP_VERSION

Určuje verzi IP adresy (IPv4 nebo IPv6) použitou k navázání připojení mezi cloudflared a globální síť Cloudflare. Dostupné hodnoty jsou auto, 4, a 6.

Hodnota auto spoléhá na hostitelský operační systém, který určí, jakou verzi IP zvolit. Jako primární sadu použije první verzi IP vrácenou při DNS překladu vyhledávání regionu. V síťových konfiguracích s duálním IPv6 a IPv4 cloudflared rozdělí verze IP do dvou sad adres, které se použijí jako záloha při výpadku připojení.

grace-period

Syntaxe Výchozí Proměnná prostředí
cloudflared tunnel --grace-period <PERIOD> run <UUID or NAME> 30s TUNNEL_GRACE_PERIOD

Když cloudflared přijme signál SIGINT/SIGTERM, přestane přijímat nové požadavky, počká na dokončení již probíhajících požadavků a poté se vypne. Čekání na dokončení probíhajících požadavků skončí po uplynutí tohoto ochranného období, nebo jakmile je přijat druhý signál SIGTERM/SIGINT.

logfile

Syntaxe Proměnná prostředí
cloudflared tunnel --logfile <PATH> run <UUID or NAME> TUNNEL_LOGFILE

Ukládá protokol aplikace do tohoto souboru. Užitečné zejména při hlášení problémů. Podrobnosti o tom, jaké informace budete potřebovat při kontaktování podpory Cloudflare, najdete v tento průvodce.

loglevel

Syntaxe Výchozí Proměnná prostředí
cloudflared tunnel --loglevel <VALUE> run <UUID or NAME> info TUNNEL_LOGLEVEL

Určuje míru podrobnosti protokolování pro místní cloudflared instance. Dostupné hodnoty jsou debug, info (výchozí), warn, error, a fatal. Na debug úrovni, cloudflared zaznamená a zobrazí URL adresu požadavku, metodu, protokol, délku obsahu a také všechny hlavičky požadavku a odpovědi. Mějte však na paměti, že to může ve vašich protokolech odhalit citlivé informace.

metrics

Syntaxe Výchozí Proměnná prostředí
cloudflared tunnel --metrics <IP:PORT> run <UUID or NAME> Viz Metriky tunelu TUNNEL_METRICS

Zpřístupní endpoint Prometheus na zadané IP adrese a portu, který pak můžete dotazovat na metriky využití.

no-autoupdate

Syntaxe Proměnná prostředí
cloudflared tunnel --no-autoupdate run <UUID or NAME> NO_AUTOUPDATE

Zakazuje automatické cloudflared aktualizace. Viz také: autoupdate-freq.

origincert

Syntaxe Výchozí Proměnná prostředí
cloudflared tunnel --origincert <PATH> run <UUID or NAME> ~/.cloudflared/cert.pem TUNNEL_ORIGIN_CERT

Určuje certifikát účtu pro jednu z vašich zón, čímž klientovi umožníte fungovat jako origin pro danou zónu. Certifikát můžete získat pomocí cloudflared tunnel login příkaz nebo přejděte na https://dash.cloudflare.com/argotunnel.

pidfile

Syntaxe Proměnná prostředí
cloudflared tunnel --pidfile <PATH> run <UUID or NAME> TUNNEL_PIDFILE

Po prvním úspěšném připojení zapíše identifikátor procesu aplikace (PID) do tohoto souboru. Užitečné zejména pro skriptování a integraci se službami.

post-quantum

Syntaxe Proměnná prostředí
cloudflared tunnel run --post-quantum <UUID or NAME> TUNNEL_POST_QUANTUM

Připojení Cloudflare Tunnel ve výchozím nastavení přes quic jsou šifrovány pomocí postkvantová kryptografie (PQC) ale při problémech s připojením se vrátí zpět k non-PQ. Pokud --post-quantum příznak je zadán, quic připojení smí používat pouze postkvantové (PQ) dohody o klíčích, bez možnosti návratu k non-PQ.

Postkvantové shody klíčů nejsou podporovány při použití http2 protokol.

protocol

Syntaxe Výchozí Proměnná prostředí
cloudflared tunnel --protocol <VALUE> run <UUID or NAME> auto TUNNEL_TRANSPORT_PROTOCOL

Určuje protokol použitý k navázání připojení mezi cloudflared a globální síť Cloudflare. Dostupné hodnoty jsou auto, http2, a quic.

auto hodnota automaticky nakonfiguruje quic protokol. Pokud cloudflared nedokáže navázat připojení UDP, přejde zpět na používání http2 protokol.

region

Syntaxe Proměnná prostředí
cloudflared tunnel --region <VALUE> run <UUID or NAME> TUNNEL_REGION

Umožňuje vybrat oblasti, do kterých se vytvářejí připojení. V současné době je jedinou dostupnou hodnotou us, což směruje veškerá připojení přes datová centra ve Spojených státech. Ponechte prázdné nebo vynechte, chcete-li se připojit ke globálnímu regionu.

Pokud je oblast nastavena na us, cloudflared používá jiné hostname a IP adresy specifické pro USA. Viz Tunel s firewallem s podrobnostmi.

retries

Syntaxe Výchozí Proměnná prostředí
cloudflared tunnel --retries <VALUE> run <UUID or NAME> 5 TUNNEL_RETRIES

Určuje maximální počet opakování při chybách připojení nebo protokolu. Opakování využívají exponenciální prodlevu (ve výchozím nastavení k nim dochází po 1, 2, 4, 8 a 16 sekundách), proto se nedoporučuje tuto hodnotu výrazně zvyšovat.

tag

Syntaxe Proměnná prostředí
cloudflared tunnel --tag <KEY=VAL> run <UUID or NAME> TUNNEL_TAG

Určuje vlastní značky používané k identifikaci tohoto tunelu. Více značek lze zadat přidáním dalších --tag <KEY=VAL> příznaky do příkazu. Pokud do konfiguračního souboru zadáváte více značek, oddělte je čárkami: tag: {KEY1=VALUE1, KEY2=VALUE2}.

token

Syntaxe Proměnná prostředí
cloudflared tunnel run --token <TUNNEL_TOKEN> TUNNEL_TOKEN

Přiřadí cloudflared instance s konkrétním tunelem. Token tunelu se zobrazí na dashboardu, když poprvé vytvořit tunel. Token můžete také získat pomocí API.

token-file

Syntaxe Proměnná prostředí
cloudflared tunnel run --token-file <PATH> TUNNEL_TOKEN_FILE

Přiřadí cloudflared instance s konkrétním tunelem pomocí souboru, který obsahuje token.