Semak dokumentasi
Panduan
Anda menjalankan aplikasi atau tugas CLI pada Linux atau Docker, kemudian verifikasi akses dan hasil penggunaan ulang setelah restart.
Pada halaman ini
1. Memilih waktu berjalan
Use a Linux Nama host Bash Dan jqDan pemilik API Kunci dengan google_search Izin. Jalankan setup sebagai pengguna OS yang akan melaksanakan tugas. NEGERI membuat folder tugas swasta ini untuk langkah-langkah 1–4; label berkas menunjukkan subfolder apapun.
umask 077
mkdir -p "$HOME/flashdata-tasks/deployment-check"
cd "$HOME/flashdata-tasks/deployment-check"Instal CLI asli pertama. Jalankan perintah -v flashdata untuk menemukan jalur absolutnya, kemudian set FLASHDATA_BIN ke jalur tersebut dalam runtime.sh. Dia menetapkan nama profil dan jalur negara yang gigih sekali di sini, kemudian menyimpan file.
# 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"
}Linux Docker dengan curl, tar dan sha256sum, download CLI yang disematkan untuk CPU host. Simpan image/Dockerfile dan image/.dockerignore di bawah, bangun gambar, kemudian simpan runtime.sh. Bantuan itu dijalankan sebagai UID/GID Anda dan mount keadaan dan folder tugas ke dalam setiap wadah baru.
(
set -euo pipefail
case "$(uname -m)" in
x86_64) arch=amd64 ;;
aarch64|arm64) arch=arm64 ;;
*) echo 'Use a Linux amd64 or arm64 host.' >&2; exit 1 ;;
esac
mkdir -p image
cd image
archive="flashdata_1.2.1_linux_$arch.tar.gz"
base='https://github.com/flashdatadev/flashdata-cli/releases/download/v1.2.1'
curl --fail --show-error --location "$base/$archive" -o "$archive"
curl --fail --show-error --location "$base/SHA256SUMS" -o SHA256SUMS
awk -v file="$archive" '$2 == file { print }' SHA256SUMS | sha256sum -c -
tar -xzf "$archive" flashdata
)FROM debian:bookworm-slim
RUN apt-get update \
&& apt-get install -y --no-install-recommends ca-certificates \
&& rm -rf /var/lib/apt/lists/*
COPY --chmod=0755 flashdata /usr/local/bin/flashdata
USER 10001:10001
ENTRYPOINT ["/usr/local/bin/flashdata"]*
!Dockerfile
!flashdatadocker build --tag flashdata-runtime:1.2.1 ./image
docker run --rm flashdata-runtime:1.2.1 --version# runtime.sh — use the local image built above.
export FLASHDATA_IMAGE='flashdata-runtime:1.2.1'
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"
run_flashdata() {
docker run --rm -i --user "$(id -u):$(id -g)" \
--env FLASHDATA_API_KEY= \
--mount "type=bind,src=$FLASHDATA_STATE_DIR,dst=/state" \
--mount "type=bind,src=$PWD,dst=/work" --workdir /work \
--entrypoint /usr/local/bin/flashdata "$FLASHDATA_IMAGE" \
"$@" --profile "$FLASHDATA_PROFILE" --state-dir /state
}Periksa waktu larian yang dipilih
run_flashdata adalah pembantu yang disimpan dalam runtime.sh; semua perintah kemudian menggunakan profil dan direktori negara. Ia mengabaikan FLASHDATA_API_KEY sehingga kunci lingkungan tidak dapat menggantikan profil tersimpan. Expect versi CLI dan jq.
set -euo pipefail
umask 077
. ./runtime.sh
mkdir -p "$FLASHDATA_STATE_DIR"
chmod 700 "$FLASHDATA_STATE_DIR"
run_flashdata --version
jq --version2. Instal pemilik akses sekali
Jika profil sudah memiliki akses pemilik, lewati impor dan jalankan pemeriksaan di bawah. Jika tidak, mount file rahasia kunci-pemilik dapat dibaca oleh pengguna layanan dan mengganti jalur contoh dengan lokasinya. \"Unggaan\" bacakan \"Impor\" stdin; Docker tidak menyalinnya ke dalam gambar.
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-interactiveKonfirmasi akun dan izin
Pemeriksaan itu mencetak akun ID, sumber yang diizinkan dan perlindungan kredensial, kemudian true. Kepastian dari akun ID adalah pemilik yang dimaksudkan sebelum melanjutkan. access.json tetap berada di folder tugas untuk pemeriksaan.
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.jsonBerkas penyimpanan dan persisten kredensial yang berwibawa
Semak data.credentialProtection dalam auth status. Linux boleh menggunakan Secret Service yang dibuka kunci; hos tanpa antara muka grafik atau kontena di atas mungkin menggunakan fail teks biasa yang hanya boleh diakses pemilik. Pastikan direktori keadaan kekal dan peribadi. Sediakan pengguna untuk persekitaran penerapan secara berasingan daripada profil tersulit pada komputer riba anda.
| Jaga | Lokasi |
|---|---|
| Kredensial dan jalankan jurnal | FLASHDATA_STATE_DIR |
| Masukan, penerimaan, dan hasil | Dielev sebagai /work dalam Docker. |
3. Memvalidasi permintaan dan biaya
Simpan request.json di samping runtime.sh. Pemeriksaan berikut memvalidasi akses yang berulang dan permintaan, membaca pricing terkini dan membandingkannya dengan keseimbangan yang tersedia. Ini tidak mengirimkan pencarian dan tidak cadangan kredit. Hanya lanjutkan ketika filter mencetak true.
{
"source": "google_search",
"query": "battery recycling research",
"params": {
"num": 5
}
}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.json4. Jalankan sekali dan tentukan penggunaan ulang
Simpan deployment-check.sh dibawah. Dengan pengerahan baru-pertama-task menjalankan ID, eksekusi pertama menyerahkan satu pencarian terbayar; yang kedua memulai proses baru dan membaca hasil yang disimpan. Jika ID ini sudah selesai di profil yang sama, kedua upaya tersebut akan menggunakannya kembali.
Simpan deployment-check.sh
Cipta deployment-check.sh Di samping runtime.sh Dan request.json Di folder tugas pribadi di tuan rumah. Salin naskah lengkap di bawah ke dalamnya dan menyimpannya.
#!/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"Menjalankan cek disimpan dua kali
Dari folder tugas tuan rumah itu, Anda bisa menggunakan nama yang sama. Kedua proses tersebut memuat runtime.sh yang disimpan dalam langkah 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.shMemverifikasi penerimaan kedua
Untuk menjalankan baru, mengharapkan cached: false, kemudian cached: true. Setiap percobaan mencetak folder deployment-check.XXXXXX dan menyimpan request.json, receipt.json dan error.json, ditambah result.json pada keberhasilan. Resepan yang dicache melaporkan penggunaan aslinya. Percobaan gagal membuat filenya untuk pemulihan.
{
"ok": true,
"runId": "deployment-first-task",
"cached": true
}Baca hasil pencarian yang disimpan
ATTEMPT_DIR ke folder kedua yang sukses dicetak di atas, sebagai contoh ekspor ATTEMPT_DIR='./deployment-check.ABC123'. Perintah ini hanya membaca berkas lokal.
# 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"Peralihan dari pemeriksaan penyebaran ke tugas yang berulang
Semakan ini mempunyai ID pelaksanaan tetap. Untuk kerja berulang, berikan ID tersendiri kepada setiap kejadian yang dikehendaki dan kekalkan runtime, akaun, salinan input dan mount keadaan yang dipilih. Sesuaikan arahan pertanyaan pelaksana berulang untuk menggunakan run_flashdata supaya tugas Docker kekal di dalam kontena.
Periksa akses dari GitHub Actions
Dia menggunakan pelari Linux yang terpercaya dan gigih dengan Bash, jq dan profil CLI yang sudah dipasang di bawah pengguna OS. Simpan aliran kerja ini di dalam repositori aplikasi anda. Ini memeriksa CLI tanpa menjalankan tugas yang dibayar.
- Umpukkan label flashdata-research pada pelari itu.
- Tambahkan ke Projek FLASHDATA_BIN Dan FLASHDATA_STATE_DIR Ke jalan mutlak, dan FLASHDATA_PROFILE Ke nama profil terpasang.
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)'Menjalankan cek akses
Lunch Setelah menyimpan alur kerja pada cabang baku repositori, Open Actions → FlashData access check → Run workflow. Expect true dan cek sukses. Akses atau izin yang hilang gagal pekerjaan tanpa menyerahkan pencarian.
Menjaga keadaan eksekusi terus di seluruh pekerjaan
Pelaksana sementara bermula tanpa jurnal asal. Gunakan keadaan aplikasi kekal atau pelaksana berterusan untuk kerja berulang berbayar. Memasang semula kunci sahaja tidak dapat mengenal pasti penyerahan tugas terdahulu. Simpan direktori keadaan dan output tugas secara peribadi; jangan muat naik sebagai artifak CI.
Putar atau batalkan akses yang dikerahkan
Dihentikan. Di folder tugas, titik FLASHDATA_KEY_FILE pada kunci pengganti untuk akun yang sama dan sumber yang diperlukan, kemudian menjalankan perintah di bawah. Mengulangi cek akses dan deployment-check.sh; mengharapkan cached: true. Membatalkan kunci lama setelah verifikasi dan menjaga direktori profil dan negara bagian.
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-interactiveHentikan akses sepenuhnya
Membatalkan penjadwal, mencabut koneksi kunci atau agen di konsol, kemudian mengulang cek akses bebas. Pasti gagal. Logkeluar lokal logkeluar lokal sendiri tidak mencabut kredensial server; berkas yang sudah diekspor tetap berada di dalam disk.
Pemeriksaan ledakan yang gagal
| Symptom | Fix |
|---|---|
| Perintah ufair tidak ditemukan / salah versi CLI | Periksa perintah -v flashdata dan FLASHDATA_BIN di runtime.sh. Untuk Docker, bangun dan jalankan pemeriksaan --version gambar. |
| Hilang mount atau izin ditolak | Achieved membuat folder negara dan tugas pada host Docker, yang dimiliki oleh layanan UID/GID. Jaga agar jalur mereka tetap stabil. |
| replacement_requires_flag | Profil memiliki kunci tersimpan yang berbeda. OWOVE verifikasi akses yang sudah ada terlebih dahulu; gunakan prosedur rotasi untuk penggantian yang dimaksudkan. |
| Tidak dapat menyahsulit akses tersimpan | Lari sebagai pengguna yang menyediakannya, di lingkungan toko kredensial yang sama. Akses Provision osis pada tujuan baru daripada menyalin profil laptop terenkripsi. |
| Nixna Cost check mengembalikan false | Periksa balance.json dan preflight.json. Membutuhkan harga yang tersedia, izin sumber dan keseimbangan yang cukup sebelum menyerah. |
| run_account_mismatch | Periksa asal usul akun yang dipilih dan API. IOPD memulihkan akses asli; jangan mengubah nama lari untuk bypass pemulihan. |
| run_id_input_conflict | Umpama permintaan asli dari request.json. Guna ID baru hanya untuk tugas baru yang ditujukan. |
| CoI tetap tinggal antrian | Periksa bahwa pelari online dan memiliki setiap run-on label. Aliran kerja ini membutuhkan pelari Linux yang gigih. |