ข้ามไปยังเนื้อหา
TH
รับคีย์ API
เรียกดูเอกสาร

คู่มือ

นำงาน FlashData ขึ้นระบบ

เปิดแอพหรือตัวแทนของคุณ CLI งานบน Linux หรือ Dockerจากนั้นตรวจสอบการเข้าถึงและผลลัพธ์ที่นํากลับมาใช้อีกครั้งหลังจากการรีเซ็ท

ในหน้านี้

1. เลือกเวลาทํางาน

ใช้ Linux โฮสต์พร้อม Bash ถึง jqและเป็นเจ้าของ API กุญแจพร้อม google_search อนุญาต เรียกใช้การตั้งค่าเป็น OS ผู้ใช้ที่จะประมวลผลงาน สร้างโฟลเดอร์ทาสก์ส่วนตัวสําหรับขั้นตอนต่าง ๆ 1–4สืบค้นเมื่อ '% 1'

สร้างโฟลเดอร์ทาสก์
umask 077
mkdir -p "$HOME/flashdata-tasks/deployment-check"
cd "$HOME/flashdata-tasks/deployment-check"

ติดตั้ง CLI แบบดั้งเดิม ประมวลผลคําสั่ง - v แฟลชดาต้า เพื่อค้นหาพาธสัมบูรณ์ของมัน แล้วตั้งค่า FLASHDATA_BIN ไปยังเส้นทางนั้น ๆ runtime.sh. ตั้งค่าชื่อโพรไฟล์และพาธของสถานะถาวรได้ที่นี่ จากนั้นบันทึกแฟ้ม

runtime.sh
# runtime.sh — edit the executable and persistent state paths.
export FLASHDATA_BIN=/usr/local/bin/flashdata
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"

run_flashdata() {
  env -u FLASHDATA_API_KEY "$FLASHDATA_BIN" "$@" \
    --profile "$FLASHDATA_PROFILE" \
    --state-dir "$FLASHDATA_STATE_DIR"
}

เลือกเวลาทํางานที่เลือกไว้

ประมวลผลจากโฟลเดอร์ทาสก์ run_flashdata ผู้ช่วยเหลือถูกบันทึกใน runtime.shสืบค้นเมื่อ% 1 มันไม่สนใจ FLASHDATA_API_KEY ดังนั้นกุญแจสภาพแวดล้อมจึงไม่สามารถแทนที่โพรไฟล์ที่บันทึกไว้ได้ คาดหวังว่า CLI ถึง jq ฉบับ แปล.

เตรียมรัฐถาวร ไม่ API สืบค้น
set -euo pipefail
umask 077
. ./runtime.sh
mkdir -p "$FLASHDATA_STATE_DIR"
chmod 700 "$FLASHDATA_STATE_DIR"
run_flashdata --version
jq --version

2. ติดตั้งสิทธิ์ที่เป็นเจ้าของหนึ่งครั้ง

หากโพรไฟล์มีสิทธิ์ในการเป็นเจ้าของอยู่แล้ว ให้ข้ามการนําเข้าแล้วเรียกตรวจสอบด้านล่างนี้ ไม่เช่นนั้น จะทําการติดตั้งแฟ้ม ลับของเจ้าของที่อยู่ ซึ่งสามารถอ่านได้โดยผู้ใช้บริการ และแทนที่พาธตัวอย่างด้วยตําแหน่ง การนําเข้าอ่านผ่าน stdin; Docker ไม่ได้คัดลอกมันไปยังภาพ

ชี้ไปยังแฟ้มลับที่ใช้อยู่
export FLASHDATA_KEY_FILE='/run/secrets/flashdata_api_key'
นําเข้าและตรวจสอบในเวลาการทํางานที่เลือกไว้
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Set the path to your mounted owner-key secret}"
run_flashdata auth login --api-key-stdin --non-interactive \
  < "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactive

ยืนยันการอนุญาตบัญชีผู้ใช้

เช็ค ลายนิ้วมือของบัญชี IDงั้น ก็ให้แหล่งข่าวและ การคุ้มครองตามหลักการได้ true. ยืนยันบัญชีผู้ใช้ ID คือเจ้าของที่ตั้งใจไว้ก่อนจะทําต่อ access.json อยู่ในโฟลเดอร์ทาสก์สําหรับตรวจสอบ

บันทึกการเข้าใช้เครื่องหมาย 'H' ฟรี
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata auth status --json --non-interactive > access.json
jq '{accountId: .data.identity.identity.accountId,
     sources: .data.identity.permittedSources,
     credentialProtection: .data.credentialProtection}' access.json
jq -e '.ok and .data.accessVerified
  and (.data.identity.identity.recurringAllowed == true)
  and (.data.identity.permittedSources | index("google_search") != null)' access.json

จัดเก็บข้อมูลและแฟ้มถาวร

ขอบเขตสี data.credentialProtection ใน auth status. Linux ใช้บริการลับที่ไม่ได้ปลดล็อคได้; โฮสต์ที่ไม่มีหัวหรือตู้เก็บจดหมายด้านบนอาจจะใช้เพียงแฟ้มข้อความธรรมดาของเจ้าของเครื่องเท่านั้น เก็บไดเร็คทอรีของรัฐไว้เป็นส่วนตัวและต่อเนื่อง จัดเรียงผู้ใช้ที่ใช้งานแยกจากโพรไฟล์การเข้ารหัสของแล็ปท็อปของคุณ

เก็บไว้ตําแหน่ง
Credentials และประมวลผลบันทึกประจําวันFLASHDATA_STATE_DIR
การนําเข้า, ใบเสร็จและผลที่ได้โฟลเดอร์ทาสก์; ถูกเมานท์ไว้ /work ใน Docker.

3. ตรวจสอบคําขอและค่าใช้จ่าย

บันทึก request.json ข้าง runtime.sh. เช็ค ต่อ ไป นี้ จะ ทํา ให้ มี การ เข้า ไป ใช้ อีก ครั้ง และ คํา ขอ อ่าน ค่า ตัว เลข ปัจจุบัน และ เปรียบ เทียบ กับ ความ สมดุล ที่ มี อยู่. มันไม่มีการส่งการค้นหาและไม่ได้สํารองเครดิต ทําต่อไปเมื่อพิมพ์ตัวกรอง true

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Check before print february
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata account balance --json --non-interactive > balance.json
run_flashdata query --input request.json --mode realtime --dry-run --recurring \
  --run-id deployment-first-task --json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
  .ok and .data.dryRun and .data.estimateAvailable
  and ($balance[0].ok == true)
  and any(.data.estimate.prices[]?;
    .source == "google_search" and .available == true
    and (.estimatedCredits | type == "number")
    and ($balance[0].data.availableCredits | type == "number")
    and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json

4. ประมวลผลหนึ่งครั้งและตรวจสอบการเรียกซ้ํา

บันทึก deployment-check.sh ด้านล่างนี้ ด้วยการทํางานทาสก์แรกใช้งานใหม่ IDการประหารชีวิตครั้งแรกส่งการค้นหาที่จ่าย; ครั้งที่สองเริ่มกระบวนการใหม่และอ่านผลการบันทึกไว้ ถ้านี่ ID เสร็จสมบูรณ์แล้วในโพรไฟล์เดียวกัน ทั้งสองครั้งได้ดําเนินการซ้ําอีกครั้ง

บันทึก deployment-check.sh

สร้าง deployment-check.sh ข้าง runtime.sh ถึง request.json ในโฟลเดอร์ส่วนตัวบนโฮสต์ คัดลอกสคริปต์ที่สมบูรณ์ด้านล่างนี้และบันทึกมัน

deployment-check.sh
#!/usr/bin/env bash
set -euo pipefail
umask 077
cd -- "$(dirname -- "$0")"
. ./runtime.sh
attempt=$(mktemp -d ./deployment-check.XXXXXX)
printf 'Attempt files: %s\n' "$attempt" >&2
cp -- request.json "$attempt/request.json"
if ! run_flashdata query --input "$attempt/request.json" --mode realtime --recurring \
  --run-id deployment-first-task --timeout 2m --json --non-interactive \
  --output "$attempt/result.json" \
  > "$attempt/receipt.json" 2> "$attempt/error.json"; then
  cat "$attempt/error.json" >&2
  exit 1
fi
jq -e '.ok == true' "$attempt/receipt.json" >/dev/null
jq -e '.source == "google_search" and .status == "done"
  and (.results[0].organic | type == "array")' "$attempt/result.json" >/dev/null
jq '{runId, cached, usage}' "$attempt/receipt.json"
printf 'Saved result: %s\n' "$attempt/result.json"

ตรวจเช็คสองครั้ง

ประมวลผลจากโฟลเดอร์ทาสก์ดังกล่าวโดยใช้สิทธิ์ผู้ใช้เดียวกัน โพรเซสทั้งสองโหลด runtime.sh บันทึกในขั้นตอน 1.

ประมวลผลแล้วเริ่มการทํางานโพรเซสใหม่อีกครั้ง
# A new run ID submits one paid search; a completed ID reuses its result.
bash deployment-check.sh

# New process; Docker uses a new container with the same mounts.
# Same account, input and state: cached: true, no new search.
bash deployment-check.sh

ตรวจสอบใบเสร็จใบที่สอง

สําหรับรอบใหม่, คาดหวัง cached: falseงั้น cached: true. แต่ละความพยายามจะพิมพ์ deployment-check.XXXXXX โฟลเดอร์และบันทึก request.json, receipt.json ถึง error.json# บวก result.json ความสําเร็จ ใบเสร็จที่ถูกเก็บแล้ว รายงานการใช้งานดั้งเดิม การพยายามล้มเหลว ทําให้แฟ้มของมันสามารถฟื้นตัวได้

ใบเสร็จใบที่สอง
{
  "ok": true,
  "runId": "deployment-first-task",
  "cached": true
}

อ่านผลการค้นหาที่บันทึกไว้

ตั้งค่า ATTEMPT_DIR ไปยังโฟลเดอร์ที่ประสบความสําเร็จตัวที่สอง ซึ่งพิมพ์ด้านบนแล้ว ตัวอย่างเช่น การส่งออก ATTEMPT_DIR='./deployment-check.ABC123'. คําสั่งเหล่านี้อ่านเฉพาะแฟ้มภายในระบบเท่านั้น

เชื่อมโยงแบบรีเซปต์และแหล่งกําเนิด
# Use one attempt folder printed by deployment-check.sh.
: "${ATTEMPT_DIR:?Set a saved deployment-check.XXXXXX folder}"
jq '{runId, cached, usage}' "$ATTEMPT_DIR/receipt.json"
jq '.results[0].organic[] | {title, link, snippet}' "$ATTEMPT_DIR/result.json"

ย้ายจากการตรวจสอบการใช้งานไปยังงานที่เกิดขึ้นซ้ํา

เช็คนี่ใช้ได้แล้ว ID. สําหรับการทํางานซ้ํา ๆ ให้แต่ละเหตุการณ์ที่ตั้งใจของตัวเอง ID และรักษาเวลาการทํางาน, บัญชี, ภาพพิมพ์เข้าและข้อมูลสถานะ ปรับคําสั่งค้นหาของการเกิดขึ้นอีกครั้งที่จะใช้ run_flashdata ดังนั้น Docker งานอยู่ในตู้คอนเทนเนอร์

ตรวจสอบสิทธิ์ที่เข้าใช้ GitHub การกระทํา

จง ใช้ ความ ไว้ วางใจ อย่าง ไม่ ละลด Linux ลงสมัครด้วย Bash, jq และ CLI โพรไฟล์ถูกติดตั้งไว้เรียบร้อยแล้วภายใต้ชื่อตัววิ่ง OS ผู้ใช้ บันทึกการทํางานนี้ไว้ในคลังแพกเกจของโปรแกรมของคุณ มันจะตรวจสอบโฮสต์ CLI โดยไม่ทํางานงานที่ต้องจ่าย

  1. กําหนดป้ายค้นหา flashdata ให้นักวิ่งคนนั้น
  2. ตั้งตัวแปรคลังสื่อ FLASHDATA_BIN ถึง FLASHDATA_STATE_DIR ไปยังเส้นทางที่สมบูรณ์ และ FLASHDATA_PROFILE ไปยังชื่อโพรไฟล์ที่ถูกติดตั้งแล้ว
.github/workflows/flashdata-check.yml
name: FlashData access check
on: workflow_dispatch
permissions: {}
concurrency:
  group: flashdata-research
  cancel-in-progress: false
jobs:
  verify:
    runs-on: [self-hosted, linux, flashdata-research]
    timeout-minutes: 5
    steps:
      - name: Verify the installed profile without a paid query
        shell: bash
        env:
          FLASHDATA_BIN: ${{ vars.FLASHDATA_BIN }}
          FLASHDATA_STATE_DIR: ${{ vars.FLASHDATA_STATE_DIR }}
          FLASHDATA_PROFILE: ${{ vars.FLASHDATA_PROFILE }}
          FLASHDATA_API_KEY: ""
        run: |
          set -euo pipefail
          : "${FLASHDATA_BIN:?Set the absolute CLI path}"
          : "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
          : "${FLASHDATA_PROFILE:?Set the installed profile name}"
          test -d "$FLASHDATA_STATE_DIR"
          "$FLASHDATA_BIN" auth status --profile "$FLASHDATA_PROFILE" \
            --state-dir "$FLASHDATA_STATE_DIR" --json --non-interactive |
            jq -e '.ok and .data.accessVerified
              and (.data.identity.identity.recurringAllowed == true)
              and (.data.identity.permittedSources | index("google_search") != null)'

ตรวจสอบสิทธิ์

หลังบันทึก workflow ในสาขาเริ่มต้นของ repository แล้ว เปิด Actions → FlashData access check → Run workflow ผลควรเป็น true และการตรวจสอบสำเร็จ หากไม่มีข้อมูลรับรองหรือสิทธิ์ งานจะล้มเหลวโดยไม่ส่งคำขอค้นหา

ให้รัฐประมวลผลระหว่างงาน

นักวิ่งแบบ ephermeral เริ่มต้นโดยไม่มีบันทึกต้นฉบับ ใช้โปรแกรมที่ทนทานหรือรันเนอร์ถาวร สําหรับการทํางานซ้ํา ๆ การติดตั้งเฉพาะกุญแจเท่านั้น ที่ไม่สามารถระบุการส่งงานก่อนหน้านี้ได้ เก็บไดเร็คทอรีของรัฐและงานที่ส่งออกเป็นส่วนตัว; อย่าอัปโหลดมัน เยี่ยงสิ่งประดิษฐ์ของ CI

หมุนหรือเพิกถอนสิทธิ์ในการใช้งาน

หยุดสัญญาณ ในโฟลเดอร์งาน, จุด FLASHDATA_KEY_FILE ในกุญแจที่แทนที่ด้วยบัญชีเดียวกัน และต้องใช้แหล่ง แล้วเรียกคําสั่งด้านล่างนี้มา ทําซ้ําการตรวจสอบการเข้าและ deployment-check.sh. คาดหวัง cached: true. เรียกคืนกุญแจเก่าหลังการตรวจสอบและเก็บโพรไฟล์และไดเรกทอรีรัฐ

แทนที่คีย์ผ่านทาง stdin
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Point to the mounted replacement key for the same account}"
run_flashdata auth login --replace --api-key-stdin --non-interactive \
  < "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactive

หยุดการเข้าถึงอย่างสมบูรณ์

หยุดตัวจัดตาราง ยกเลิกการเชื่อมต่อกุญแจหรือตัวแทนในคอนโซล แล้วทําการตรวจสอบสิทธิ์อีกครั้ง มันจะต้องล้มเหลว การออกจากระบบแบบท้องถิ่นอย่างเดียว ไม่ได้ยกเลิกการใช้ค่าความเชื่อถือของแม่ข่ายได้; ได้ส่งออกแฟ้มที่ยังคงอยู่บนดิสก์แล้ว

เช็คการรับสมัครที่ล้มเหลว

Sumpotomแก้ไข
ไม่พบคําสั่ง / ผิด CLI รุ่นตรวจสอบคําสั่ง - v แฟลชดาต้าและ FLASHDATA_BIN ใน runtime.sh. สําหรับ Dockerสร้างใหม่และดําเนินภาพ --version เช็ค
ถูกปฏิเสธการเมานท์หรือไม่ได้รับอนุญาตสร้างโฟลเดอร์สถานะและงานบนระบบ Docker เจ้าภาพ เจ้าของบริการ UID/GID. รักษาเส้นทางของพวกเขาให้มั่นคง
replacement_requires_flagโปรไฟล์มีกุญแจอีกแบบนึง ตรวจสอบสิทธิ์ที่ใช้ก่อนใช้กระบวนการหมุนเพื่อทําการแทนที่ที่ต้องการ
ไม่สามารถถอดรหัสการเข้าใช้ที่บันทึกไว้ประมวลผลในฐานะผู้ใช้ที่จัดหามัน ในสภาพแวดล้อมเดียวกัน การจัดทําการเข้าถึงจุดหมายปลายทางใหม่แทนการคัดลอกโพรไฟล์แล็ปท็อปที่ถูกเข้ารหัสไว้
การตรวจสอบเงินตรา falseขอบเขตสี balance.json ถึง preflight.json. ต้องการราคาที่ใช้ได้ ใบอนุญาตจากแหล่ง และความสมดุลพอ ก่อนการยินยอม
run_account_mismatchCheckบัญชีที่เลือกไว้ API ต้นกําเนิด เรียกคืนสิทธิ์ที่เรียกใช้ครั้งแรก ไม่ต้องเปลี่ยนชื่อการประมวลผลเพื่อทําการกู้คืนแบบบายพาส
run_id_input_conflictเรียกคืนคําร้องขอเดิมจากความพยายาม request.json. ใช้การประมวลผลใหม่ ID สําหรับงานที่ตั้งใจไว้
CI คงคิวไว้ตรวจสอบว่านักวิ่งออนไลน์ และมีชื่อเรียกทุกชื่อ การทํางานแบบนี้ต้องใช้การควบคุมตัวเองอย่างถาวร Linux นักวิ่ง